什么是Quartz?
Quartz是OpenSymphony开源组织在Job scheduling领域又一个开源项目,完全由Java开发,可以用来执行定时任务,类似于java.util.Timer。但是相较于Timer, Quartz增加了很多功能:
持久性作业 - 就是保持调度定时的状态;
作业管理 - 对调度作业进行有效的管理;
拿火车票购票来说,当你下单后,后台就会插入一条待支付的task(job),一般是30分钟,超过30min后就会执行这个job,去判断你是否支付,未支付就会取消此次订单;当你支付完成之后,后台拿到支付回调后就会再插入一条待消费的task(job),Job触发日期为火车票上的出发日期,超过这个时间就会执行这个job,判断是否使用等。
(1)首先我们需要定义实现一个定时功能的接口,我们可以称之为Task(或Job),如定时发送邮件的task(Job),重启机器的task(Job),优惠券到期发送短信提醒的task(Job),实现接口如下:
(2)有了任务之后,还需要一个能够实现触发任务去执行的触发器,触发器Trigger最基本的功能是指定Job的执行时间,执行间隔,运行次数等。
(3)有了Job和Trigger后,怎么样将两者结合起来呢?即怎样指定Trigger去执行指定的Job呢?这时需要一个Schedule,来负责这个功能的实现。
上面三个部分就是Quartz的基本组成部分:
调度器:Scheduler
任务:JobDetail
触发器:Trigger,包括SimpleTrigger和CronTrigger
demo:
1. pom.xml
<dependency> <groupId>org.quartz-scheduler</groupId> <artifactId>quartz</artifactId> <version>2.2.1</version> </dependency>
2.Job,
3.Schedule
public static void main( String[] args ) { System.out.println( "Hello World!" );
//1创建job(任务)对象——做什么事 JobDetail job= JobBuilder.newJob(Q.class).build();
//2创建Trigger(触发器)对象——什么时间做 repeatSecondlyForever每秒执行一次— Trigger trigger= TriggerBuilder.newTrigger().withSchedule(SimpleScheduleBuilder.repeatSecondlyForever()).build();
//3创建Scheduler(任务调度)对象 try { Scheduler scheduler= StdSchedulerFactory.getDefaultScheduler(); scheduler.scheduleJob(job,trigger); scheduler.start(); } catch (SchedulerException e) { e.printStackTrace(); }
}
运行:一秒钟打印一条
核心:
Job:一个简单的接口,只包含一个void execute(JobExecutionContext context)
抽象方法。实际开发中,通过实现该接口来定义需要执行的任务。JobExecutionContext
提供了调度上下文信息。
1
|
public interface Job {
|
JobDetail:包含多个构造函数,最常用的为JobDetail(String name, String group, Class jobClass)
jobClass为实现了Job接口的类,name为任务在Scheduler中的名称,group为任务在Scheduler中的组名。组名默认为Scheduler.DEFAULT_GROUP
。
Trigger:一个类,用于描述触发Job执行的时间规则。包含:
-
SimpleTrigger: 一次或者固定时间间隔周期的触发规则。
-
CronTrigger:通过cron表达式描述出更为复杂的触发规则。
Calendar:Quartz提供的日历类。一个Trigger可以和多个Calendar关联,以此来排除一些特殊的日期。
Scheduler:代表一个Quartz的独立运行容器,Trigger和JobDetail被注册到Scheduler中,二者在Scheduler中拥有各自的名称(name)和组名(group)。Trigger和JobDetail的名称和组名的组合必须唯一,但是Trigger的名称和组名的组合可以和JobDetail的相同,因为它们类型不同。一个Job可以绑定多个Trigger,反之不然。
Job还有一个子接口:StatefulJob,其是一个没有方法的标签接口,代表有状态的任务。
-
无状态任务:拥有JobDataMap复制,所以可以并发运行;
-
有状态任务:共享一份JobDataMap,每次对JobDataMap的修改会被保存下来。所以前次的StatefulJob会阻塞下一次的StatefulJob。
SimpleTrigger与CronTrigger
SimpleTrigger可以实现在一个指定时间段内执行一次作业任务或一个时间段内多次执行作业任务。
//5秒后开始执行job,一秒执行一次,执行5秒
Date startDate = new Date(); startDate.setTime(startDate.getTime() + 5000);
Date endDate = new Date(); endDate.setTime(startDate.getTime() + 5000);
Trigger trigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "triggerGroup1") .usingJobData("trigger1", "这是jobDetail1的trigger") .startNow()//立即生效 .startAt(startDate) .endAt(endDate) .withSchedule(SimpleScheduleBuilder.simpleSchedule() .withIntervalInSeconds(1)//每隔1s执行一次 .repeatForever()).build();//一直执行
CronTrigger功能非常强大,是基于日历的作业调度,而SimpleTrigger是精准指定间隔,所以相比SimpleTrigger,CroTrigger更加常用。CroTrigger是基于Cron表达式的,先了解下Cron表达式:
由7个子表达式组成字符串的,格式如下:
[秒] [分] [小时] [日] [月] [周] [年]
如:* 30 10 ? * 1/5 *
表示(从后往前看)
[指定年份] 的[ 周一到周五][指定月][不指定日][上午10时][30分][指定秒]
又如:00 00 00 ? * 10,11,12 1#5 2018
表示2018年10、11、12月的第一周的星期五这一天的0时0分0秒去执行任务。
在线生成Cron表达式的工具:http://cron.qqe2.com/
// 1、创建调度器Scheduler SchedulerFactory schedulerFactory = new StdSchedulerFactory(); Scheduler scheduler = schedulerFactory.getScheduler();
// 2、创建JobDetail实例,并与PrintWordsJob类绑定(Job执行内容) JobDetail jobDetail = JobBuilder.newJob(Q.class) .usingJobData("jobDetail1", "这个Job用来测试的") .withIdentity("job1", "group1").build();
// 3、构建Trigger实例,每隔1s执行一次 Date startDate = new Date(); startDate.setTime(startDate.getTime() + 5000); Date endDate = new Date(); endDate.setTime(startDate.getTime() + 5000); CronTrigger cronTrigger = TriggerBuilder.newTrigger().withIdentity("trigger1", "triggerGroup1") .usingJobData("trigger1", "这是jobDetail1的trigger") .startNow()//立即生效 .startAt(startDate) .endAt(endDate) .withSchedule(CronScheduleBuilder.cronSchedule("0/5 * * * * ?")) .build(); //4、执行 scheduler.scheduleJob(jobDetail, cronTrigger); scheduler.start();
位置 | 时间域名 | 允许值 | 允许的特殊字符 |
---|---|---|---|
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 | , - * / |
其中特殊字符的含义如下:
-
星号(*):可用在所有字段中,表示对应时间域的每一个时刻。例如,*在分钟字段时,表示“每分钟”;
-
问号(?):该字符只在日期和星期字段中使用,它通常指定为“无意义的值”,相当于点位符;
-
减号(-):表达一个范围,如在小时字段中使用“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用在星期中,则表示一个星期的最后一天(也就是星期六,国外星期第一天为周天)。但是,如果L出现在星期字段里,而且在前面有一个数值X,则表示“这个月的最后一个星期X-1”,例如,6L表示该月的最后一个星期五,5L表示该月的最后一个星期四,以此类推。
-
W:该字符只能出现在日期字段里,是对前导日期的修饰,表示离该日期最近的工作日。例如15W表示离该月15号最近的工作日,如果该月15号是星期六,则匹配14号星期五;如果15日是星期日,则匹配16号星期一;如果15号是星期二,那结果就是15号星期二。但必须注意关联的匹配日期不能够跨月,如你指定1W,如果1号是星期六,结果匹配的是3号星期一,而非上个月最后的那天;
-
LW组合:在日期字段可以组合使用LW,它的意思是当月的最后一个工作日;
-
井号(#):该字符只能在星期字段中使用,表示当月某个工作日。如6#3表示当月的第三个星期五(6表示星期五,#3表示当前的第三个),而4#5表示当月的第五个星期三,假设当月没有第五个星期三,忽略不触发;
-
C:该字符只在日期和星期字段中使用,代表“Calendar”的意思。它的意思是计划所关联的日期,如果日期没有被关联,则相当于日历中所有日期。例如5C在日期字段中就相当于日历5日以后的第一天。1C在星期字段中相当于星期日后的第一天。
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 2014-2016” | 在2014,2015,2016年每个月的最后一个星期五的10:15分运行。 |
“0 15 10 ? * 6#3” | 每月第三个星期五的10:15分运行。 |