Quartz的基本使用

定时任务

在很多情况下任务并非需要立即执行,而是需要往后或定期执行,这不可能人工去操作,所以定时任务就出现了

使用定时任务的情况:
每周末凌晨备份数据
触发条件 5 分钟后发送邮件通知
30 分钟未支付取消订单
每 1 小时去拉取数据

Scheduled创建定时任务
在SpringBoot的启动类类中加⼊ @EnableScheduling 注解,启⽤定时任务的配置

创建定时任务实现类:

package com.xujie.quartz_01;

import lombok.extern.slf4j.Slf4j;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

/**
 * @author 许缘
 * @company xxx公司
 * @create 2022-11-08  22:59
 */
@Component
@Slf4j
public class Task {
    //fixedRate
    @Scheduled(fixedRate = 1000)
    public void test(){
        log.warn("现在时间：" + LocalDateTime.now());
    }
}

Scheduled参数
@Scheduled(fixedRate=5000):上⼀次开始执⾏时间点之后5秒再执⾏
@Scheduled(fixedDelay=5000):上⼀次执⾏完毕时间点之后5秒再执⾏
@Scheduled(initialDelay=1000, fixedRate=5000):第⼀次延迟1秒后执⾏,之后按fixedRate的规则
每5秒执⾏⼀次
@Scheduled(cron=“*/5 * * * * *”):通过cron表达式定义规则

cron表达式
cron表达式是一个字符串,以5或者6个空格隔开(示例中是被5个空格隔开),字符串被切割为6个或者7个域,
每个域都代表不同的含义

Cron生成器:http://cron.ciding.cc/

Quartz创建定时任务:

pom依赖:

<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

任务存储方式:
内存方式(RAMJobStore)：将任务临时存储到内存中，仅支持单项目部署，项目重启后任务会失效，不支持由调度器控制任务漂移，不建议使用。

数据库方式(JDBCJobStore)： Quartz提供了多种数据库的所需表结构脚本，它内部通过 DataSource来操作数据，支持分布式方式部署、支持任务漂移，项目重启后任务不会丢失，直到任务执行完成后才会被从数据库内清除。

SchedulerFactory 调度器工厂:

SchedulerFactory factory = new StdSchedulerFactory();

Scheduler 调度器:

Scheduler scheduler = factory.getScheduler();

用于与调度程序交互的主程序接口.
Scheduler维护了一个JobDetails和Triggers 的注册表。
一旦在Scheduler注册过了，当定时任务触发时间一到，调度程序就会负责执行预先定义的Job调度程序创建之后，处于“待机”状态，必须调用 scheduler 的 start() 方法启用调度程序
可以使用 shutdown() 方法关闭调度程序，使用 isShutdown() 方法判断该调度程序是否已经处于关闭状态
通过 Scheduler.scheduleJob(…) 方法将任务纳入调度程序中，当任务触发时间到了的时候，该任务将被执行

Job 定时任务:
任务是一个实现 org.quartz.Job 接口的类，任务类必须含有空构造器
当关联这个任务实例的触发器表明的执行时间到了的时候，调度程序 Scheduler 会调用这个方法来执行
任务，任务内容就可以在这个方法中执行

@Slf4j
public class MyJob implements Job {
@Override
public void execute(JobExecutionContext jobExecutionContext) throws
JobExecutionException {
Object name =
jobExecutionContext.getJobDetail().getJobDataMap().get("name");
log.error(name + "正在努力的搞卫生………………");
}
}

JobDataMap 提供了一种“初始化成员属性数据的机制”,在实现该 Job 接口的时候可以取到需要的数据

实例化的过程:
创建一个 Job 类，在调度程序中可以创建很多个 JobDetai，分别设置不同的 JobDataMap
创建一个类 SalesReportJob 实现 Job 接口，用做销售报表使用。
可以通过 JobDataMap 指定销售员的名称和销售报表的依据等等。
这就会创建多个 JobDetails，例如 SalesReportForJoe，SalesReportForMike 分别对应在
JobDataMap 中指定的名字 joe 和 mike。

JobBuilder 用于创建 JobDetail，如果没有调用 withIdentity 指定 job 的名字，会自动生成一个。

JobDetail jobDetail = newJob(MyJob.class)
.withDescription("开年大扫除")
.withIdentity("大扫除", "厕所")
.usingJobData("name", "王阿姨")
.build();

Trigger 触发器:
触发器使用 TriggerBuilder 来实例化，有一个 TriggerKey 关联，在一个 Scheduler 中必须是唯一的。
多个触发器可以指向同一个工作，但一个触发器只能指向一个工作。
触发器可以传送数据给 job，通过将数据放进触发器的 JobDataMap。

触发器常用属性:
触发器也有很多属性，这些属性都是在使用 TriggerBuilder 定义触发器时设置的。
TriggerKey，唯一标识，在一个 Scheduler 中必须是唯一的
startTime，开始时间，通常使用 startAt(java.util.Date)
endTime，结束时间，设置了结束时间则在这之后，不再触发

Trigger trigger = TriggerBuilder.newTrigger()
.withDescription("大扫除触发器")
.withIdentity("大扫除", "厕所")
.startAt(new Date())
.build();

如果没有使用 withIdentity(…) 会自动生成一个触发器名称。

触发器的优先级:
有时候，会安排很多任务，但是 Quartz 并没有更多的资源去处理它。
这种情况下，必须需要很好地控制哪个任务先执行。这时候可以设置 priority 属性（使用方法withPriority(int)）来控制触发器的优先级。
优先级只有触发器出发时间一样的时候才有意义。
当一个任务请求恢复执行时，它的优先级和原始优先级是一样的。

常见触发器:
TriggerBuilder 用于创建 Trigger，如果没有调用 withSchedule(…) 方法，会使用默认的 schedule 。
简单触发器 SimpleTrigger
SimpleTrigger 包含几个特点：开始时间、结束时间、重复次数以及重复执行的时间间隔。

Trigger trigger = TriggerBuilder.newTrigger()
.withDescription("")
.withIdentity("clean", "clean1")
.startAt(new Date())
.withSchedule(
simpleSchedule()
.withIntervalInSeconds(10)
.withRepeatCount(10) //SimpleTrigger.REPEAT_INDEFINITELY
)
.build();

基于 Cron 表达式的触发器 CronTrigger:

Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity("test", "test")
.withDescription("测试的触发器")
.withSchedule(CronScheduleBuilder.cronSchedule("2 * * * * *"))
.build();

绑定与启动:

scheduler.scheduleJob(jobDetail, trigger);
scheduler.start();

测试实例:

package com.xujie.quartz_01;

import org.junit.jupiter.api.Test;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.Date;

import static org.quartz.JobBuilder.newJob;
import static org.quartz.SimpleScheduleBuilder.simpleSchedule;

@SpringBootTest
class Quartz01ApplicationTests {

    @Test
    void contextLoads() throws SchedulerException {
        //1.实例化调度器工厂
        SchedulerFactory factory = new StdSchedulerFactory();
        //2.得到调度器
        Scheduler scheduler = factory.getScheduler();
        //3.创建任务
        // Job(模板) 和 JobDetail(实例)

        JobDetail jobDetail = newJob(MyJob.class)
                .withDescription("开年大扫除") //描述
                .withIdentity("大扫除", "厕所")//任务id
                .usingJobData("name","张三")
                .build();//构建
        //JobDataMap jobDataMap = jobDetail.getJobDataMap();

        JobDetail jobDetail1 = newJob(MyJob.class)
                .withDescription("开年大扫除") //描述
                .withIdentity("大扫除", "厕所")//任务id
                .usingJobData("name","张三")
                .build();//构建
        //4.创建触发器
        Trigger trigger = TriggerBuilder.newTrigger()
                .withDescription("大扫除触发器")
                .withIdentity("大扫除", "厕所")
                .startAt(new Date())
                //简单触发器规则
//                .withSchedule(
//                        simpleSchedule()
//                                .withIntervalInSeconds(1)
//                                .withRepeatCount(10) //SimpleTrigger.REPEAT_INDEFINITELY
//                )
                .withSchedule(CronScheduleBuilder.cronSchedule("2 * * * * ?"))
                .build();
        //5.将触发器和任务绑定到调度器
        scheduler.scheduleJob(jobDetail,trigger);
        //6.启动调度器
        scheduler.start();
    while (true){

    }
    }

}