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頻率依次執行。