SpringBoot整合Quartz实现定时任务

迈不过友情╰ 2021-09-02 09:27 557阅读 0赞

# 1、Quartz简介 #

Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目，它可以与J2EE与J2SE应用程序相结合也可以单独使用。Quartz可以用来创建简单或为运行十个，百个，甚至是好几万个Jobs这样复杂的程序。Jobs可以做成标准的Java组件或 EJBs。

## 1.1 Quartz的三大核心组件 ##

*  调度器：Scheduler。
 *  任务：JobDetail。
 *  触发器：Trigger，包括 SimpleTrigger 和 CronTrigger。

（1）Job（任务）：是一个接口，有一个方法 void execute(JobExecutionContext context)  ，可以通过实现该接口来定义需要执行的任务（具体的逻辑代码）。

JobDetail：Quartz每次执行Job时，都重新创建一个Job实例，会接收一个Job实现类，以便运行的时候通过newInstance()的反射调用机制去实例化Job。JobDetail是用来描述Job实现类以及相关静态信息，比如任务在scheduler中的组名等信息。

（2）Trigger（触发器）：描述触发Job执行的时间触发规则实现类SimpleTrigger和CronTrigger可以通过crom表达式定义出各种复杂的调度方案。

Calendar：是一些日历特定时间的集合。一个Trigger可以和多个 calendar关联，比如每周一早上10:00执行任务，法定假日不执行，则可以通过calendar进行定点排除。

（3）Scheduler（调度器）：代表一个Quartz的独立运行容器。Trigger和JobDetail可以注册到Scheduler中。Scheduler可以将Trigger绑定到某一JobDetail上，这样当Trigger被触发时，对应的Job就会执行。一个Job可以对应多个Trigger，但一个Trigger只能对应一个Job。

## 1.2 CronTrigger配置格式 ##

格式：**\[秒\] \[分\] \[小时\] \[日\] \[月\] \[周\] \[年\]**

<table> 
 <thead> 
  <tr> 
   <th>序号</th> 
   <th>说明</th> 
   <th>是否必填</th> 
   <th>允许填写的值</th> 
   <th>允许的通配符</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>1</td> 
   <td>秒</td> 
   <td>是</td> 
   <td>0-59</td> 
   <td>, - * /</td> 
  </tr> 
  <tr> 
   <td>2</td> 
   <td>分</td> 
   <td>是</td> 
   <td>0-59</td> 
   <td>, - * /</td> 
  </tr> 
  <tr> 
   <td>3</td> 
   <td>小时</td> 
   <td>是</td> 
   <td>0-23</td> 
   <td>, - * /</td> 
  </tr> 
  <tr> 
   <td>4</td> 
   <td>日</td> 
   <td>是</td> 
   <td>1-31</td> 
   <td>, - * ? / L W</td> 
  </tr> 
  <tr> 
   <td>5</td> 
   <td>月</td> 
   <td>是</td> 
   <td>1-12 or JAN-DEC</td> 
   <td>, - * /</td> 
  </tr> 
  <tr> 
   <td>6</td> 
   <td>周</td> 
   <td>是</td> 
   <td>1-7 or SUN-SAT</td> 
   <td>, - * ? / L #</td> 
  </tr> 
  <tr> 
   <td>7</td> 
   <td>年</td> 
   <td>否</td> 
   <td>empty 或 1970-2099</td> 
   <td>, - * /</td> 
  </tr> 
 </tbody> 
</table>

**通配符说明:**

**\* **表示所有值. 例如:在分的字段上设置 "\*",表示每一分钟都会触发。

**?** 表示不指定值。使用的场景为不需要关心当前设置这个字段的值。例如:要在每月的10号触发一个操作，但不关心是周几，所以需要周位置的那个字段设置为"?" 具体设置为 0 0 0 10 \* ?

**-** 表示区间。例如 在小时上设置 "10-12",表示 10,11,12点都会触发。

**,** 表示指定多个值，例如在周字段上设置 "MON,WED,FRI" 表示周一，周三和周五触发

**/** 用于递增触发。如在秒上面设置"5/15" 表示从5秒开始，每增15秒触发(5,20,35,50)。在月字段上设置'1/3'所示每月1号开始，每隔三天触发一次。

**L** 表示最后的意思。在日字段设置上，表示当月的最后一天(依据当前月份，如果是二月还会依据是否是润年\[leap\]), 在周字段上表示星期六，相当于"7"或"SAT"。如果在"L"前加上数字，则表示该数据的最后一个。例如在周字段上设置"6L"这样的格式,则表示“本月最后一个星期五"

**W** 表示离指定日期的最近那个工作日(周一至周五). 例如在日字段上设置"15W"，表示离每月15号最近的那个工作日触发。如果15号正好是周六，则找最近的周五(14号)触发, 如果15号是周未，则找最近的下周一(16号)触发.如果15号正好在工作日(周一至周五)，则就在该天触发。如果指定格式为 "1W",它则表示每月1号往后最近的工作日触发。如果1号正是周六，则将在3号下周一触发。(注，"W"前只能设置具体的数字,不允许区间"-").

> **小提示：**'L'和 'W'可以一组合使用。如果在日字段上设置"LW",则表示在本月的最后一个工作日触发（一般指发工资） 。

**\#** 序号(表示每月的第几个周几)，例如在周字段上设置"6\#3"表示在每月的第三个周六.注意如果指定"\#5",正好第五周没有周六，则不会触发该配置(用在母亲节和父亲节再合适不过了)

> **小提示：**周字段的设置，若使用英文字母是不区分大小写的 MON 与mon相同。

可通过在线生成Cron表达式的工具：[http://cron.qqe2.com/][http_cron.qqe2.com] 来生成自己想要的表达式。

**常用示例：**

<table> 
 <tbody> 
  <tr> 
   <td>0 0 12 * * ?</td> 
   <td>每天12点触发</td> 
  </tr> 
  <tr> 
   <td>0 15 10 ? * *</td> 
   <td>每天10点15分触发</td> 
  </tr> 
  <tr> 
   <td>0 15 10 * * ?</td> 
   <td>每天10点15分触发</td> 
  </tr> 
  <tr> 
   <td>0 15 10 * * ? *</td> 
   <td>每天10点15分触发</td> 
  </tr> 
  <tr> 
   <td>0 15 10 * * ? 2005</td> 
   <td>2005年每天10点15分触发</td> 
  </tr> 
  <tr> 
   <td>0 * 14 * * ?</td> 
   <td>每天下午的 2点到2点59分每分触发</td> 
  </tr> 
  <tr> 
   <td>0 0/5 14 * * ?</td> 
   <td>每天下午的 2点到2点59分(整点开始，每隔5分触发)</td> 
  </tr> 
  <tr> 
   <td>0 0/5 14,18 * * ?</td> 
   <td>每天下午的 2点到2点59分(整点开始，每隔5分触发)每天下午的 18点到18点59分(整点开始，每隔5分触发)</td> 
  </tr> 
  <tr> 
   <td>0 0-5 14 * * ?</td> 
   <td>每天下午的 2点到2点05分每分触发</td> 
  </tr> 
  <tr> 
   <td>0 10,44 14 ? 3 WED</td> 
   <td>3月分每周三下午的 2点10分和2点44分触发</td> 
  </tr> 
  <tr> 
   <td>0 15 10 ? * MON-FRI</td> 
   <td>从周一到周五每天上午的10点15分触发</td> 
  </tr> 
  <tr> 
   <td>0 15 10 15 * ?</td> 
   <td>每月15号上午10点15分触发</td> 
  </tr> 
  <tr> 
   <td>0 15 10 L * ?</td> 
   <td>每月最后一天的10点15分触发</td> 
  </tr> 
  <tr> 
   <td>0 15 10 ? * 6L</td> 
   <td>每月最后一周的星期五的10点15分触发</td> 
  </tr> 
  <tr> 
   <td>0 15 10 ? * 6L 2002-2005</td> 
   <td>从2002年到2005年每月最后一周的星期五的10点15分触发</td> 
  </tr> 
  <tr> 
   <td>0 15 10 ? * 6#3</td> 
   <td>每月的第三周的星期五开始触发</td> 
  </tr> 
  <tr> 
   <td>0 0 12 1/5 * ?</td> 
   <td>每月的第一个中午开始每隔5天触发一次</td> 
  </tr> 
  <tr> 
   <td>0 11 11 11 11 ?</td> 
   <td>每年的11月11号 11点11分触发(光棍节)</td> 
  </tr> 
 </tbody> 
</table>

> **Quartz学习资料：**
> 
> [《Quartz官方文档》][Quartz]
> 
> [《SpringBoot整合Quartz实现定时任务》][SpringBoot_Quartz]
> 
> [《定时任务框架Quartz入门与Demo搭建》][Quartz_Demo]

# 2、SpringBoot整合Quartz框架 #

**【示例】**创建SpringBoot项目并整合Quartz框架，实现定时任务功能。

## 2.1 创建项目 ##

**（1）创建SpringBoot项目，项目结构如下图：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70][]

**（2）使用Maven添加依赖文件**

在pom.xml配置信息文件中，添加SpringBoot整合Quartz框架的相关依赖：

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

## 2.2 实现定时任务 ##

**（1）实现定时任务业务逻辑**

在 com.pjb.job 包下创建同步用户信息Job类（SyncUserJob.java），并继承 QuartzJobBean 类，重写 void executeInternal(JobExecutionContext jobExecutionContext) 方法。

package com.pjb.job;
    
    import org.quartz.JobExecutionContext;
    import org.springframework.scheduling.quartz.QuartzJobBean;
    
    import java.text.SimpleDateFormat;
    import java.util.Date;
    
    /**
     * 同步用户信息Job
     * @author pan_junbiao
     **/
    public class SyncUserJob extends QuartzJobBean
    {
        @Override
        protected void executeInternal(JobExecutionContext jobExecutionContext)
        {
            //获取JobDetail中传递的参数
            String userName = (String) jobExecutionContext.getJobDetail().getJobDataMap().get("userName");
            String blogUrl = (String) jobExecutionContext.getJobDetail().getJobDataMap().get("blogUrl");
            String blogRemark = (String) jobExecutionContext.getJobDetail().getJobDataMap().get("blogRemark");
    
            //获取当前时间
            Date date = new Date();
            SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    
            //打印信息
            System.out.println("用户名称：" + userName);
            System.out.println("博客地址：" + blogUrl);
            System.out.println("博客信息：" + blogRemark);
            System.out.println("当前时间：" + dateFormat.format(date));
            System.out.println("----------------------------------------");
        }
    }

**（2）配置定时任务**

在 com.pjb.config 包中创建 Quartz定时任务配置类（QuartzConfig.java），添加 @Configuration 注解表示为配置类，并编写相关配置信息。

package com.pjb.config;
    
    import com.pjb.job.SyncUserJob;
    import org.quartz.*;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    /**
     * Quartz定时任务配置类
     * @author pan_junbiao
     **/
    @Configuration
    public class QuartzConfig
    {
        private static String JOB_GROUP_NAME = "PJB_JOBGROUP_NAME";
        private static String TRIGGER_GROUP_NAME = "PJB_TRIGGERGROUP_NAME";
    
        /**
         * 定时任务1：
         * 同步用户信息Job（任务详情）
         */
        @Bean
        public JobDetail syncUserJobDetail()
        {
            JobDetail jobDetail = JobBuilder.newJob(SyncUserJob.class)
                    .withIdentity("syncUserJobDetail",JOB_GROUP_NAME)
                    .usingJobData("userName", "pan_junbiao的博客") //设置参数（键值对）
                    .usingJobData("blogUrl","https://blog.csdn.net/pan_junbiao")
                    .usingJobData("blogRemark","您好，欢迎访问 pan_junbiao的博客")
                    .storeDurably() //即使没有Trigger关联时，也不需要删除该JobDetail
                    .build();
            return jobDetail;
        }
    
        /**
         * 定时任务1：
         * 同步用户信息Job（触发器）
         */
        @Bean
        public Trigger syncUserJobTrigger()
        {
            //每隔5秒执行一次
            CronScheduleBuilder cronScheduleBuilder = CronScheduleBuilder.cronSchedule("0/5 * * * * ?");
    
            //创建触发器
            Trigger trigger = TriggerBuilder.newTrigger()
                    .forJob(syncUserJobDetail())//关联上述的JobDetail
                    .withIdentity("syncUserJobTrigger",TRIGGER_GROUP_NAME)//给Trigger起个名字
                    .withSchedule(cronScheduleBuilder)
                    .build();
            return trigger;
        }
    }

**（3）运行测试**

完成上述代码与配置后，就可以启动 SpringBoot 项目，进行运行测试。

**执行结果：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 1][]

> **源代码下载：**[https://github.com/kevinpanjunbiao/SpringBootQuartzDemo][https_github.com_kevinpanjunbiao_SpringBootQuartzDemo]
> 
> **原文地址：**[https://blog.csdn.net/pan\_junbiao/article/details/109556822][SpringBoot_Quartz]

[http_cron.qqe2.com]: http://cron.qqe2.com/
[Quartz]: https://www.w3cschool.cn/quartz_doc/
[SpringBoot_Quartz]: https://blog.csdn.net/pan_junbiao/article/details/109556822
[Quartz_Demo]: https://blog.csdn.net/noaman_wgs/article/details/80984873
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70]: /images/20210724/c3a2d7ad753d46b2bbabcca7fd58176b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70 1]: /images/20210724/7487603416724f40b56debaa6f404fac.png
[https_github.com_kevinpanjunbiao_SpringBootQuartzDemo]: https://github.com/kevinpanjunbiao/SpringBootQuartzDemo