Spring 3整合Quartz 2实现动态定时任务

一、 说明

     在做公司的一款产品过程中要实现定时任务功能，而且这款产品是面向不同客户的，因此具体执行的任务不固定，定时周期也不固定，所以就用到了quartz来实现这个功能。

    需要说明的是spring3.1以下的版本必须使用quartz1.x系列，3.1以上的版本才支持quartz2.x。因为org.springframework.scheduling.quartz.CronTriggerBean继承了org.quartz.CronTrigger，在quartz1.x系列中org.quartz.CronTrigger是个类，而在quartz2.x系列中org.quartz.CronTrigger变成了接口，从而造成配置quartz的触发器出错。

     最终实现的功能：

      1） 在定时任务管理功能下配置类名、方法名、表达式、分组等信息。

      2） 项目启动时，可加载已经存在的时任务，按时执行相应的逻辑 。

      3） 可添加新任务，删除任务，更新任务，暂停任务，恢复任务 。

二、 添加quartz包

    我使用的spring3.1，quartz版本是2.1.7，导入quartz-all-2.1.7.jar包即可。

三、 配置及使用

      1.  配置任务调度器 （对应的文件名为application-quartz.xml）  

       开发过程中一开始将quartz配置在spring-servlet.xml，发现定时任务总是在同一时刻重复执行两次。研究发现是因为quartz启动时加载了两次，web容器启动的时候读取applicationContext.xml文件时会加载一次，Spring本身也会加载一次。

       解决办法是把quartz配置信息提取出来，单独存成一个文件，然后修改web.xml，让web容器启动时，可以加载该文件 。这样quartz只会在web容器启动时加载一次，Spring不会再加载了。配置如下：

 <?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd"
 default-lazy-init="false">
 <!-- 调度器 -->
    <bean name="schedulerFactoryBean" class="org.springframework.scheduling.quartz.SchedulerFactoryBean"> 
       <!-- 通过applicationContextSchedulerContextKey属性配置spring上下文 -->    
        <property name="applicationContextSchedulerContextKey">    
            <value>applicationContext</value>    
        </property>   
    </bean>  
    <!--加载可执行的任务-->
    <bean id="loadTask" class="com.quartz.LoadTask" init-method="initTask" />

</beans>

    2. 服务器启动时加载，在web.xml文件里配置

<context-param>
  <param-name>contextConfigLocation</param-name>
  <param-value>classpath:application-quartz.xml</param-value>
</context-param>

   3. 加载可执行任务的类LoadTask.java

 public class LoadTask {
 public void initTask() throws Exception {
  Scheduler scheduler = schedulerFactoryBean.getScheduler();
  // 可执行的任务列表
  Collection<Task> taskList = taskService.findTask();
  for (Task task : taskList) {
   // 任务名称和任务组设置规则：
   // 名称：task_1 ..
   // 组 ：group_1 ..
   TriggerKey triggerKey = TriggerKey.triggerKey(
     "task_" + task.getId(), "group_" + task.getId());
   CronTrigger trigger = (CronTrigger) scheduler
     .getTrigger(triggerKey);
   // 不存在，创建一个
   if (null == trigger) {
    JobDetail jobDetail = JobBuilder
      .newJob(QuartzJobFactory.class)
      .withIdentity("task_" + task.getId(),
        "group_" + task.getId()).build();
    jobDetail.getJobDataMap().put("scheduleJob", task);
    // 表达式调度构建器
    CronScheduleBuilder scheduleBuilder = CronScheduleBuilder
      .cronSchedule(getCronExpression());
    // 按新的表达式构建一个新的trigger
    trigger = TriggerBuilder
      .newTrigger()
      .withIdentity("task_" + task.getId(),
        "group_" + task.getId())
      .withSchedule(scheduleBuilder).build();
    scheduler.scheduleJob(jobDetail, trigger);
   } else {
    // trigger已存在，则更新相应的定时设置
    CronScheduleBuilder scheduleBuilder = CronScheduleBuilder
      .cronSchedule(taskService.getCronExpression());
    // 按新的cronExpression表达式重新构建trigger
    trigger = trigger.getTriggerBuilder().withIdentity(triggerKey)
      .withSchedule(scheduleBuilder).build();
    // 按新的trigger重新设置job执行
    scheduler.rescheduleJob(triggerKey, trigger);
   }
  }
 }
 @Autowired
 private SchedulerFactoryBean schedulerFactoryBean;
 @Autowired
 private  TaskService taskService;
}

   4. 调度任务的入口

 public class QuartzTaskFactory implements Job {

 @Override
 public void execute(JobExecutionContext context)
   throws JobExecutionException {
  // TODO Auto-generated method stub
  try {
   System.out.println("任务运行...");
   Task task = (Task) context.getMergedJobDataMap().get(
     "scheduleJob");
   System.out.println("任务名称: [" + task.getTaskName() + "]");
   //在这里执行你的任务...
   } catch (Exception e) {
   e.printStackTrace();
  }
 }
}

     测试过程中发现同一时刻执行相似的定时任务时数据或发生混乱，加上注解@PersistJobDataAfterExecution和@DisallowConcurrentExecution可解决此并发问题。

     @DisallowConcurrentExecution： 禁止并发执行多个相同定义的JobDetail, 这个注解是加在Job类上的,但意思并不是不能同时执行多个Job, 而是不能并发执行同一个Job Definition(由JobDetail定义),但是可以同时执行多个不同的JobDetail, 举例说明,我们有一个Job类,叫做SayHelloJob, 并在这个Job上加了这个注解,然后在这个Job上定义了很多个JobDetail, 如sayHelloToJoeJobDetail,sayHelloToMikeJobDetail, 那么当scheduler启动时,不会并发执行多个sayHelloToJoeJobDetail或者sayHelloToMikeJobDetail,但可以同时执行sayHelloToJoeJobDetail跟sayHelloToMikeJobDetail。

     @PersistJobDataAfterExecution：同样, 也是加在Job上,表示当正常执行完Job后,JobDataMap中的数据应该被改动, 以被下一次调用时用。当使用@PersistJobDataAfterExecution 注解时, 为了避免并发时, 存储数据造成混乱, 强烈建议把@DisallowConcurrentExecution注解也加上。

   5. 暂停任务

Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
scheduler.pauseJob(jobKey);

   6. 恢复任务

Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
scheduler.resumeJob(jobKey);

  7. 删除任务

Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
scheduler.deleteJob(jobKey);

   8. 立即运行任务

Scheduler scheduler = schedulerFactoryBean.getScheduler();
JobKey jobKey = JobKey.jobKey(scheduleJob.getJobName(), scheduleJob.getJobGroup());
scheduler.triggerJob(jobKey);

   9. 更新任务（时间表达式）

Scheduler scheduler = schedulerFactoryBean.getScheduler();

TriggerKey triggerKey = TriggerKey.triggerKey(scheduleJob.getJobName(),
scheduleJob.getJobGroup());

//获取trigger，即在spring配置文件中定义的 bean id="myTrigger"
CronTrigger trigger = (CronTrigger) scheduler.getTrigger(triggerKey);

//表达式调度构建器
CronScheduleBuilder scheduleBuilder = CronScheduleBuilder.cronSchedule(scheduleJob
.getCronExpression());

//按新的cronExpression表达式重新构建trigger
trigger = trigger.getTriggerBuilder().withIdentity(triggerKey)
.withSchedule(scheduleBuilder).build();

//按新的trigger重新设置job执行
scheduler.rescheduleJob(triggerKey, trigger);

    测试过程中发现定时任务修改cron表达式后会立即执行一次，研究发现这是quartz管理器默认设置。在调度构建器时加上withMisfireHandlingInstructionDoNothing()方法即可。修改后代码如下：

CronScheduleBuilder.cronSchedule(scheduleJob.getJobExpression()).withMisfireHandlingInstructionDoNothing()

    withMisfireHandlingInstructionDoNothing()：不触发立即执行；等待下次Cron触发频率到达时刻开始按照Cron频率依次执行 。

    withMisfireHandlingInstructionIgnoreMisfires()：以错过的第一个频率时间立刻开始执行；重做错过的所有频率周期后，当下一次触发频率发生时间大于当前时间后，再按照正常的Cron频率依次执行。

    withMisfireHandlingInstructionFireAndProceed()：以当前时间为触发频率立刻触发一次执行；然后按照Cron频率依次执行。