Quartz在Spring中動態設定cronExpression （spring設定動態定時任務）

　　　　2007-07-25 13:52

　　　　什麼是動態定時任務：是由客戶制定生成的，服務端只知道該去執行什麼任務，但任務的定時是不確定的（是由客戶制定）。

　　　　這樣總不能修改配置檔案每定製個定時任務就增加一個trigger吧，即便允許客戶修改配置檔案，但總需要重新啟動web服務啊，研究了下Quartz在Spring中的動態定時，發現

　　　　<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean" >

          　　　　　　　　<property name="jobDetail" ref="schedulerJobDetail"/>
          　　　　　　　　<property name="cronExpression">
              　　　　　　　　　　　　<value>0/10 * * * * ?</value>
          　　　　　　　　</property>
　　　　</bean>
     　　　　中cronExpression是關鍵，如果可以動態設定cronExpression的值，也就說如果我們可以直接呼叫CronTriggerBean中設定cronExpression的方法，就可以順利解決問題了。
　　　　熟悉1的朋友可以跳過不看，下面2、3是動態定時任務的具體實現。
　　　　1、Quartz在Spring中的簡單配置

　　　　Spring配置檔案：

     　　　　<bean id="schedulerJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
         　　　　　　　　<property name="targetObject" ref="scheduleInfoAction"/>
         　　　　　　　　<property name="targetMethod" value="simpleJobTest"/>
         　　　　　　　　<property name="concurrent" value="false"/>
     　　　　</bean>
     　　　　<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean" >
          　　　　　　　　<property name="jobDetail" ref="schedulerJobDetail"/>
          　　　　　　　　<property name="cronExpression">
              　　　　　　　　　　　　<value>0/10 * * * * ?</value>
          　　　　　　　　</property>
      　　　　</bean>
     　　　　<bean id="schedulerFactory" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
         　　　　　　　　<property name="triggers">
             　　　　　　　　　　　　<list>
                 　　　　　　　　　　　　　　　　<ref local="cronTrigger"/>
             　　　　　　　　　　　　</list>
         　　　　　　　　</property>
　　　　</bean>
　　　　在上面的配置中設定了
　　　　① targetMethod: 指定需要定時執行scheduleInfoAction中的simpleJobTest()方法
　　　　② concurrent：對於相同的JobDetail，當指定多個Trigger時, 很可能第一個job完成之前，第二個job就開始了。指定concurrent設為false，多個job不會併發執行，第二個job將不會在第一個job完成之前開始。
　　　　③ cronExpression：0/10 * * * * ?表示每10秒執行一次，具體可參考附表。
　　　　④ triggers：通過再新增其他的ref元素可在list中放置多個觸發器。
　　　　scheduleInfoAction中的simpleJobTest()方法，注意：此方法沒有引數，如果scheduleInfoAction有兩個方法simpleJobTest()和simpleJobTest(String argument)，則spring只會去執行無參的simpleJobTest().
　　　　public void simpleJobTest()
　　　　{
         　　　　　　　　log.warn("uh oh, Job is scheduled !'" + "' Success...");
     　　　　}

　　　　2．Quartz在Spring中動態設定cronTrigger方法一
　　　　Spring配置檔案：
　　　　<bean id="scheduleInfoAction" class="com.lively.happyoa.jobs.webapp.action.ScheduleInfoAction">
         　　　　　　　　<property name="scheduler" ref="schedulerFactory"/>
         　　　　　　　　<property name="scheduleInfoManager" ref="scheduleInfoManager"/>
     　　　　</bean>
     　　　　<bean id="schedulerJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
         　　　　　　　　<property name="targetObject" ref="scheduleInfoAction"/>
         　　　　　　　　<property name="targetMethod" value="reScheduleJob"/>
         　　　　　　　　<property name="concurrent" value="false"/>
     　　　　</bean>
     　　　　<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean" >
          　　　　　　　　<property name="jobDetail" ref="schedulerJobDetail"/>
          　　　　　　　　<property name="cronExpression">
              　　　　　　　　　　　　<value>0/10 * * * * ?</value>
          　　　　　　　　</property>
      　　　　</bean>
     　　　　<bean id="schedulerFactory" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
         　　　　　　　　<property name="triggers">
             　　　　　　　　　　　　<list>
                 　　　　　　　　　　　　　　　　<ref local="cronTrigger"/>
             　　　　　　　　　　　　</list>
　　　　　　　　</property>
　　　　</bean>
　　　　scheduleInfoAction中的reScheduleJob ()方法及相關方法
　　　　① reScheduleJob讀取資料庫，獲得自定義定時器排程時間():
     　　　　private void reScheduleJob() throws SchedulerException, ParseException
　　　　{
         　　　　　　　　// 執行時可通過動態注入的scheduler得到trigger
         　　　　　　　　CronTriggerBean trigger = (CronTriggerBean) scheduler.getTrigger("cronTrigger", Scheduler.DEFAULT_GROUP);
         　　　　　　　　String dbCronExpression = getCronExpressionFromDB();
         　　　　　　　　String originConExpression = trigger.getCronExpression();
     　　　　　　　　// 判斷從DB中取得的任務時間(dbCronExpression)和現在的quartz執行緒中的任務時間(originConExpression)是否相等
     　　　　　　　　// 如果相等，則表示使用者並沒有重新設定資料庫中的任務時間，這種情況不需要重新rescheduleJob
         　　　　　　　　if(!originConExpression.equalsIgnoreCase(dbCronExpression))
　　　　　　　　{
             　　　　　　　　　　　　trigger.setCronExpression(dbCronExpression);
             　　　　　　　　　　　　scheduler.rescheduleJob("cronTrigger", Scheduler.DEFAULT_GROUP, trigger);
         　　　　　　　　}
     　　　　　　　　// 下面是具體的job內容，可自行設定
     　　　　　　　　// executeJobDetail();
　　　　}
　　　　② getCronExpressionFromDB()：從資料庫中獲得dbCronExpression的具體程式碼，由於使用了scheduleInfoManager，所以要在定義相應的setter方法
     　　　　private String getCronExpressionFromDB()
　　　　{
         　　　　　　　　String sql="from ScheduleInfo scheduleInfo where 1=1 ";
         　　　　　　　　sql=sql+" and scheduleInfo.infoId = '"+"1" + "'";
         　　　　　　　　List scheduleList = scheduleInfoManager.queryScheduleInListBySql(sql);
         　　　　　　　　ScheduleInfo scheduleInfo = (ScheduleInfo)scheduleList.get(0);
         　　　　　　　　String dbCronExpression = scheduleInfo.getCronExpression();
         　　　　　　　　return dbCronExpression;
　　　　}
　　　　③ 在spring配置檔案的scheduleInfoAction配置了相應的property（scheduler/ scheduleInfoManager）,要為其設定setter方法
     　　　　private Scheduler scheduler;
     　　　　// 設值注入，通過setter方法傳入被呼叫者的例項scheduler
     　　　　public void setScheduler(Scheduler scheduler)
　　　　{
         　　　　　　　　this.scheduler = scheduler;
    　　　　}
     　　　　private ScheduleInfoManager scheduleInfoManager;
     　　　　// 設值注入，通過setter方法傳入被呼叫者的例項scheduleInfoManager
     　　　　public void setScheduleInfoManager(ScheduleInfoManager scheduleInfoManager)
　　　　{
         　　　　　　　　this.scheduleInfoManager = scheduleInfoManager;
     　　　　}

　　　　3． Quartz在Spring中動態設定cronTrigger方法二
　　　　在上面的2中我們可以看到，儘管已經可以動態進行rescheduleJob了，不過依然需要我們設定一個cronExpression，如果嘗試一下拿掉spring配置中的
         　　　　<property name="cronExpression">
              　　　　　　　　<value>0/10 * * * * ?</value>
          　　　　</property>
　　　　則容器（如tomcat）啟動時會報錯。
　　　　實際中我們希望tomcat啟動時就可以直接去讀資料庫，拿到相應的dbCronExpression，然後定時執行一個job，而不希望配置初始的cronExpression ，觀察下面的CronTriggerBean，考慮到cronExpression需要初始化，如果設定一個類InitializingCronTrigger繼承CronTriggerBean，然後在這個類中做一些讀取DB的初始化工作（設定cronExpression），問題就可以解決了。
　　　　Spring配置檔案：
　　　　<bean id="scheduleInfoAction" class="com.lively.happyoa.jobs.webapp.action.ScheduleInfoAction">
         　　　　　　　　<property name="scheduler" ref="schedulerFactory"/>
         　　　　　　　　<property name="scheduleInfoManager" ref="scheduleInfoManager"/>
     　　　　</bean>
     　　　　<bean id="schedulerJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
         　　　　　　　　<property name="targetObject" ref="scheduleInfoAction"/>
         　　　　　　　　<property name="targetMethod" value="reScheduleJob"/>
         　　　　　　　　<property name="concurrent" value="false"/>
     　　　　</bean>
    　　　　<bean id="cronTrigger" class="com.lively.happyoa.jobs.webapp.action.ScheduleInfoAction.InitializingCronTrigger">
          　　　　　　　　<property name="jobDetail" ref="schedulerJobDetail"/>
         　　　　　　　　<!--<property name="cronExpression">
              　　　　　　　　　　　　<value>0/10 * * * * ?</value>
          　　　　　　　　</property>-->
          　　　　　　　　<property name="scheduleInfoManager" ref="scheduleInfoManager"/>
      　　　　</bean>
     　　　　<bean id="schedulerFactory" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
         　　　　　　　　<property name="triggers">
             　　　　　　　　　　　　<list>
                 　　　　　　　　　　　　　　　　<ref local="cronTrigger"/>
             　　　　　　　　　　　　</list>
         　　　　　　　　</property>
　　　　</bean>
　　　　InitializingCronTrigger中的相關方法
　　　　注意：在注入scheduleInfoManager屬性的時候，我們可以去讀取DB任務時間（之所以放在setter方法中，是因為需要在設定scheduleInfoManager後進行getCronExpressionFromDB()，否則，也可以①②邏輯把放在類的建構函式中）.
　　　　注意InitializingCronTrigger必須extends CronTriggerBean.
　　　　public class InitializingCronTrigger extends CronTriggerBean implements Serializable
　　　　{
     　　　　　　　　private ScheduleInfoManager scheduleInfoManager;
     　　　　　　　　// 設值注入，通過setter方法傳入被呼叫者的例項scheduleInfoManager
     　　　　　　　　public void setScheduleInfoManager(ScheduleInfoManager scheduleInfoManager)
　　　　　　　　{
         　　　　　　　　　　　　this.scheduleInfoManager = scheduleInfoManager;
         　　　　　　　　　　　　// 因為在getCronExpressionFromDB使用到了scheduleInfoManager，所以
         　　　　　　　　　　　　// 必須上一行程式碼設定scheduleInfoManager後進行getCronExpressionFromDB
         　　　　　　　　　　　　String cronExpression = getCronExpressionFromDB ();    // ①
         　　　　　　　　　　　　// 因為extends CronTriggerBean ，此處呼叫父類方法初始化cronExpression
        　　　　　　　　　　　　setCronExpression(cronExpression);                     // ②
　　　　　　　　}

     　　　　　　　　private String getCronExpressionFromDB()
　　　　　　　　{
         　　　　　　　　　　　　String sql="from ScheduleInfo scheduleInfo where 1=1 ";
         　　　　　　　　　　　　sql=sql+" and scheduleInfo.infoId = '"+"1" + "'";
         　　　　　　　　　　　　List scheduleList = scheduleInfoManager.queryScheduleInListBySql(sql);
         　　　　　　　　　　　　ScheduleInfo scheduleInfo = (ScheduleInfo)scheduleList.get(0);
         　　　　　　　　　　　　String dbCronExpression = scheduleInfo.getCronExpression();
         　　　　　　　　　　　　return dbCronExpression;
　　　　　　　　}
　　　　　　　　……
　　　　}
各個時間可用值如下：

秒 0-59 , - * /

分 0-59 , - * /

小時 0-23 , - * /

日 1-31 , - * ? / L W C

月 1-12 or JAN-DEC , - * /

周幾 1-7 or SUN-SAT , - * ? / L C #

年 (可選欄位) empty, 1970-2099 , - * /

可用值詳細分析如下：

“*”——字元可以用於所有欄位，在“分”欄位中設為"*"表示"每一分鐘"的含義。

“?”——字元可以用在“日”和“周幾”欄位. 它用來指定 '不明確的值'. 這在你需要指定這兩個欄位中的某一個值而不是另外一個的時候會被用到。在後面的例子中可以看到其含義。

“-”——字元被用來指定一個值的範圍，比如在“小時”欄位中設為"10-12"表示"10點到12點"。

“,”——字元指定數個值。比如在“周幾”欄位中設為"MON,WED,FRI"表示"the days Monday, Wednesday, and Friday"。

“/”——字元用來指定一個值的的增加幅度. 比如在“秒”欄位中設定為"0/15"表示"第0, 15, 30, 和 45秒"。而 "5/15"則表示"第5, 20, 35, 和 50". 在'/'前加"*"字元相當於指定從0秒開始. 每個欄位都有一系列可以開始或結束的數值。對於“秒”和“分”欄位來說，其數值範圍為0到59，對於“小時”欄位來說其為0到23, 對於“日”欄位來說為0到31, 而對於“月”欄位來說為1到12。"/"欄位僅僅只是幫助你在允許的數值範圍內從開始"第n"的值。

“L”——字元可用在“日”和“周幾”這兩個欄位。它是"last"的縮寫, 但是在這兩個欄位中有不同的含義。例如,“日”欄位中的"L"表示"一個月中的最後一天" —— 對於一月就是31號對於二月來說就是28號（非閏年）。而在“周幾”欄位中, 它簡單的表示"7" or "SAT"，但是如果在“周幾”欄位中使用時跟在某個數字之後, 它表示"該月最後一個星期×" —— 比如"6L"表示"該月最後一個週五"。當使用'L'選項時,指定確定的列表或者範圍非常重要，否則你會被結果搞糊塗的。

“W”——可用於“日”欄位。用來指定歷給定日期最近的工作日(週一到週五) 。比如你將“日”欄位設為"15W"，意為: "離該月15號最近的工作日"。因此如果15號為週六，觸發器會在14號即週五呼叫。如果15號為週日, 觸發器會在16號也就是週一觸發。如果15號為週二,那麼當天就會觸發。然而如果你將“日”欄位設為"1W", 而一號又是週六, 觸發器會於下週一也就是當月的3號觸發,因為它不會越過當月的值的範圍邊界。'W'字元只能用於“日”欄位的值為單獨的一天而不是一系列值的時候。

“L”和“W”可以組合用於“日”欄位表示為'LW'，意為"該月最後一個工作日"。

“#”—— 字元可用於“周幾”欄位。該字元表示“該月第幾個周×”，比如"6#3"表示該月第三個週五( 6表示週五而"#3"該月第三個)。再比如: "2#1" = 表示該月第一個週一而 "4#5" = 該月第五個週三。注意如果你指定"#5"該月沒有第五個“周×”，該月是不會觸發的。

“C”—— 字元可用於“日”和“周幾”欄位，它是"calendar"的縮寫。 它表示為基於相關的日曆所計算出的值（如果有的話）。如果沒有關聯的日曆, 那它等同於包含全部日曆。“日”欄位值為"5C"表示"日曆中的第一天或者5號以後"，“周幾”欄位值為"1C"則表示"日曆中的第一天或者週日以後"。

對於“月份”欄位和“周幾”欄位來說合法的字元都不是大小寫敏感的。

附表：
"0 0 12 * * ?" 每天中午12點觸發
"0 15 10 ? * *" 每天上午10:15觸發
"0 15 10 * * ?" 每天上午10:15觸發
"0 15 10 * * ? *" 每天上午10:15觸發
"0 15 10 * * ? 2005" 2005年的每天上午10:15觸發
"0 * 14 * * ?" 在每天下午2點到下午2:59期間的每1分鐘觸發
"0 0/5 14 * * ?" 在每天下午2點到下午2:55期間的每5分鐘觸發
"0 0/5 14,18 * * ?" 在每天下午2點到2:55期間和下午6點到6:55期間的每5分鐘觸發
"0 0-5 14 * * ?" 在每天下午2點到下午2:05期間的每1分鐘觸發
"0 10,44 14 ? 3 WED" 每年三月的星期三的下午2:10和2: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 2002-2005" 2002年至2005年的每月的最後一個星期五上午10:15觸發
"0 15 10 ? * 6#3" 每月的第三個星期五上午10:15觸發
至於每個符號 看看例子就好了.很簡單了.

作者“信仰的力量”