记录定时任务开发--Quartz

前言

项目新需求需要定时处理数据，但是原来没有这个模块，奉命开发，之前接触过Quartz。但是有些忘记了，所以过一遍。加班把这个模块做了出来，还有很多不足，需要继续完善。

1 什么是Quartz

Quartz是OpenSymphony开源组织在Job scheduling领域的开源项目,它可以与J2EE与J2SE应用程序相结合也可以单独使用。Quartz可以用来创建简单或为运行十个，百个，甚至是好几万个Jobs这样复杂的日程序表。Jobs可以做成标准的Java组件或EJBs。Quartz是一个任务日程管理系统，一个在预先确定（被纳入日程）的时间到达时，负责执行（或者通知）其他软件组件的系统。

Quartz用一个小Java库发布文件（.jar文件），这个库文件包含了所有Quartz核心功能。这些功能的主要接口(API)是Scheduler接口。它提供了简单的操作，例如：将任务纳入日程或者从日程中取消，开始/停止/暂停日程进度。

2 Quartz框架架构

2.1 Quartz框架的核心对象

Scheduler – 核心调度器

Job – 任务

JobDetail – 任务描述

Trigger --触发器

2.2 对象之间的关系

3.使用方法

3.1基本表

CREATE TABLE `tbl_schedule_job` (

`id` varchar(50) DEFAULT NULL,

`cronExpression` varchar(255),

`beanName` varchar(255) DEFAULT NULL,

`methodName` varchar(255) DEFAULT NULL,

`params` varchar(255) DEFAULT NULL,

`status` char(1) DEFAULT NULL,

`created_dt` timestamp(6) NULL DEFAULT NULL,

`is_deleted` char(1) DEFAULT NULL

) ENGINE=InnoDB DEFAULT CHARSET=utf8;

3.2 创建ScheduleJob

ScheduleJob继承QuartzJobBean，重写了executeInternal(JobExecutionContext context)方法，在该方法下定义一个线程，用来执行定时任务，具体执行是在ScheduleRunnable类，具体后面再提。下面看ScheduleJob类的源码：

@DisallowConcurrentExecution就可以让任务变成有状态,防止并发。

3.3 ScheduleRunnable类

ScheduleRunnable类实现Runnable接口，主要是通过Java反射，执行ScheduleJob传过来对应方法的，源码如下：

3.4 ScheduleUtils类

接下来就是编写代码，将任务添加到Quartz，并根据在设定的cron表达式执行ScheduleJob类的executeInternal方法，我将关于Quartz的封装到ScheduleUtils中，该类对Quartz进行增加、修改、删除、暂停、恢复、立即执行等。代码如下：

createScheduleJob【创建定时任务】：在管理后台新增任务时，会调用该方法，把任务添加到Quartz中，再根据cron表达式，定时执行任务。

updateScheduleJob【更新定时任务】：修改任务时，调用该方法，修改Quartz中的任务信息。

run【立即执行定时任务】：马上执行一次该任务，只执行一次。

pauseJob【暂停定时任务】：这个不是暂停正在执行的任务，而是以后不再执行这个定时任务了。正在执行的任务，还是照常执行完。

resumeJob【恢复定时任务】：这个是针对pauseJob来的，如果任务暂停了，以后都不会再执行，要想再执行，则需要调用resumeJob，使定时任务恢复执行。

deleteScheduleJob【删除定时任务】：删除定时任务

在启动项目的时候，会调用createScheduleJob 和updateScheduleJob，把数据库里，新增或修改的任务，初始化Quartz。

3.5 新增定时任务

新增一个定时任务，只要定义一个类，让Spring来管理Bean即可，可用@Component("value")来注入

同时在数据库中加入两条数据即可开启：

最后就是将Quartz交给spring来管理，并且加入配置。

当然这个定时任务还可以用来做分布式定时任务，只是需要多一些配置和表，具体请自行百度。然后就可以通过可视化来管理定时任务了

4 Cron 表达式

这里给一些在网上找的表达式：

cron的表达式被用来配置CronTrigger实例。 cron的表达式是字符串，实际上是由七子表达式，描述个别细节的时间表。这些子表达式是分开的空白，代表：

1. Seconds

2. Minutes

3. Hours

4. Day-of-Month

5. Month

6. Day-of-Week

7. Year

(可选字段)

例 "0 0 12 ? * WED" 在每星期三下午12:00 执行,个别子表达式可以包含范围, 例如，在前面的例子里("WED")可以替换成 "MON-FRI", "MON, WED,FRI"甚至"MON-WED,SAT".

“*” 代表整个时间段.

每一个字段都有一套可以指定有效值，如

Seconds (秒) ：可以用数字0－59 表示，

Minutes(分) ：可以用数字0－59 表示，

Hours(时) ：可以用数字0-23表示,

Day-of-Month(天)：可以用数字1-31 中的任一一个值，但要注意一些特别的月份

Month(月) ：可以用0-11 或用字符串 “JAN, FEB, MAR, APR, MAY, JUN, JUL,

AUG, SEP, OCT, NOV and DEC” 表示

Day-of-Week(每周):可以用数字1-7表示（1 ＝星期日）或用字符口串“SUN, MON, TUE, WED, THU, FRI and SAT”表示

“/”：为特别单位，表示为“每”如“0/15”表示每隔15分钟执行一次,“0”表示为从“0”分开始, “3/20”表示表示每隔20分钟执行一次，“3”表示从第3分钟开始执行

“?”：表示每月的某一天，或第周的某一天

“L”：用于每月，或每周，表示为每月的最后一天，或每个月的最后星期几如“6L”表示“每月的最后一个星期五”

“W”：表示为最近工作日，如“15W”放在每月（day-of-month）字段上表示为“到本月15日最近的工作日”

““#”：是用来指定“的”每月第n个工作日,例在每周（day-of-week）这个字段中内容为"6#3" or "FRI#3" 则表示“每月第三个星期五”

1）Cron表达式的格式：秒分时日月周年(可选)。

字段名允许的值允许的特殊字符

秒 0-59 , - * /

分 0-59 , - * /

小时 0-23 , - * /

日 1-31 , - * ? / L W C

月 1-12 or JAN-DEC , - */

周几 1-7 orSUN-SAT , - *? / L C #

年 (可选字段) empty,1970-2099 , - * /

“?”字符：表示不确定的值

“,”字符：指定数个值

“-”字符：指定一个值的范围

“/”字符：指定一个值的增加幅度。n/m表示从n开始，每次增加m

“L”字符：用在日表示一个月中的最后一天，用在周表示该月最后一个星期X

“W”字符：指定离给定日期最近的工作日(周一到周五)

“#”字符：表示该月第几个周X。6#3表示该月第3个周五

2）Cron表达式范例：

每隔5秒执行一次：*/5 * * * * ?

每隔1分钟执行一次：0 */1 * * * ?

每天23点执行一次：0 0 23 * * ?

每天凌晨1点执行一次：0 0 1 * * ?

每月1号凌晨1点执行一次：0 0 1 1 * ?

每月最后一天23点执行一次：0 0 23 L * ?

每周星期天凌晨1点实行一次：0 0 1 ? * L

在26分、29分、33分执行一次：0 26,29,33 * * * ?

每天的0点、13点、18点、21点都执行一次：0 0 0,13,18,21 * * ?