Quartz基础+实例

1. 介绍

Quartz体系结构：

明白Quartz怎么用，首先要了解Scheduler(调度器)、Job(任务)和Trigger(触发器)这3个核心的概念。

1. Job：是一个接口，只定义一个方法execute(JobExecutionContext context)，在实现接口的execute方法中编写所需要定时执行的Job(任务)， JobExecutionContext类提供了调度应用的一些信息。Job运行时的信息保存在JobDataMap实例中；

2. JobDetail： Quartz每次调度Job时，都重新创建一个Job实例，所以它不直接接受一个Job的实例，相反它接收一个Job实现类(JobDetail:描述Job的实现类及其它相关的静态信息，如Job名字、描述、关联监听器等信息)，以便运行时通过newInstance()的反射机制实例化Job。

3. Trigger：是一个类，描述触发Job执行的时间触发规则。主要有SimpleTrigger和CronTrigger这两个子类。当且仅当需调度一次或者以固定时间间隔周期执行调度，SimpleTrigger是最适合的选择；而CronTrigger则可以通过Cron表达式定义出各种复杂时间规则的调度方案：如工作日周一到周五的15：00~16：00执行调度等；

Cron表达式的格式：秒分时日月周年(可选)。
字段名允许的值允许的特殊字符
秒 0-59 , - * /
分 0-59 , - * /
小时 0-23 , - * /
日 1-31 , - * ? / L W C
月 1-12 or JAN-DEC , - * /
周几 1-7 or SUN-SAT , - * ? / L C # SUN, MON, TUE, WED, THU, FRI and SAT
年 (可选字段) empty, 1970-2099 , - * /

“?”字符：表示不确定的值
“,”字符：指定数个值
“-”字符：指定一个值的范围
“/”字符：指定一个值的增加幅度。n/m表示从n开始，每次增加m
“L”字符：用在日表示一个月中的最后一天，用在周表示该月最后一个星期X

“W”字符：指定离给定日期最近的工作日(周一到周五)
“#”字符：表示该月第几个周X。6#3表示该月第3个周五

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 * * ?

4. Calendar：org.quartz.Calendar和java.util.Calendar不同，它是一些日历特定时间点的集合（可以简单地将org.quartz.Calendar看作java.util.Calendar的集合——java.util.Calendar代表一个日历时间点，无特殊说明后面的Calendar即指org.quartz.Calendar）。一个Trigger可以和多个Calendar关联，以便排除或包含某些时间点。

　　假设，我们安排每周星期一早上10:00执行任务，但是如果碰到法定的节日，任务则不执行，这时就需要在Trigger触发机制的基础上使用Calendar进行定点排除。针对不同时间段类型，Quartz在org.quartz.impl.calendar包下提供了若干个Calendar的实现类，如AnnualCalendar、MonthlyCalendar、WeeklyCalendar分别针对每年、每月和每周进行定义；

5. Scheduler：代表一个Quartz的独立运行容器， Trigger和JobDetail可以注册到Scheduler中，两者在Scheduler中拥有各自的组及名称，组及名称是Scheduler查找定位容器中某一对象的依据， Trigger的组及名称必须唯一， JobDetail的组和名称也必须唯一（但可以和Trigger的组和名称相同，因为它们是不同类型的）。Scheduler定义了多个接口方法，允许外部通过组及名称访问和控制容器中Trigger和JobDetail。

　　Scheduler可以将Trigger绑定到某一JobDetail中，这样当Trigger触发时，对应的Job就被执行。一个Job可以对应多个Trigger，但一个Trigger只能对应一个Job。可以通过SchedulerFactory创建一个Scheduler实例。Scheduler拥有一个SchedulerContext，它类似于ServletContext，保存着Scheduler上下文信息，Job和Trigger都可以访问SchedulerContext内的信息。SchedulerContext内部通过一个Map，以键值对的方式维护这些上下文数据，SchedulerContext为保存和获取数据提供了多个put()和getXxx()的方法。可以通过Scheduler# getContext()获取对应的SchedulerContext实例；

6. ThreadPool： Scheduler使用一个线程池作为任务运行的基础设施，任务通过共享线程池中的线程提高运行效率。
　　Job有一个StatefulJob子接口，代表有状态的任务，该接口是一个没有方法的标签接口，其目的是让Quartz知道任务的类型，以便采用不同的执行方案。无状态任务在执行时拥有自己的JobDataMap拷贝，对JobDataMap的更改不会影响下次的执行。而有状态任务共享共享同一个JobDataMap实例，每次任务执行对JobDataMap所做的更改会保存下来，后面的执行可以看到这个更改，也即每次执行任务后都会对后面的执行发生影响。
　　正因为这个原因，无状态的Job可以并发执行，而有状态的StatefulJob不能并发执行，这意味着如果前次的StatefulJob还没有执行完毕，下一次的任务将阻塞等待，直到前次任务执行完毕。有状态任务比无状态任务需要考虑更多的因素，程序往往拥有更高的复杂度，因此除非必要，应该尽量使用无状态的Job。
　　如果Quartz使用了数据库持久化任务调度信息，无状态的JobDataMap仅会在Scheduler注册任务时保持一次，而有状态任务对应的JobDataMap在每次执行任务后都会进行保存。
Trigger自身也可以拥有一个JobDataMap，其关联的Job可以通过JobExecutionContext#getTrigger().getJobDataMap()获取Trigger中的JobDataMap。不管是有状态还是无状态的任务，在任务执行期间对Trigger的JobDataMap所做的更改都不会进行持久，也即不会对下次的执行产生影响。

　　Quartz拥有完善的事件和监听体系，大部分组件都拥有事件，如任务执行前事件、任务执行后事件、触发器触发前事件、触发后事件、调度器开始事件、关闭事件等等，可以注册相应的监听器处理感兴趣的事件。

　　下图描述了Scheduler的内部组件结构，SchedulerContext提供Scheduler全局可见的上下文信息，每一个任务都对应一个JobDataMap，虚线表达的JobDataMap表示对应有状态的任务：

2. 创建简单的定时任务

使用Quartz需要导入jar包：

1 <dependency>
2     <groupId>org.quartz-scheduler</groupId>
3     <artifactId>quartz</artifactId>
4     <version>2.2.3</version>
5 </dependency>

2.1创建工作类

创建一个工作类，需要实现Job接口

 1 public class HelloQuartz implements Job {
 2     //执行
 3     public void execute(JobExecutionContext context) throws JobExecutionException {
 4         //创建工作详情
 5         JobDetail detail=context.getJobDetail();
 6         //获取工作的名称
 7         String name=detail.getJobDataMap().getString("name");
 8         String job=detail.getKey().getGroup();
 9         System.out.println("任务调度：组："+job+",工作名："+name+"---->今日整点抢购，不容错过！");
10     }
11 }

2.2测试任务调度

 1 public class QuartzTest {
 2     public static void main(String[] args) {
 3         try{
 4             //创建scheduler，执行计划
 5             Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
 6             //定义一个Trigger,触发条件类
 7             Trigger trigger = TriggerBuilder.newTrigger().
 8                     withIdentity("trigger1", "group1") //定义name/group
 9                     .startNow()//一旦加入scheduler，立即生效
10                     .withSchedule(SimpleScheduleBuilder.simpleSchedule() //使用SimpleTrigger
11                             .withIntervalInSeconds(1) //每隔一秒执行一次
12                             .repeatForever()) //一直执行，奔腾到老不停歇
13                     .build();
14             //定义一个JobDetail
15             JobDetail job = JobBuilder.newJob(HelloQuartz.class) //定义Job类为HelloQuartz类，这是真正的执行逻辑所在
16                     .withIdentity("job1", "group1") //定义name/group
17                     .usingJobData("name", "quartz") //定义属性
18                     .build();
19             //加入这个调度
20             scheduler.scheduleJob(job, trigger);
21             //启动任务调度
22             scheduler.start();
23         }catch (Exception ex){
24             ex.printStackTrace();
25         }
26     }
27 }

3. 动态操作任务

3.1新建任务类

1 public class MyJob implements Job {
2     private static int counter = 1;
3 
4     public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
5         System.out.println("(第 " + counter + " 次,预告通知)");
6         counter++;
7     }
8 }

3.2编写任务工具类

  1 public class QuartzManager {
  2 
  3     private static SchedulerFactory schedulerFactory = new StdSchedulerFactory();
  4 
  5     /**
  6      * @Description: 添加一个定时任务
  7      *
  8      * @param jobName 任务名
  9      * @param jobGroupName  任务组名
 10      * @param triggerName 触发器名
 11      * @param triggerGroupName 触发器组名
 12      * @param jobClass  任务
 13      * @param cron   时间设置，参考quartz说明文档
 14     */
 15 @SuppressWarnings({ "unchecked", "rawtypes" })
 16     public static void addJob(String jobName, String jobGroupName,
 17                               String triggerName, String triggerGroupName, Class jobClass, String cron) {
 18         try {
 19             Scheduler sched = schedulerFactory.getScheduler();
 20             // 任务名，任务组，任务执行类
 21             JobDetail jobDetail= JobBuilder.newJob(jobClass).withIdentity(jobName, jobGroupName).build();
 22             // 触发器
 23             TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger();
 24             // 触发器名,触发器组
 25             triggerBuilder.withIdentity(triggerName, triggerGroupName);
 26             triggerBuilder.startNow();
 27             // 触发器时间设定
 28             triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(cron));
 29             // 创建Trigger对象
 30             CronTrigger trigger = (CronTrigger) triggerBuilder.build();
 31             // 调度容器设置JobDetail和Trigger
 32             sched.scheduleJob(jobDetail, trigger);
 33             // 启动
 34             if (!sched.isShutdown()) {
 35                 sched.start();
 36             }
 37         } catch (Exception e) {
 38             throw new RuntimeException(e);
 39         }
 40         
 41     }
 42 /**
 43      * @Description: 修改一个任务的触发时间
 44      *
 45      * @param jobName
 46      * @param jobGroupName
 47      * @param triggerName 触发器名
 48      * @param triggerGroupName 触发器组名
 49      * @param cron   时间设置，参考quartz说明文档
 50      */
 51     public static void modifyJobTime(String jobName,
 52                                      String jobGroupName, String triggerName, String triggerGroupName, String cron) {
 53         try {
 54 Scheduler sched = schedulerFactory.getScheduler();
 55             TriggerKey triggerKey = TriggerKey.triggerKey(triggerName, triggerGroupName);
 56             CronTrigger trigger = (CronTrigger) sched.getTrigger(triggerKey);
 57             if (trigger == null) {
 58                 return;
 59             }
 60 
 61             String oldTime = trigger.getCronExpression();
 62             if (!oldTime.equalsIgnoreCase(cron)) {
 63                 /** 方式一 ：调用 rescheduleJob 开始 */
 64                 // 触发器
 65                 TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger();
 66                 // 触发器名,触发器组
 67                 triggerBuilder.withIdentity(triggerName, triggerGroupName);
 68                 triggerBuilder.startNow();
 69                 // 触发器时间设定
 70                 triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(cron));
 71                 // 创建Trigger对象
 72                 trigger = (CronTrigger) triggerBuilder.build();
 73                 // 方式一 ：修改一个任务的触发时间
 74                 sched.rescheduleJob(triggerKey, trigger);
 75                 /** 方式一 ：调用 rescheduleJob 结束 */
 76                 /** 方式二：先删除，然后在创建一个新的Job  */
 77                 //JobDetail jobDetail = sched.getJobDetail(JobKey.jobKey(jobName, jobGroupName));
 78                 //Class<? extends Job> jobClass = jobDetail.getJobClass();
 79                 //removeJob(jobName, jobGroupName, triggerName, triggerGroupName);
 80                 //addJob(jobName, jobGroupName, triggerName, triggerGroupName, jobClass, cron);
 81             }
 82         } catch (Exception e) {
 83             throw new RuntimeException(e);
 84         }
 85     }
 86 
 87     /**
 88      * @Description: 移除一个任务
 89      *
 90      * @param jobName
 91      * @param jobGroupName
 92      * @param triggerName
 93      * @param triggerGroupName
 94  */
 95     public static void removeJob(String jobName, String jobGroupName,
 96                                  String triggerName, String triggerGroupName) {
 97         try {
 98             Scheduler sched = schedulerFactory.getScheduler();
 99             TriggerKey triggerKey = TriggerKey.triggerKey(triggerName, triggerGroupName);
100             sched.pauseTrigger(triggerKey);// 停止触发器
101             sched.unscheduleJob(triggerKey);// 移除触发器
102             sched.deleteJob(JobKey.jobKey(jobName, jobGroupName));// 删除任务
103         } catch (Exception e) {
104             throw new RuntimeException(e);
105         }
106     }
107 
108     /**
109      * @Description:启动所有定时任务
110      */
111     public static void startJobs() {
112         try {
113             Scheduler sched = schedulerFactory.getScheduler();
114             sched.start();
115         } catch (Exception e) {
116             throw new RuntimeException(e);
117         }
118     }
119 
120     /**
121      * @Description:关闭所有定时任务
122      */
123     public static void shutdownJobs() {
124         try {
125             Scheduler sched = schedulerFactory.getScheduler();
126             if (!sched.isShutdown()) {
127                 sched.shutdown();
128             }
129         } catch (Exception e) {
130             throw new RuntimeException(e);
131         }
132     }
133 }

3.3测试类

 1 public class SimpleTest {
 2     public static String JOB_NAME = "动态任务调度";
 3     public static String TRIGGER_NAME = "动态任务触发器";
 4     public static String JOB_GROUP_NAME = "XLXXCC_JOB_GROUP";
 5     public static String TRIGGER_GROUP_NAME = "XLXXCC_JOB_GROUP";
 6 
 7     public static void main(String[] args) {
 8         try {
 9             System.out.println("【系统启动】开始(每1秒输出一次)...");
10             QuartzManager.addJob(JOB_NAME, JOB_GROUP_NAME, TRIGGER_NAME, TRIGGER_GROUP_NAME, MyJob.class, "0/1 * * * * ?");
11 
12             Thread.sleep(5000);
13             System.out.println("【修改时间】开始(每5秒输出一次)...");
14             QuartzManager.modifyJobTime(JOB_NAME, JOB_GROUP_NAME, TRIGGER_NAME, TRIGGER_GROUP_NAME, "0/5 * * * * ?");
15 
16             Thread.sleep(6000);
17             System.out.println("【移除定时】开始...");
18             QuartzManager.removeJob(JOB_NAME, JOB_GROUP_NAME, TRIGGER_NAME, TRIGGER_GROUP_NAME);
19             System.out.println("【移除定时】成功");
20         } catch (Exception e) {
21             e.printStackTrace();
22         }
23     }
24 }

4. Spring整合Quartz

导入Spring核心包：

 1 <dependency>
 2     <groupId>org.springframework</groupId>
 3     <artifactId>spring-context</artifactId>
 4     <version>4.3.11.RELEASE</version>
 5 </dependency>
 6 <dependency>
 7     <groupId>org.springframework</groupId>
 8     <artifactId>spring-context-support</artifactId>
 9     <version>4.3.11.RELEASE</version>
10 </dependency>
11 <dependency>
12     <groupId>org.springframework</groupId>
13     <artifactId>spring-tx</artifactId>
14     <version>4.3.11.RELEASE</version>
15 </dependency>

4.1 创建工作类

1 public class MyJob implements Job {
2     private static int counter = 1;
3     public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
4         System.out.println("(第 " + counter + " 次,预告通知)");
5         counter++;
6     }
7 }

4.2Spring配置文件

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <beans xmlns="http://www.springframework.org/schema/beans"
 3        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 4        xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
 5     <!--
 6            Spring整合Quartz进行配置遵循下面的步骤：
 7            1：定义工作任务的Job
 8            2：定义触发器Trigger，并将触发器与工作任务绑定
 9            3：定义调度器，并将Trigger注册到Scheduler
10 -->
11 
12     <!-- 1：定义任务的bean ，这里使用JobDetailFactoryBean,也可以使用MethodInvokingJobDetailFactoryBean ，配置类似-->
13     <bean name="myJob" class="org.springframework.scheduling.quartz.JobDetailFactoryBean">
14         <!-- 指定job的名称 -->
15         <property name="name" value="job1"/>
16         <!-- 指定job的分组 -->
17         <property name="group" value="group1"/>
18         <!-- 指定具体的job类 -->
19         <property name="jobClass" value="spring.MyJob"/>
20         <!-- 必须设置为true，如果为false，当没有活动的触发器与之关联时会在调度器中会删除该任务  -->
21         <property name="durability" value="true"/>
22         <!-- 指定spring容器的key，如果不设定在job中的jobmap中是获取不到spring容器的 -->
23         <property name="applicationContextJobDataKey" value="applicationContext"/>
24     </bean>
25 
26     <!-- 2.2：定义触发器的bean，定义一个Cron的Trigger，一个触发器只能和一个任务进行绑定 -->
27     <bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
28         <!-- 指定Trigger的名称 -->
29         <property name="name" value="my_trigger"/>
30         <!-- 指定Trigger的名称 -->
31         <property name="group" value="my_trigger_group"/>
32         <!-- 指定Tirgger绑定的Job -->
33         <property name="jobDetail" ref="myJob"/>
34         <!-- 指定Cron 的表达式 ，当前是每隔5s运行一次 -->
35         <property name="cronExpression" value="0/5 * * * * ?" />
36     </bean>
37 
38     <!-- 3.定义调度器，并将Trigger注册到调度器中 -->
39     <bean id="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
40         <property name="triggers">
41             <list>
42                 <ref bean="cronTrigger"/>
43             </list>
44         </property>
45         <property name="autoStartup" value="false" />
46     </bean>
47 </beans>

4.3测试代码

 1 public class SpringTest {
 2     public static void main(String[] args) throws Exception {
 3         ApplicationContext applicationContext =
 4                 new ClassPathXmlApplicationContext("spring-quartz.xml");
 5         StdScheduler scheduler =
 6                 (StdScheduler) applicationContext.getBean("scheduler");
 7         scheduler.start();
 8         System.in.read();
 9     }
10 }