任务调度管理Quartz

Quartz是一个当今市面上流行的高效的任务调度管理工具, 所谓"调度"就是制定好的什么时间做什么事情的计划, 由OpenSymphony开源组织开发, 是java语言编写的,我们使用时需要导入依赖即可

为什么需要Quartz

所谓"调度"就是制定好的什么时间做什么事情的计划, 我们使用过的最简单的调度方法就是Timer, 但是Timer的调度功能过于单一, 只能是指定时间的延时调用和周期运行, 而Quartz可以更详细的指定时间, 进行计划调用

Quartz核心组件

调度器:Scheduler

任务:job

触发器:Trigger

• job(工作\任务):Quartz 实现过程中是一个接口,接口中有一个方法execute(执行的意思), 我们创建一个类,实现这个接口,在方法中编写要进行的操作(执行具体任务), 我们还需要一个JobDetail的类型的对象,Quartz每次执行job时, 会实例化job类型对象,去调用这个方法,JobDetail是用来描述Job实现类的静态信息,, 比如任务运行时在Quartz中的名称

• Trigger(触发器):能够描述触发指定job的规则,分为简单触发和复杂触发

  简单触发可以使用SimplTrigger实现类.功能类似timer

  复杂触发可以使用CronTrigger实现类,内部利用cron表达式描述各种复杂的时间调度计划

• Scheduler(调度器):一个可以规定哪个触发器绑定哪个job的容器

  在调度器中保存全部的Quartz 保存的任务

  SpringBoot框架下,添加Quartz依赖后,调度器由SpringBoot管理,我们不需要编写

Cron表达式 

表示2022年10月12日凌晨4点运行触发的cron表达式  

0 0 4 12 10 ? 2022

• * 表示任何值,如果在分的字段上编写*,表示每分钟都会触发

• , 是个分割符如果秒字段我想20秒和40秒时触发两次就写 20,40

• - 表示一个区间 秒字段5-10 表示 5,6,7,8,9,10

• / 表示递增触发 秒字段 5/10表示5秒开始每隔10秒触发一次

  日字段编写1/3表示从每月1日起每隔3天触发一次

• ? 表示不确定值, 因为我们在定日期时,一般确定日期就不确定是周几,相反确定周几时就不确定日期

• L 表示last最后的意思,我们可以设置当月的最后一天,就会在日字段用L表示,

  周字段使用L表示最后一周,一般会和1-7的数字组合

  例如6L表示本月最后一周的周五

• W (work)表示最近的工作日(单纯的周一到周五) 如果日字段编写15W表示

  每月15日最近的工作日触发,如果15日是周六就14日触发,如果15日是周日就16日触发

LW通常一起使用,表示本月的最后一个工作日

• # 表示第几个,只能使用在周字段上 6#3表示每月的第三个周五

  如果#后面数字写大了,是一个不存在的日期,那就不运行了

  适合设计在母亲节或父亲节这样的日期运行

Cron表达式生成器: Cron - 在线Cron表达式生成器

示例:

每年的母亲节早上9点触发

0 0 9 ? 5 1#3

每个月离15日最近的工作日18点发工资

0 0 18 15W * ?

每年11月11日0时触发

0 0 0 11 11 ?

SpringBoot整合Quartz

<!--  springBoot整合Quartz依赖  -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-quartz</artifactId>
</dependency>

先编写要执行的任务, 当前SpringBoot项目模块中创建quartz包, 包中创建一个QuartzJob的类,实现Job接口

public class QuartzJob implements Job {
    @Override
    public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
        // 实现一个简单的任务用作演示
        // 例如输出当前系统时间
        System.out.println("---------"+ LocalDateTime.now() +"-----------");
    }
}

上面编写的是Job接口的实现类,要想运行还需要将它封装为JobDetail对象保存在Spring容器中  

还有要创建一个Trigger设置要运行的时机,也保存到Spring容器中  

此外, 还要在quartz包下,再创建一个QuartzConfig类,其中编写它们的调度绑定关系  

// Quartz的绑定触发和调用关系的配置
// 实际上我们要配置的是Quartz中的调度器Scheduler
// 因为调度器已经在Spring中了,所以变为了配置Spring
@Configuration
public class QuartzConfig {
    // 配置的核心是两个对象,一个JobDetail对象指定工作内容,一个Trigger指定触发时间

    // 首先装配JobDetail: 将我们编写的Job实现类封装为JobDetail
    // 我们使用@Bean注解,将对象保存到Spring容器
    @Bean
    public JobDetail showTime(){
        System.out.println("!!!!!!!!!!!!!!!!!!!JobDetail保存到Spring容器");
        // newJob方法就是在绑定要运行的Job接口实现类,该方法参数要传入实现类的反射
        return JobBuilder.newJob(QuartzJob.class)
                // 为当前的JobDetail对象起名,用于Quartz的调度环境中
                .withIdentity("dateTime")
                // 默认情况下,JobDetail对象如果没有触发器绑定会立即被移除
                // 设置了storeDurably()之后,当前JobDetail对象没有触发器绑定也不会移除了
                .storeDurably()
                .build();
    }

    // 下面是触发器的声明,也会保存到Spring容器中管理
    // 它是设置Job运行时机的对象
    @Bean
    public Trigger showTimeTrigger(){
        System.out.println("!!!!!!!!!!!!!!!!!Trigger保存到Spring容器");
        // 要想设置触发时间,我们使用Cron表达式
        CronScheduleBuilder cron=
                CronScheduleBuilder.cronSchedule("0 * * * * ?");
        return TriggerBuilder.newTrigger()
                // 绑定要运行的JobDetail对象
                .forJob(showTime())
                // 给触发器起名
                .withIdentity("dateTrigger")
                // 绑定cron表达式
                .withSchedule(cron)
                .build();
    }

}