SpringBoot集成Quartz（定时任务）

我不是女神ヾ 2023-10-01 16:23 11阅读 0赞

quartz是OpenSymphony开源组织在Job scheduling领域的开源项目，是由java开发的一个开源的任务日程管理系统。

quartz能做什么？

*  作业调度：调用各种框架的作业脚本，例如shell,hive等。
 *  定时任务：在某一预定的时刻，执行你想要执行的任务。

架构图如下：

![在这里插入图片描述][watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCn5LiK5pyJ5Yac_size_20_color_FFFFFF_t_70_g_se_x_16]  
quartz包含的主要接口如下：

*  Scheduler 代表调度容器，一个调度容器中可以注册多个JobDetail和Trigger。
 *  Job 代表工作，即要执行的具体内容。
 *  JobDetail 代表具体的可执行的调度程序，Job是这个可执行程调度程序所要执行的内容。
 *  JobBuilder 用于定义或构建JobDetail实例。
 *  Trigger 代表调度触发器，决定什么时候去调。
 *  TriggerBuilder 用于定义或构建触发器。
 *  JobStore 用于存储作业和任务调度期间的状态。

以springboot集成quartz为例

pom

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

创建真正的定时任务执行类，该类继承QuartzJobBean。

public class QuartzTestJob extends QuartzJobBean {
        
        @Override
        protected void executeInternal(JobExecutionContext context) throws JobExecutionException {
        
            String userName = (String) context.getJobDetail().getJobDataMap().get("userName");
            System.out.println("userName:" + userName);
        }
    }

创建调度程序JobDetail和调度器Trigger。

@Configuration
    public class QuartzConfig {
        
        @Value("${sue.spring.quartz.cron}")
        private String testCron;
    
        /**
         * 创建定时任务
         */
        @Bean
        public JobDetail quartzTestDetail() {
        
            JobDetail jobDetail = JobBuilder.newJob(QuartzTestJob.class)
                    .withIdentity("quartzTestDetail", "QUARTZ_TEST")
                    .usingJobData("userName", "susan")
                    .storeDurably()
                    .build();
            return jobDetail;
        }
    
        /**
         * 创建触发器
         */
        @Bean
        public Trigger quartzTestJobTrigger() {
        
            //每隔5秒执行一次
            CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule(testCron);
    
            //创建触发器
            Trigger trigger = TriggerBuilder.newTrigger()
                    .forJob(quartzTestDetail())
                    .withIdentity("quartzTestJobTrigger", "QUARTZ_TEST_JOB_TRIGGER")
                    .withSchedule(cronScheduleBuilder)
                    .build();
            return trigger;
        }
    }

在yml文件中配置参数：

server:
      port: 8081
    
    sue:
      spring:
        quartz:
          cron: "*/5 * * * * ?"

这样就能每隔5秒执行一次QuartzTestJob类的executeInternal方法了。

CronTrigger配置格式:

[秒] [分] [小时] [日] [月] [周] [年]

spring quartz跟spring task的cron表达式规则基本一致，只是spring4以上的版本去掉了后面的年，而quartz的CronTrigger的年是非必填的。

使用spring quartz的优缺点：

*  优点：默认是多线程异步执行，单个任务时，在上一个调度未完成时，下一个调度时间到时，会另起一个线程开始新的调度，多个任务之间互不影响。支持复杂的cron表达式，它能被集群实例化，支持分布式部署。
 *  缺点：相对于spring task实现定时任务成本更高，需要手动配置QuartzJobBean、JobDetail和Trigger等。需要引入了第三方的quartz包，有一定的学习成本。不支持并行调度，不支持失败处理策略和动态分片的策略等。

多任务的问题，多个JobDetail使用同一个Trigger报错：Trigger does not reference given job：一个Job可以对应多个Trigger，但多个Job绑定一个Trigger报错

[watermark_type_d3F5LXplbmhlaQ_shadow_50_text_Q1NETiBA5bCn5LiK5pyJ5Yac_size_20_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/c08aadb3b7ec4975a187a48ea09c35c8.png?x-oss-process=image/watermark,type_d3F5LXplbmhlaQ,shadow_50,text_Q1NETiBA5bCn5LiK5pyJ5Yac,size_20,color_FFFFFF,t_70,g_se,x_16