SpringBoot日程管理Quartz与定时任务Task实现详解

2024-04-02 19:04:59 682人浏览八月长安

Python 官方文档：入门教程 => 点击学习

摘要

目录1 Quartz核⼼概念SpringBoot整合Quartz1.导⼊springboot整合Quartz的starter2.定义任务Bean3.创建Quartz配置类2. Tas

1 Quartz

Quartz是OpenSymphony开源组织在Job scheduling领域的⼀个开源项⽬，完全由Java开发的⼀个开源的任务⽇程管理系统，在预先确定（被纳⼊⽇程）的时间到达时，负责执⾏（或者通知）其他软件组件的系统。

核⼼概念

Job（任务）：为⼀个接⼝，只定义⼀个⽅法 execute(JobExecutionContext context)，在实现接⼝的execute⽅法中编写所需要定时执⾏的 Job（任务），JobExecutionContext类提供了调度应⽤的⼀些信息。Job运⾏时的信息保存在JobDataMap实例中。

JobDetail（任务信息）：Quartz每次调度Job时，都重新创建⼀个Job实例，它不直接接受⼀个Job的实例，相反它接收⼀个Job实现类（JobDetail，描述Job的实现类及其他相关的静态信息，如Job名字、描述、关联监听器等信息）。

Trigger（触发器）：为⼀个类，描述触发Job执⾏的时间触发规则。主要有SimpleTrigger和CronTrigger两个⼦类。当且仅当需调度⼀次或者以固定时间间隔周期执⾏调度，SimpleTrigger是最适合的选择；⽽CronTrigger则可以通过Cron表达式定义出各种复杂时间规则的调度⽅案。

Scheduler（调度器）：调度器就相当于⼀个容器，装载着任务和触发器。该类是⼀个接⼝，代表⼀个Quartz的独⽴运⾏容器，Trigger和JobDetail可以注册到Scheduler中。

Springboot整合Quartz

1.导⼊springboot整合Quartz的starter

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

2.定义任务Bean

按照Quartz的开发规范制作，继承QuartzJobBean

public class MyQuartz extends QuartzJobBean {
    @Override
    protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        System.out.println("quartz task is Going......");
    }
}

3.创建Quartz配置类

定义⼯作明细（JobDetail）与触发器的（Trigger）bean

@Configuration
public class QuartzConfig {
    @Bean
    public JobDetail testDetail(){
        return JobBuilder.newJob(MyQuartz.class).storeDurably().build();
    }
    @Bean
    public Trigger testJobTrigger(){
        //创建调度器
        ScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("0/5 * * * * ? ");
        //绑定对应的⼯作明细
        return TriggerBuilder.newTrigger().forJob(testDetail()).withSchedule(scheduleBuilder).build();
    }
}

cron表达式,定时执⾏

第⼀位，表示秒，取值 0-59；
第⼆位，表示分，取值 0-59；
第三位，表示⼩时，取值 0-23；
第四位，⽇期天/⽇，取值 1-31；
第五位，⽇期⽉份，取值 1-12；
第六位，星期，取值 1-7，星期⼀、星期⼆…；

注：不是第1周、第2周的意思，另外：1表示星期天，2表示星期⼀。

第七位，年份，可以留空，取值 1970-2099。

特殊符号

（*）星号：可以理解为每的意思，每秒、每分、每天、每⽉、每年
（?）问号：问号只能出现在⽇期和星期这两个位置，表示这个位置的值不确定，每天 3点执⾏，所以第六位星期的位置是不需要关注的，就是不确定的值。同时，⽇期和星期是两个相互排斥的元素，通过问号来表明不指定值。假如 1 ⽉ 10 ⽇是星期⼀，如果在星期的位置是另指定星期⼆，就前后冲突⽭盾了
（-）减号：表达⼀个范围，如在⼩时字段中使⽤“10-12”，则表示从 10~12 点，即10、11、12
（,）逗号：表达⼀个列表值，如在星期字段中使⽤“1、2、4”，则表示星期⼀、星期⼆、星期四
（/）斜杠：如 x/y，x 是开始值，y 是步⻓，假设在第⼀位（秒） 0/15 就是，从 0秒开始，每 15 秒，最后就是 0、15、30、45、60，另 */y，等同于 0/y

总结

1. springboot整合Quartz就是将Quartz对应的核⼼对象交给spring容器管理，包含两个对象，JobDetail和Trigger对象

2. JobDetail对象描述的是⼯作的执⾏信息，需要绑定⼀个QuartzJobBean类型的对象

3. Trigger对象定义了⼀个触发器，需要为其指定绑定的JobDetail是哪个，同时要设置执⾏周期调度器

2. Task

spring根据定时任务的特征，将定时任务的开发简化到了极致。

1.开启定时任务功能

在引导类上开启定时任务功能的开关，使⽤注解@EnableScheduling

@SpringBootApplication
@EnableScheduling//打开定时任务开关
public class Demo12SpringbootTaskApplication {
    public static void main(String[] args) {
        SpringApplication.run(Demo12SpringbootTaskApplication.class, args);
    }
}

2.定义Bean

在对应要定时执⾏的操作上⽅，使⽤注解@Scheduled定义执⾏的时间，执⾏时间的描述⽅式还是cron表达式

@Component
public class MyBean {
    @Scheduled(cron = "0/1 * * * * ?")
    public void print() {
        System.out.println(Thread.currentThread().getName() + ":spring task run...");
    }
}

3.配置文件

如何想对定时任务进⾏相关配置，可以通过配置⽂件进⾏

spring:
task:
scheduling:
## 调度线程名称前缀默认scheduling-
thread-name-prefix: myTask_
pool:
# 任务调度线程池⼤⼩默认 1
size: 1
shutdown:
# 线程池关闭时等待所有任务完成
await-termination: false
# 调度线程关闭前最⼤等待时间，确保最后⼀定关闭
await-termination-period: 10s