Spring定時器時間配置 – JAVA編程語言程序開發技術文章

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觸發
至於每個符號 看看例子就好瞭.很簡單瞭.

作者“信仰的力量”
 

發佈留言