java-web系列（七）---SpringBoot整合Quartz实现多定时任务

「爱情、让人受尽委屈。」 2022-05-10 08:42 46阅读 0赞

# 前言 #

这个项目的github地址：[extensible项目的github地址][extensible_github]

extensible项目当前功能模块如下：

[java-web系列（一）—搭建一个基于SSM框架的java-web项目][java-web_SSM_java-web]  
[java-web系列（二）—以dockerfile的方式发布java-web项目][java-web_dockerfile_java-web]  
[java-web系列（三）—(slf4j + logback)进行日志分层][java-web_slf4j _ logback]  
[java-web系列（四）—几种常见的加密算法][java-web]  
[java-web系列（五）—SpringBoot整合Redis][java-web_SpringBoot_Redis]  
[java-web系列（六）—Mybatis动态多数据源配置][java-web_Mybatis]  
[java-web系列（七）—SpringBoot整合Quartz实现多定时任务][java-web_SpringBoot_Quartz]  
[java-web系列（八）—RabbitMQ在java-web中的简单应用][java-web_RabbitMQ_java-web]  
[java-web系列（九）—SpringBoot整合ElasticSearch][java-web_SpringBoot_ElasticSearch]

如对该项目有疑问，可在我的博客/github下面留言，也可以以邮件的方式告知。  
我的联系方式：dzy930724@163.com

# 定时任务的使用场景 #

在项目的开发过程中，我们经常会遇到类似这样的需求：**需要定期执行某一项工作，或者按照特定计划执行某些工作**。这时我们就需要用到定时任务。

# SpringBoot对定时任务的支持 #

日常开发中，定时任务最常用的实现方式有如下两种：

*  Spring-3.\*版本之后，自带定时任务的实现
 *  SpringBoot-2.\*版本之后，均实现了Quartz的自动配置

# Spring自带定时任务的实现—@Scheduled注解 #

Spring自带定时任务的实现，是靠`@Scheduled`注解实现的。在SpringBoot项目中，我们想使该注解生效，还需要在类上加注解`@EnableScheduling`，开启对Spring定时任务的支持，测试源码如下：

/** * @author zhenye 2018/9/21 */
    @Configuration
    @EnableScheduling
    @Slf4j
    public class SpringScheduleConfig { 
    
        private SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    
        @Scheduled(fixedRate = 1000 * 60L)
        public void runIntervalTask(){ 
            log.info("Spring3.*之后的自带定时任务实现 ===> fixedRate表示按固定频率执行该任务---打印当前时间：{}",sdf.format(new Date()));
        }
    
        @Scheduled(cron = "47 * * * * ?")
        public void runCornExpTask(){ 
            log.info("Spring3.*之后的自带定时任务实现 ===> cron表示按corn表达式执行该任务---打印当前时间：{}",sdf.format(new Date()));
        }
    }

上面的两个定时任务就是基于注解`@Scheduled`实现的。

*  `runIntervalTask()`,是一个按固定频率运行的任务，每1分钟执行一次。
 *  `runCornExpTask()`,是一个按corn表达运行的任务，每分钟的第47秒运行一次。

启动项目后，效果图如下：

![Spring自带定时任务效果图][Spring]

# SpringBoot整合Quartz #

SpringBoot从2.0版本之后，就对Quartz的自动配置进行了支持。  
如：我使用的SpringBoot版本为：2.0.4

![SpringBoot-2.0支持Quartz][SpringBoot-2.0_Quartz]

Quartz中最重要的几个概念解释：

*  `Scheduler`,调度器。作用是，用来统一管理工作内容、工作计划周期。
 *  `JobDetail`,作业实例。作用是，用来定义某项具体工作的工作内容。
 *  `Trigger`,触发器。作用是，用来定义某项具体工作的执行频率。

这些抽象概念不是那么容易理解，我以“吃饭”来简单讲解一下它们的含义。

比如我给自己定了一个计划表：每天8点到8点半吃早饭，每天12点到12点半吃午饭。用Quartz的概念解释如下：

*  **这个计划表，就是调度器（`Scheduler`）**,调度器告诉我们什么时候该干什么。然后，早饭吃的是豆浆+油条，午饭吃的是米饭。
 *  **早饭、午饭就是作业实例（`JobDetail`）**，作业实例是用来定义某项具体工作的工作内容。
 *  **8点到8点半、12点到12点半就是两个触发器（`Trigger`）**，触发器关联某个作业实例，告诉该作业实例在什么时候进行作业。

从上面的事例说明，我们就很容易看出这三者之间的关系。

## 单任务的实现 ##

SpringBoot-2.0开启了Quartz的自动配置，因此单定时任务的实现非常简单。直接上代码：

首先，在pom文件中加入自动配置依赖

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

然后，定义该定时任务的具体工作内容

@Slf4j
    public class SimpleQuartzTask  extends QuartzJobBean{ 
        /** * 实现QuartzJobBean的executeInternal()方法，即可定义工作内容 */
        @Override
        protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException { 
            log.info("简单的单Quartz任务开始---");
            try { 
                Thread.sleep(4000L);
            } catch (InterruptedException e) { 
                log.error("线程阻塞失败。",e);
            }
            log.info("简单的单Quartz任务结束---");
        }
    }

最后，将该定时任务的工作内容和触发器进行配置即可。

/** * @author zhenye 2018/9/26 */
    @Configuration
    public class SimpleQuartzConfig { 
    
        @Bean
        public JobDetail simpleQuartzTaskDetail(){ 
            return JobBuilder.newJob(SimpleQuartzTask.class).withIdentity("simpleQuartzTask").storeDurably().build();
        }
    
        @Bean
        public Trigger simpleQuartzTaskTrigger(){ 
            CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule("*/3 * * * * ?");
            return TriggerBuilder.newTrigger().forJob(simpleQuartzTaskDetail())
                    .withIdentity("simpleQuartzTask")
                    .withSchedule(scheduleBuilder)
                    .build();
        }
    }

启动项目，即可看到单定时任务的执行效果图如下：

![单定时任务的效果图][70]

## 多任务的实现 ##

实际项目的开发过程中，可能要实现多个定时任务。如果用上面“单任务”的模板定义，定时任务的**配置类就会显得呆板复杂，程序可读性也会很差**。

因此多任务的实现，需要换种方式进行配置。实际代码如下：

首先，还是要在pom文件中导入依赖

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

然后，定义一个任务接口

/** * @author zhenye 2018/9/21 */
    public interface QuartzScheduleTask { 
        /** * 该方法的实现，表示某个任务的具体工作内容 */
        void exec();
    }

再在properties配置文件中配置quartz的部分参数

# quartz定时任务相关的配置
    quartz.scheduler-name=QUARTZ_SCHEDULER
    quartz.thread-count=10
    quartz.thread-name-prefix=quartz_worker
    quartz.tasks=\
        ReportTimeTask:*/10 * * * * ? *

再进行自定义quartz的配置

/** * quartz定时任务的配置类 * @author zhenye 2018/9/21 */
    @Configuration
    @ConfigurationProperties("quartz")
    @Getter
    @Setter
    public class QuartzScheduleConfig { 
    
        private String schedulerName;
        private String threadCount;
        private String threadNamePrefix;
        private String tasks;
        private final ApplicationContext context;
    
        @Autowired
        public QuartzScheduleConfig(ApplicationContext context) { 
            this.context = context;
        }
    
        @Bean
        public SchedulerFactoryBean schedulerFactoryBean() { 
            Properties properties = new Properties();
            properties.setProperty("org.quartz.threadPool.threadCount", threadCount);
            properties.setProperty("org.quartz.threadPool.threadNamePrefix", threadNamePrefix);
            SchedulerFactoryBean factory = new SchedulerFactoryBean();
            factory.setSchedulerName(schedulerName);
            factory.setQuartzProperties(properties);
            return factory;
        }
    
        @Bean
        public Scheduler scheduler() throws Exception { 
            Scheduler scheduler = schedulerFactoryBean().getScheduler();
            scheduler.scheduleJobs(createJobDetails(), true);
            return scheduler;
        }
    
        /** * 创建JobDetail * 使用是Spring的MethodInvokingJobDetailFactoryBean来创建JobDetail * 使用Spring的ronTriggerFactoryBean来创建CronTrigger * * @return Map<JobDetail, Set<CronTrigger>> */
        private Map<JobDetail, Set<? extends Trigger>> createJobDetails(){ 
            Set<String> taskSet = StringUtils.commaDelimitedListToSet(tasks);
            Map<JobDetail, Set<? extends Trigger>> map = new HashMap<>(taskSet.size());
            for (String task : taskSet) { 
                String[] nameAndCron = task.split(":");
                String name = StringUtils.uncapitalize(nameAndCron[0]);
                String cron = nameAndCron[1];
                MethodInvokingJobDetailFactoryBean factoryBean = new MethodInvokingJobDetailFactoryBean();
                factoryBean.setTargetObject(context.getBean(name));
                factoryBean.setName(name);
                factoryBean.setTargetMethod(QuartzScheduleTask.class.getMethods()[0].getName());
                factoryBean.afterPropertiesSet();
                CronTriggerFactoryBean cronTriggerFactoryBean = new CronTriggerFactoryBean();
                cronTriggerFactoryBean.setCronExpression(cron);
                cronTriggerFactoryBean.setJobDetail(factoryBean.getObject());
                cronTriggerFactoryBean.setName(name);
                cronTriggerFactoryBean.afterPropertiesSet();
                Set<CronTrigger> cronTriggerSet = new HashSet<>(1);
                cronTriggerSet.add(cronTriggerFactoryBean.getObject());
                map.put(factoryBean.getObject(), cronTriggerSet);
            }
            return map;
        }
    }

最后，进行某项具体任务中工作内容的实现

/** * @author zhenye 2018/9/21 */
    @Slf4j
    @Component
    public class ReportTimeTask implements QuartzScheduleTask{ 
    
        private SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
    
        @Override
        public void exec() { 
            log.info("执行的Quartz指定的任务，现在的时间是：{}",sdf.format(new Date()));
        }
    }

这样，就把多定时任务的配置简化了，启动项目可以看到如下效果图：

![多定时任务效果图][70 1]

然后，需要定义其他定时任务时，只需要两步：

1.  实现`QuartzScheduleTask的exec()`方法，定义该定时任务的工作内容；
2.  在配置文件中加上该定时任务的触发器。

多任务的配置说明：  
  
SpringBoot是将一个定时任务看做一个方法。上面配置的做法是：

*  首先，读取配置文件中`quartz.tasks`中定义的任务名称及该任务的触发器。
 *  然后，通过`ApplicationContext`（应用上下文对象），根据任务名称获取到相应的任务对象实例。
 *  再然后，通过Spring的`MethodInvokingJobDetailFactoryBean`注册`JobDetail`，该任务实例的第一个方法就是该任务的工作内容；通过Spring的`CronTriggerFactoryBean`注册`CornTrigger`，该任务实例在配置文件中的内容，就是该任务的触发器。
 *  把该任务的工作内容和触发器放在Map中，通过schedule的`scheduleJobs()`方法将所有`JobDetail`和`Trigger`添加到调度器中。
 *  这样SpringBoot就会帮我们管理调度器schedule实例，并自动按计划执行相应的定时任务。

这里还需要注明一点：**配置了多任务后，之前的单任务会失效**。因为自定义的调度器Schdule中，并没有加入该单任务对应的`JobDetai`和`Trigger`，所以该调度器不会管理该单任务。

# corn表达式简介 #

不管是Spring自带的定时任务实现，还是SpringBoot整合Quartz的定时任务实现，其触发器都支持用corn表达式来表示。

corn表达式是一个字符串，有6或7个域，域之间是用空格进行间隔。

从左到右每个域表示的含义如下：

<table> 
 <thead> 
  <tr> 
   <th align="left">第几个域</th> 
   <th align="left">英文释义</th> 
   <th align="left">允许值</th> 
   <th align="left">备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">一</td> 
   <td align="left">Seconds</td> 
   <td align="left">0~59</td> 
   <td align="left">秒</td> 
  </tr> 
  <tr> 
   <td align="left">二</td> 
   <td align="left">Minutes</td> 
   <td align="left">0~59</td> 
   <td align="left">分</td> 
  </tr> 
  <tr> 
   <td align="left">三</td> 
   <td align="left">Hours</td> 
   <td align="left">0~23</td> 
   <td align="left">时</td> 
  </tr> 
  <tr> 
   <td align="left">四</td> 
   <td align="left">DayOfMonth</td> 
   <td align="left">1-31</td> 
   <td align="left">天</td> 
  </tr> 
  <tr> 
   <td align="left">五</td> 
   <td align="left">Month</td> 
   <td align="left">1-12或月份简写</td> 
   <td align="left">月</td> 
  </tr> 
  <tr> 
   <td align="left">六</td> 
   <td align="left">DayOfWeek</td> 
   <td align="left">1-7或星期简写</td> 
   <td align="left">星期，1表示SUN</td> 
  </tr> 
  <tr> 
   <td align="left">七</td> 
   <td align="left">Year</td> 
   <td align="left">1970~2099</td> 
   <td align="left">年</td> 
  </tr> 
 </tbody> 
</table>

然后，某些域还支持部分特殊字符，特殊字符的含义如下：

<table> 
 <thead> 
  <tr> 
   <th align="center">特殊字符</th> 
   <th align="left">含义及注意事项</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">*</td> 
   <td align="left">任意值</td> 
  </tr> 
  <tr> 
   <td align="center">?</td> 
   <td align="left">占位符，只能在第四域和第六域中使用</td> 
  </tr> 
  <tr> 
   <td align="center">-</td> 
   <td align="left">区间，表示区间内有效</td> 
  </tr> 
  <tr> 
   <td align="center">/</td> 
   <td align="left">固定间隔</td> 
  </tr> 
  <tr> 
   <td align="center">,</td> 
   <td align="left">枚举有效值的间隔符</td> 
  </tr> 
  <tr> 
   <td align="center">L</td> 
   <td align="left">表示该区间的最后一个有效值，只能在第四域和第六域中使用</td> 
  </tr> 
  <tr> 
   <td align="center">W</td> 
   <td align="left">表示离指定日期的最近的有效工作日，（周一-周五为工作日）</td> 
  </tr> 
 </tbody> 
</table>

常用corn表达式例子含义说明：

<table> 
 <thead> 
  <tr> 
   <th align="left">corn表示式</th> 
   <th align="left">表达式含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">*/10 * * * * ? *</td> 
   <td align="left">每隔10秒执行一次</td> 
  </tr> 
  <tr> 
   <td align="left">0 30 1 * * ? *</td> 
   <td align="left">每天凌晨1点30分0秒开始执行</td> 
  </tr> 
  <tr> 
   <td align="left">0 0 10,14,16 * * ?</td> 
   <td align="left">每天10点、14点、16点执行一次</td> 
  </tr> 
  <tr> 
   <td align="left">0 15 10 L * ?</td> 
   <td align="left">每个月最后一天的10点15分执行一次</td> 
  </tr> 
  <tr> 
   <td align="left">0 15 10 ? * 6L 2018-2020</td> 
   <td align="left">2018年到2020年每个月最后一个星期五的10:15执行</td> 
  </tr> 
 </tbody> 
</table>

[extensible_github]: https://github.com/zhenye163/extensible
[java-web_SSM_java-web]: https://blog.csdn.net/UtopiaOfArtoria/article/details/82150584
[java-web_dockerfile_java-web]: https://blog.csdn.net/UtopiaOfArtoria/article/details/82150811
[java-web_slf4j _ logback]: https://blog.csdn.net/UtopiaOfArtoria/article/details/82151006
[java-web]: https://blog.csdn.net/UtopiaOfArtoria/article/details/82429467
[java-web_SpringBoot_Redis]: https://blog.csdn.net/UtopiaOfArtoria/article/details/82594054
[java-web_Mybatis]: https://blog.csdn.net/UtopiaOfArtoria/article/details/82787572
[java-web_SpringBoot_Quartz]: https://blog.csdn.net/UtopiaOfArtoria/article/details/82867193
[java-web_RabbitMQ_java-web]: https://blog.csdn.net/UtopiaOfArtoria/article/details/82981979
[java-web_SpringBoot_ElasticSearch]: https://blog.csdn.net/UtopiaOfArtoria/article/details/88403459
[Spring]: /images/20220510/ecea6d87fbe148c6bc702a8b04f063e9.png
[SpringBoot-2.0_Quartz]: /images/20220510/d83bdf8cbb524ed3910b72b85b21ab14.png
[70]: /images/20220510/908ab1bba603406f812bbe28382316eb.png
[70 1]: /images/20220510/a003f1604be647118d4862c75acc21f9.png