Quzrtz的使用
使用SimpleTrigger
SimpleTrigger拥有多个重载的构造函数,用以在不同场合下构造出对应的实例:
- SimpleTrigger(String name, String group):通过该构造函数指定Trigger所属组和名称;
- SimpleTrigger(String name, String group, Date startTime):除指定Trigger所属组和名称外,还可以指定触发的开发时间;
- SimpleTrigger(String name, String group, Date startTime, Date endTime, int repeatCount, long repeatInterval):除指定以上信息外,还可以指定结束时间、重复执行次数、时间间隔等参数;
- SimpleTrigger(String name, String group, String jobName, String jobGroup, Date startTime, Date endTime, int repeatCount, long repeatInterval):这是最复杂的一个构造函数,在指定触发参数的同时,还通过jobGroup和jobName,让该Trigger和 Scheduler中的某个任务关联起来。
通过实现 org.quartz.Job 接口,可以使 Java 类化身为可调度的任务。代码清单1提供了 Quartz 任务的一个示例:
代码清单1 SimpleJob:简单的Job实现类
import java.util.Date;import org.quartz.Job;import org.quartz.JobExecutionContext;import org.quartz.JobExecutionException;public class SimpleJob implements Job {①实例Job接口方法public void execute(JobExecutionContext jobCtx) throws JobExecutionException {System.out.println(jobCtx.getTrigger().getName()+ " triggered. time is:" + (new Date()));}}
这个类用一条非常简单的输出语句实现了Job接口的execute(JobExecutionContext context) 方法,这个方法可以包含想要执行的
任何代码。
下面,我们通过SimpleTrigger对SimpleJob进行调度:
代码清单2 SimpleTriggerRunner:使用SimpleTrigger进行调度
import java.util.Date;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerFactory;
import org.quartz.SimpleTrigger;
import org.quartz.impl.StdSchedulerFactory;
public class SimpleTriggerRunner {public static void main(String[] args) {try {// ① 创建一个JobDetail实例,指定SimpleJobJobDetail jobDetail = new JobDetail("job1_1", "jGroup1", SimpleJob.class);// ② 通过SimpleTrigger定义调度规则:马上启动,每2秒运行一次,共运行100次SimpleTrigger simpleTrigger = new SimpleTrigger("trigger1_1", "tgroup1");simpleTrigger.setStartTime(new Date());simpleTrigger.setRepeatInterval(2000);simpleTrigger.setRepeatCount(100);// ③ 通过SchedulerFactory获取一个调度器实例SchedulerFactory schedulerFactory = new StdSchedulerFactory();Scheduler scheduler = schedulerFactory.getScheduler();// ④ 注册并进行调度scheduler.scheduleJob(jobDetail, simpleTrigger);// ⑤ 调度启动scheduler.start();} catch (Exception e) {e.printStackTrace();}}}
首先在①处通过JobDetail封装SimpleJob,同时指定Job在Scheduler中所属组及名称,这里,组名为jGroup1,而名称为job1_1。
在②处创建一个SimpleTrigger实例,指定该Trigger在Scheduler中所属组及名称。接着设置调度的时间规则。 最后,需要创建Scheduler实例,并将JobDetail和Trigger实例注册到Scheduler中。这里,我们通过 StdSchedulerFactory获取一个Scheduler实例,并通过scheduleJob(JobDetail jobDetail, Trigger trigger)完成两件事:
- 将JobDetail和Trigger注册到Scheduler中;
- 将Trigger指派给JobDetail,将两者关联起来。
当Scheduler启动后,Trigger将定期触发并执行SimpleJob的execute(JobExecutionContext jobCtx)方法,然后每 10 秒重复一次,直到任务被执行 100 次后停止。还可以通过SimpleTrigger的setStartTime(java.util.Date startTime)和setEndTime(java.util.Date endTime)指定运行的时间范围,当运行次数和时间范围冲突时,超过时间范围的任务运行不被执行。如可以通过impleTrigger.setStartTime(new Date(System.currentTimeMillis() + 60000L))指定60秒钟以后开始。除了通过scheduleJob(jobDetail, simpleTrigger)建立Trigger和JobDetail的关联,还有另外一种关联Trigger和JobDetail的方式:
JobDetail jobDetail = new JobDetail("job1_1", "jGroup1", SimpleJob.class);SimpleTrigger simpleTrigger = new SimpleTrigger("trigger1_1", "tgroup1");simpleTrigger.setJobGroup("jGroup1"); // ①-1:指定关联的Job组名simpleTrigger.setJobName("job1_1");// ①-2:指定关联的Job名称scheduler.addJob(jobDetail, true);// ② 注册JobDetail
scheduler.scheduleJob(simpleTrigger);//③ 注册指定了关联JobDetail的Trigger
在这种方式中,Trigger通过指定Job所属组及Job名称,然后使用Scheduler的scheduleJob(Trigger trigger)方法注册Trigger。有两个值得注意的地方: 通过这种方式注册的Trigger实例必须已经指定Job组和Job名称,否则调用注册Trigger的方法将抛出异常;引用的JobDetail对象必须已经存在于Scheduler中。也即,代码中①、②和③的先后顺序不能互换。
在构造Trigger实例时,可以考虑使用org.quartz.TriggerUtils工具类,该工具类不但提供了众多获取特定时间的方法,还拥有众多获取常见Trigger的方法,如makeSecondlyTrigger(String trigName)方法将创建一个每秒执行一次的Trigger,而
makeWeeklyTrigger(String trigName, int dayOfWeek, int hour, int minute)将创建一个每星期某一特定时间点执行一次的
Trigger。而getEvenMinuteDate(Date date)方法将返回某一时间点一分钟以后的时间。
使用CronTrigger
CronTrigger 能够提供比 SimpleTrigger 更有具体实际意义的调度方案,调度规则基于 Cron 表达式,CronTrigger 支持日历相关的重复时间间隔(比如每月第一个周一执行),而不是简单的周期时间间隔。因此,相对于SimpleTrigger而言,CronTrigger在使用上也要复杂一些。
Cron表达式
Quartz使用类似于Linux下的Cron表达式定义时间规则,Cron表达式由6或7个由空格分隔的时间字段组成,如下所示:
Cron表达式时间字段表
位置
|
时间域名
|
允许值
|
允许的特殊字符
|
1
|
秒
|
0-59
|
, - * /
|
2
|
分钟
|
0-59
|
, - * /
|
3
|
小时
|
0-23
|
, - * /
|
4
|
日期
|
1-31
|
, - * ? / L W C
|
5
|
月份
|
1-12
|
, - * /
|
6
|
星期
|
1-7
|
, - * ? / L C #
|
7
|
年(可选)
|
空值1970-2099
|
, - * /
|
Cron表达式的时间字段除允许设置数值外,还可使用一些特殊的字符,提供列表、范围、通配符等功能,细说如下:
- 星号( * ):可用在所有字段中,表示对应时间域的每一个时刻,例如,* 在分钟字段时,表示“每分钟”;
- 问号(?):该字符只在日期和星期字段中使用,它通常指定为“无意义的值”,相当于点位符;
- 减号( - ):表达一个范围,如在小时字段中使用“10-12”,则表示从10到12点,即10,11,12;
- 逗号( , ):表达一个列表值,如在星期字段中使用“MON,WED,FRI”,则表示星期一,星期三和星期五;
- 斜杠( / ):x/y表达一个等步长序列,x为起始值,y为增量步长值。如在分钟字段中使用0/15,则表示为0,15,30和45秒,而5/15在分钟字段中表示5,20,35,50,你也可以使用*/y,它等同于0/y;
- L:该字符只在日期和星期字段中使用,代表“Last”的意思,但它在两个字段中意思不同。L在日期字段中,表示这个月份的最后一天,如一月的 31号,非闰年二月的28号;如果L用在星期中,则表示星期六,等同于7。但是,如果L出现在星期字段里,而且在前面有一个数值X,则表示“这个月的最后 X天”,例如,6L表示该月的最后星期五;
- W:该字符只能出现在日期字段里,是对前导日期的修饰,表示离该日期最近的工作日。例如15W表示离该月15号最近的工作日,如果该月15号是星期六,则匹配14号星期五;如果15日是星期日,则匹配16号星期一;如果15号是星期二,那结果就是15号星期二。但必须注意关联的匹配日期不能够跨月,如你指定1W,如果1号是星期六,结果匹配的是3号星期一,而非上个月最后的那天。W字符串只能指定单一日期,而不能指定日期范围;
- LW组合:在日期字段可以组合使用LW,它的意思是当月的最后一个工作日;
- 井号( # ):该字符只能在星期字段中使用,表示当月某个工作日。如6#3表示当月的第三个星期五(6表示星期五,#3表示当前的第三个),而4#5表示当月的第五个星期三,假设当月没有第五个星期三,忽略不触发;
- C:该字符只在日期和星期字段中使用,代表“Calendar”的意思。它的意思是计划所关联的日期,如果日期没有被关联,则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。
Cron表达式对特殊字符的大小写不敏感,对代表星期的缩写英文大小写也不敏感。
下面给出一些完整的Cron表示式的实例:
Cron表示式示例表
表示式
|
说明
|
"0 0 12 * * ? "
|
每天12点运行
|
"0 15 10 ? * *"
|
每天10:15运行
|
"0 15 10 * * ?"
|
每天10:15运行
|
"0 15 10 * * ? *"
|
每天10:15运行
|
"0 15 10 * * ? 2008"
|
在2008年的每天10:15运行
|
"0 * 14 * * ?"
|
每天14点到15点之间每分钟运行一次,开始于14:00,结束于14:59
|
"0 0/5 14 * * ?"
|
每天14点到15点每5分钟运行一次,开始于14:00,结束于14:55
|
"0 0/5 14,18 * * ?"
|
每天14点到15点每5分钟运行一次,此外每天18点到19点每5钟也运行一次
|
"0 0-5 14 * * ?"
|
每天14:00点到14:05,每分钟运行一次
|
"0 10,44 14 ? 3 WED"
|
3月每周三的14:10分到14:44,每分钟运行一次
|
"0 15 10 ? * MON-FRI"
|
每周一,二,三,四,五的10:15分运行
|
"0 15 10 15 * ?"
|
每月15日10:15分运行
|
"0 15 10 L * ?"
|
每月最后一天10:15分运行
|
"0 15 10 ? * 6L"
|
每月最后一个星期五10:15分运行
|
"0 15 10 ? * 6L 2007-2009"
|
在2007,2008,2009年每个月的最后一个星期五的10:15分运行
|
"0 15 10 ? * 6#3"
|
每月第三个星期五的10:15分运行
|
CronTrigger实例
下面,我们使用CronTrigger对SimpleJob进行调度,通过Cron表达式制定调度规则,让它每5秒钟运行一次:
代码清单3 CronTriggerRunner:使用CronTrigger进行调度
import org.quartz.CronExpression;import org.quartz.CronTrigger;import org.quartz.JobDetail;import org.quartz.Scheduler;import org.quartz.SchedulerFactory;import org.quartz.impl.StdSchedulerFactory;public class CronTriggerRunner {public static void main(String args[]) {try {JobDetail jobDetail = new JobDetail("job1_2", "jGroup1", SimpleJob.class); // ①-1:创建CronTrigger,指定组及名称CronTrigger cronTrigger = new CronTrigger("trigger1_2", "tgroup1");CronExpression cexp = new CronExpression("0/5 * * * * ?");// ①-2:定义Cron表达式cronTrigger.setCronExpression(cexp);// ①-3:设置Cron表达式SchedulerFactory schedulerFactory = new StdSchedulerFactory();Scheduler scheduler = schedulerFactory.getScheduler();scheduler.scheduleJob(jobDetail, cronTrigger);scheduler.start(); // ②} catch (Exception e) {e.printStackTrace();}}}
运行CronTriggerRunner,每5秒钟将触发运行SimpleJob一次。默认情况下Cron表达式对应当前的时区,可以通过
CronTriggerRunner的setTimeZone(java.util.TimeZone timeZone)方法显式指定时区。你还也可以通过
setStartTime(java.util.Date startTime)和setEndTime(java.util.Date endTime)指定开始和结束的时间。
在代码清单3的②处需要通过Thread.currentThread.sleep()的方式让主线程睡眠,以便调度器可以继续工作执行任务调度。否则在调度器启动后,因为主线程马上退出,也将同时引起调度器关闭,调度器中的任务都将相应销毁,这将导致看不到实际的运行效果。在单元测试的时候,让主线程睡眠经常使用的办法。对于某些长周期任务调度的测试,你可以简单地调整操作系统时间进行模拟。
使用Calendar
在实际任务调度中,我们不可能一成不变地按照某个周期性的调度规则运行任务,必须考虑到实现生活中日历上特定日期,就象习惯了大男人作风的人在2月14号也会有不同表现一样。 下面,我们安排一个任务,每小时运行一次,并将五一节和国际节排除在外,其
代码如代码清单4所示:
代码清单4 CalendarExample:使用Calendar
import java.util.Calendar;import java.util.Date;import java.util.GregorianCalendar;import org.quartz.impl.calendar.AnnualCalendar;import org.quartz.TriggerUtils;„public class CalendarExample {public static void main(String[] args) throws Exception {SchedulerFactory sf = new StdSchedulerFactory();Scheduler scheduler = sf.getScheduler();// ①法定节日是以每年为周期的,所以使用AnnualCalendarAnnualCalendar holidays = new AnnualCalendar();// ②五一劳动节Calendar laborDay = new GregorianCalendar();laborDay.add(Calendar.MONTH, 5);laborDay.add(Calendar.DATE, 1);holidays.setDayExcluded(laborDay, true); // ②-1:排除的日期,如果设置为false则为包含// ③国庆节Calendar nationalDay = new GregorianCalendar();nationalDay.add(Calendar.MONTH, 10);nationalDay.add(Calendar.DATE, 1);holidays.setDayExcluded(nationalDay, true);// ③-1:排除该日期scheduler.addCalendar("holidays", holidays, false, false);// ④向Scheduler注册日历Date runDate = TriggerUtils.getDateOf(0, 0, 10, 1, 4);// ⑤4月1号上午10点JobDetail job = new JobDetail("job1", "group1", SimpleJob.class);SimpleTrigger trigger = new SimpleTrigger("trigger1", "group1", runDate, null,SimpleTrigger.REPEAT_INDEFINITELY, 60L * 60L * 1000L);trigger.setCalendarName("holidays");// ⑥让Trigger应用指定的日历规则scheduler.scheduleJob(job, trigger);scheduler.start(); // 实际应用中主线程不能停止,否则Scheduler得不到执行,此处从略}}
由于节日是每年重复的,所以使用org.quartz.Calendar的AnnualCalendar实现类,通过②、③的代码,指定五一和国庆两个节日并通过AnnualCalendar#setDayExcluded(Calendar day, boolean exclude)方法添加这两个日期。exclude为true时表示排除指定的日期,如果为false时表示包含指定的日期。
在定制好org.quartz.Calendar后,还需要通过Scheduler#addCalendar(String calName, Calendar calendar, boolean replace, boolean updateTriggers)
进行注册,如果updateTriggers为true,Scheduler中已引用Calendar的Trigger将得到更新,如④所示在⑥处,我们让一个Trigger
指定使用Scheduler中代表节日的Calendar,这样Trigger就会避开五一和国庆这两个特殊日子了。
任务调度信息存储
在默认情况下Quartz将任务调度的运行信息保存在内存中,这种方法提供了最佳的性能,因为内存中数据访问最快。不足之处是缺乏数据的持久性,当程序路途停止或系统崩溃时,所有运行的信息都会丢失。比如我们希望安排一个执行100次的任务,如果执行到50
次时系统崩溃了,系统重启时任务的执行计数器将从0开始。在大多数实际的应用中,我们往往并不需要保存任务调度的现场数据,因为很少需要规划一个指定执行次数的任务。
对于仅执行一次的任务来说,其执行条件信息本身应该是已经持久化的业务数据(如锁定到期解锁任务,解锁的时间应该是业务数据)
,当执行完成后,条件信息也会相应改变。当然调度现场信息不仅仅是记录运行次数,还包括调度规则、JobDataMap中的数据等。
如果确实需要持久化任务调度信息,Quartz允许你通过调整其属性文件,将这些信息保存到数据库中。使用数据库保存任务调度信息后,即使系统崩溃后重新启动,任务的调度信息将得到恢复。如前面所说的例子,执行50次崩溃后重新运行,计数器将从51开始计数。使用了数据库保存信息的任务称为持久化任务。
通过配置文件调整任务调度信息的保存策略
其实Quartz JAR文件的org.quartz包下就包含了一个quartz.properties属性配置文件并提供了默认设置。如果需要调整默认配置,可以在类路径下建立一个新的quartz.properties,它将自动被Quartz加载并覆盖默认的设置。
先来了解一下Quartz的默认属性配置文件:
代码清单5 quartz.properties:默认配置
①集群的配置,这里不使用集群
org.quartz.scheduler.instanceName = DefaultQuartzScheduler
org.quartz.scheduler.rmi.export = false
org.quartz.scheduler.rmi.proxy = false
org.quartz.scheduler.wrapJobExecutionInUserTransaction = false
②配置调度器的线程池
org.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool
org.quartz.threadPool.threadCount = 10
org.quartz.threadPool.threadPriority = 5
org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true
③配置任务调度现场数据保存机制
org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore
Quartz的属性配置文件主要包括三方面的信息:
- 1) 集群信息;
- 2) 调度器线程池;
- 3) 任务调度现场数据的保存。
如果任务数目很大时,可以通过增大线程池的大小得到更好的性能。默认情况下,Quartz采用org.quartz.simpl.RAMJobStore
保存任务的现场数据,顾名思义,信息保存在RAM内存中,我们可以通过以下设置将任务调度现场数据保存到数据库中:
代码清单6 quartz.properties:使用数据库保存任务调度现场数据
„
org.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX
org.quartz.jobStore.tablePrefix = QRTZ_ ①数据表前缀
org.quartz.jobStore.dataSource = qzDS ②数据源名称
③定义数据源的具体属性
org.quartz.dataSource.qzDS.driver = oracle.jdbc.driver.OracleDriver
org.quartz.dataSource.qzDS.URL = jdbc:oracle:thin:@localhost:1521:ora9i
org.quartz.dataSource.qzDS.user = stamen
org.quartz.dataSource.qzDS.password = abc
org.quartz.dataSource.qzDS.maxConnections = 10
要将任务调度数据保存到数据库中,就必须使用org.quartz.impl.jdbcjobstore.JobStoreTX代替原来的
org.quartz.simpl.RAMJobStore并提供相应的数据库配置信息。首先①处指定了Quartz数据库表的前缀,在②处定义了一个数据源,
在③处具体定义这个数据源的连接信息。你必须事先在相应的数据库中创建Quartz的数据表(共8张),在Quartz的完整发布包的
docs/dbTables目录下拥有对应不同数据库的SQL脚本。
查询数据库中的运行信息
任务的现场保存对于上层的Quartz程序来说是完全透明的,我们在src目录下编写一个如代码清单6所示的quartz.properties文件后,重新运行代码清单2或代码清单3的程序,在数据库表中将可以看到对应的持久化信息。当调度程序运行过程中途停止后,任务调度的现场数据将记录在数据表中,在系统重启时就可以在此基础上继续进行任务的调度。
代码清单7 JDBCJobStoreRunner:从数据库中恢复任务的调度
import org.quartz.Scheduler;import org.quartz.SchedulerFactory;import org.quartz.SimpleTrigger;import org.quartz.Trigger;import org.quartz.impl.StdSchedulerFactory;public class JDBCJobStoreRunner {public static void main(String args[]) {try {SchedulerFactory schedulerFactory = new StdSchedulerFactory();Scheduler scheduler = schedulerFactory.getScheduler();// ①获取调度器中所有的触发器组String[] triggerGroups = scheduler.getTriggerGroupNames();// ②重新恢复在tgroup1组中,名为trigger1_1触发器的运行for (int i = 0; i < triggerGroups.length; i++) {String[] triggers = scheduler.getTriggerNames(triggerGroups[i]);for (int j = 0; j < triggers.length; j++) {Trigger tg = scheduler.getTrigger(triggers[j], triggerGroups[i]);if (tg instanceof SimpleTrigger && tg.getFullName().equals("tgroup1.trigger1_1")) {// ②-1:根据名称判断// ②-1:恢复运行scheduler.rescheduleJob(triggers[j], triggerGroups[i], tg);}}}scheduler.start();} catch (Exception e) {e.printStackTrace();}}}
当代码清单2中的SimpleTriggerRunner执行到一段时间后非正常退出,我们就可以通过这个JDBCJobStoreRunner根据记录在数据库中的现场数据恢复任务的调度。Scheduler中的所有Trigger以及JobDetail的运行信息都会保存在数据库中,这里我们仅恢复tgroup1
组中名称为trigger1_1的触发器,这可以通过如②-1所示的代码进行过滤,触发器的采用GROUP.TRIGGER_NAME 的全名格式。通过
Scheduler#rescheduleJob(String triggerName,String groupName,Trigger newTrigger)即可重新调度关联某个Trigger的任务。
小结
Quartz提供了最为丰富的任务调度功能,不但可以制定周期性运行的任务调度方案,还可以让你按照日历相关的方式进行任务调度。
Quartz框架的重要组件包括Job、JobDetail、Trigger、Scheduler以及辅助性的JobDataMap和SchedulerContext。
Quartz拥有一个线程池,通过线程池为任务提供执行线程,你可以通过配置文件对线程池进行参数定制。Quartz的另一个重要功能是可将任务调度信息持久化到数据库中,以便系统重启时能够恢复已经安排的任务。此外,Quartz还拥有完善的事件体系,允许你注册各种事件的监听器。