Quartz 作业调度框架的掌握，从基础的纯服务到界面可配置化

在项目开发过程中，有时候需要利用定时任务技术来完成某些周期性的任务，比如，定时下载对账单、定时进行数据对比、转换，数据定时入库等等。在最开始的时候部分开发人员习惯直接在项目中硬编码一些定时器。

 

我们先看一下一个简单的示例：

 

这样做的好处就是方便，调试的时候修改一下定时@Scheduled里面的时间，然后启动项目就可以运行，但这样做的弊端更大，主要有几个方面：

1、固定的定时任务触发时间，一旦需要修改执行时间，线上的代码需要替换安装包或者打补丁

2、当服务需要进行多节点部署时，无法控制多个节点的同时执行，可能会重复执行导致数据混乱，因为 @Scheduled 是 spring 自带的注解，默认是单线程的，多节点集群部署的服务，需要加分布式锁来控制，或者直接用分布式定时任务 Elastic-Job 或者 XXL-JOB 等。

抛开一些小型的项目不说，很多企业为了系统的稳定性和高并发，都会选择集群部署，那就需要避开这些问题，今天我们就介绍一个开源项目中比较常用的定时任务技术Quartz。

一、Quartz的认识

解释：Quartz 是一个开源的作业调度框架，它完全由 JAVA 写成，并设计用于 J2SE 和 J2EE 应用中。它提供了巨大的灵活性而不牺牲简单性。你能够用它来为执行一个作业而创建简单的或复杂的调度。它有很多特征，如：数据库支持，集群，插件，EJB 作业预构建，JavaMail 及其它，支持 cron-like 表达式等等。

从这句话我们可以看出来，Quartz满足我们前面说到的要求，它既能实现集群又支持动态设置cron表达式，方便管理维护。

1、cron表达式

不管是哪种定时技术，我们都需要设置cron表达式，告诉系统我们需要什么时候执行，那我们就先来了解cron表达式的构成。

cron表达式是用来配置spring定时任务执行时间的字符串，由5个空格分隔成的6个域构成，格式如下：

每一个域的含义解释：

1) 秒：表示在指定的秒数触发定时任务，范围0-59。例如，"*"表示任何秒都触发，"0,3"表示0秒和3秒触发。

2) 分：表示在指定的分钟触发定时任务，范围0-59。例如，"0-3"表示0分钟到3分钟每分钟都触发，"0/2"表示只有偶数分钟触发。

3) 时：表示在指定的小时触发定时任务，范围0-23。例如，"3-15/2"表示上午3点到下午3点每隔2个小时触发。

4) 日：表示在指定的日期触发定时任务，范围1-31(可以写0，但不会生效)。例如，"1"表示1号出发，"5,15"表示5号和15号出发。需要注意的是，日期可以写0，不会报错但也不会生效。

5) 月：表示在指定的月份触发定时任务，范围1-12。例如，"1-4,12"表示1月到4月以及12月触发。

6) 周：表示在指定的星期触发定时任务，范围0-7(0和7都表示周日)。例如，"?"表示一周都触发，"6,7"表示周六日触发。

注意，1月到12月可以用对应的英文缩写JAN-DEC代替，周日到周六可以用对应的英文缩写SUN-SAT代替。但是，周日的缩写SUN只会被替换为0，因此在cron表达式的周域，我们可以写6-7，却不能写SAT-SUN。（1~7 1=SUN 或 SUN，MON，TUE，WED，THU，FRI，SAT）

 

特殊字符的含义说明如下:

1) "*"：匹配该域的任意值，例如在日域上使用"*"，则表示每天都触发该定时任务。

2) "?"：只能在日和周域使用，表示非明确的值，实际作用等同"*"，即匹配任意值。一般在日和周上会出现一次，当然，如果你对日和周两个域都使用"?"或者都使用其他值也没什么问题。

3) "-"：表示范围，例如在分域上使用5-10表示从5分钟到10分钟每分钟触发一次。

4) "/"：表示起始时间触发一次，然后每隔固定时间触发一次。例如，在分钟域使用"10/2"表示从10分钟开始每隔2分钟触发一次，直到58分钟。也可以和字符"-"连用，例如在分钟域使用"10-30/2"表示从10分钟开始每隔2分钟触发一次，直到30分钟。

5) ","：表示枚举多个值，这些值之间是"或"的关系。例如，在月份上使用"1-3,10,12"表示1月到3月，10月，12月都触发。

下面是一些cron表达式和对应的含义：

"0 30 9 ? * *" 每天上午9:30触发

"0 0/5 14 * * ?" 在每天下午2点到下午2:55期间的每5分钟触发

"0 0-5 14 * * ?" 每天下午2点到下午2:05期间的每1分钟触发

"0 10,44 14 ? 3 WED" 三月的星期三的下午2:10和2:44触发

"0 15 10 ? * MON-FRI" 周一至周五的上午10:15触发

2、quart的组成

Quartz 的核心类有以下三部分：

 

• 任务 Job ： 需要实现的任务类，实现execute() 方法，执行后完成任务。
• 触发器 Trigger ： 包括SimpleTrigger 和 CronTrigger。
• 调度器 Scheduler ： 任务调度器，负责基于Trigger触发器，来执行 Job任务。

 

主要关系如下：

 

3、quart涉及的表

数据库使用quart定时任务，会使用到一些指定的表结构，主要是QRTZ开头的表结构。

 

二、Quartz的集成

1、我们以 SpringBoot 为例，搭建一个纯 maven 项目，先添加quartz的依赖：

 

2、按照上图中的 quartz 主要关系图，我们先去创建一个自定义的Job，实现 org.quartz.Job 接口，并实现 execute 方法：

 

或者也可以继承QuartzJobBean类，这种方式需要在maven中额外添加依赖spring-context-support。

 

3、我们看一下一个简单的完整示例（不涉及数据库的交互和界面的操作，方便大家先从简单地开始理解掌握）：

（1）编写自定义MyJob，实现Job类，并实现execute方法，在execute方法里面获取jobDataMap装载的可序列化的对象。

 

（2）编写配置类QuartzManager，实现定时任务的实时查询、修改、新增、删除功能。

 

（3）编写控制类QuartzController，来模拟web端的接口调用。

 

这里面用到了AjaxResult，是我自定义的一个响应类，完全可以自己定义，主要定义code、msg、data等，以及对应的状态类型（SUCCESS、WARN、ERROR）

（4）编写完上面3个文件，我们就可以启动项目，使用postman来验证一下了，先模拟调用获取所有的定时任务，刚开始没有添加过任何任务，所以会返回没有可执行的job，同时控制台输出对应的日志。

 

然后我们模拟调用新增任务，创建一条任务bianchengxia

 

再获取所有的定时任务，此时出现一条之前创建的任务bianchengxia。

 

同理删除也是一样的逻辑，删除之后再次查询列表，已经不展示删除的数据了，这里不再展开。

4、上面的例子是比较简单的示例，往往我们项目中的实际运用是比较复杂的，需要与数据库进行交互（就是与quart涉及的表相关），同时在前端web界面上可以进行展示和动态配置，并且记录操作的日志，我们来看一个示例。

 

新增或者修改定时任务的规则：设置定时任务调用方法、执行的时间规则（cron表达式）、执行的策略、是否并发执行以及状态等核心参数。

 

记录任务的执行日志：

 

以上是web端的界面操作，后台SpringBoot集成这块，建议把quartz定时器做成一个单独的模块，整合到开发的项目当中。我们到配置文件 Application.yml 中配置quartz，也可以单独写配置文件 quartz.properties 然后项目启动时加载该配置文件：

 

整体的业务实现，包含工具类（比如校验cron表达式、获取上下文信息、常量、定时任务工具类等）、异常处理类、实体类、接口层和接口实现层、dao层和MyBatis数据库交互层、页面操作等：

 

核心代码就是业务实现层，我们看一个核心的SysJobServiceImpl。

 

再看一个定时任务工具类：

 

页面控制：

 

梳理了之后，我们发现它的核心业务也比较简单，先创建一个scheduler，然后创建一个Trigger，再创建一个job，最后注册trigger并启动scheduler，通过页面来进行控制，后台进行一些基础的检验，业务实现，实现数据库交互。