基於Spring實現定時調度

比較常用的是，Spring對Quartz的支持，可以非常容易地進行定時任務的調度。一般，具有兩種方式實現定時調度：

一種是通過繼承Spring的org.springframework.scheduling.quartz.QuartzJobBean來定義定時任務，這種情況下與Spring代碼有一定耦合。下面，通過例子來說明：

實現一個定時任務類，代碼如下所示：

package org.shirdrn.spring.scheduler.quartz; import org.apache.log4j.Logger; import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException; import org.springframework.scheduling.quartz.QuartzJobBean; public class MyQuartzJob extends QuartzJobBean { private static final Logger LOG = Logger.getLogger(MyQuartzJob.class); private static int counter = 0; @Override protected void executeInternal(JobExecutionContext context) throws JobExecutionException { JobControlInfo job = (JobControlInfo) context.getMergedJobDataMap().get("jobControlInfo"); String manager = (String) context.getMergedJobDataMap().get("manager"); int length = Integer.parseInt((String) context.getMergedJobDataMap().get("length")); LOG.info("context: job=" + job + ", manager=" + manager + ", length=" + length); LOG.info("Execute quartz job /"" + (++counter) + "/"."); } }

上面的JobExecutionContext context是一個任務執行上下文，可以通過配置，將需要的數據傳遞給executeInternal方法，然後在該方法中定義任務的處理邏輯。

這裏，假設有一個類包含了對定時任務的控制信息，實現類爲JobControlInfo，形式化定義如下所示：

package org.shirdrn.spring.scheduler.quartz; public class JobControlInfo { }

通過Spring配置傳遞給JobExecutionContext context。

Spring配置文件quartz.xml的內容，如下所示：

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> <bean id="myScheduler" lazy-init="false" autowire="no" class="org.springframework.scheduling.quartz.SchedulerFactoryBean"> <property name="triggers"> <list> <ref bean="myQuartzJobTrigger" /> </list> </property> </bean> <bean id="myQuartzJobTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean"> <property name="jobDetail" ref="myQuartzJobDetail" /> <property name="startDelay" value="5000"/> <property name="repeatInterval" value="2000" /> </bean> <bean id="myQuartzJobDetail" class="org.springframework.scheduling.quartz.JobDetailBean"> <property name="jobClass"> <value>org.shirdrn.spring.scheduler.quartz.MyQuartzJob</value> </property> <property name="jobDataAsMap"> <map> <entry key="jobControlInfo" value-ref="jobControlInfo" /> <entry key="length" value="100000" /> <entry key="manager" value="Jack" /> </map> </property> </bean> <bean id="jobControlInfo" class="org.shirdrn.spring.scheduler.quartz.JobControlInfo" scope="prototype"/> </beans>

下面可以啓動定時任務了，代碼如下所示：

package org.shirdrn.spring.scheduler.quartz; import java.io.BufferedReader; import java.io.IOException; import java.io.InputStreamReader; import org.quartz.impl.StdScheduler; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class ContextInitializer { public static void main(String[] args) { ApplicationContext ctx = new ClassPathXmlApplicationContext( "org/shirdrn/spring/scheduler/quartz/quartz.xml"); StdScheduler myScheduler = (StdScheduler)ctx.getBean("myScheduler"); BufferedReader reader=new BufferedReader(new InputStreamReader(System.in)); try { while(true) { String line = reader.readLine(); if(line!=null) { boolean quit = line.trim().equalsIgnoreCase("quit") || line.trim().equalsIgnoreCase("q"); if(quit) { myScheduler.shutdown(true); break; } } } } catch (IOException e) { e.printStackTrace(); } } }

我們定義這個定時任務，執行時間間隔爲2s。

 

另一種是完全與Spring代碼解耦合，而只是通過Spring配置就能進行定時任務的配置，一個定時任務可以是任意的Java處理類。而對於定時的配置，是基於Unix系統的crontab命令來實現的，更加靈活地配置定時任務。

下面說明實現方法：

定義一個普通的Java類，裏面的一個方法裏面包含了定時任務的處理邏輯，如下所示：

package org.shirdrn.spring.scheduler.quartz.cron; import org.apache.log4j.Logger; public class MyQuartzJob { private static final Logger LOG = Logger.getLogger(MyQuartzJob.class); private static int counter = 0; public void scan() { LOG.info("Execute quartz job /"" + (++counter) + "/"."); } }

然後看下Spring配置文件quartz.xml內容：

<?xml version="1.0" encoding="UTF-8"?> <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd"> <bean id="myScheduler" lazy-init="false" autowire="no" class="org.springframework.scheduling.quartz.SchedulerFactoryBean"> <property name="triggers"> <list> <ref bean="myJobTrigger" /> </list> </property> </bean> <bean id="myJobTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean"> <property name="jobDetail"> <ref bean="myJobDetail" /> </property> <property name="cronExpression"> <value>00,10,20,30,40,50 * * * * ?</value> </property> </bean> <bean id="myJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean"> <property name="targetObject"> <ref bean="myJob" /> </property> <property name="targetMethod"> <value>scan</value> </property> </bean> <bean id="myJob" class="org.shirdrn.spring.scheduler.quartz.cron.MyQuartzJob" /> </beans>

通過Spring的org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean來設置目標定時任務處理內容，如處理類和處理方法，通過org.springframework.scheduling.quartz.CronTriggerBean的cronExpression屬性來配置定時任務，非常靈活。

上述配置，定時任務會自動調用MyQuartzJob類的scan方法來執行任務。

對於cronExpression屬性的值，包括以下7 個字段：

秒 分 小時 月內日期 月 周內日期 年（可選字段）

有關各個字段可以設置的值，我們引用http://www.ibm.com/developerworks/cn/java/j-quartz/index.html的內容：

Cron 觸發器利用一系列特殊字符，如下所示： •反斜線（/）字符表示增量值。例如，在秒字段中“5/15”代表從第 5 秒開始，每 15 秒一次。 •問號（?）字符和字母 L 字符只有在月內日期和周內日期字段中可用。問號表示這個字段不包含具體值。所以，如果指定月內日期，可以在周內日期字段中插入“?”，表示周內日期值無關緊要。字母 L 字符是 last 的縮寫。放在月內日期字段中，表示安排在當月最後一天執行。在周內日期字段中，如果“L”單獨存在，就等於“7”，否則代表當月內周內日期的最後一個實例。所以“0L”表示安排在當月的最後一個星期日執行。 •在月內日期字段中的字母（W）字符把執行安排在最靠近指定值的工作日。把“1W”放在月內日期字段中，表示把執行安排在當月的第一個工作日內。 •井號（#）字符爲給定月份指定具體的工作日實例。把“MON#2”放在周內日期字段中，表示把任務安排在當月的第二個星期一。 •星號（*）字符是通配字符，表示該字段可以接受任何可能的值。

更多信息可以查閱相關資料。

啓動定時任務，測試代碼如下所示：

package org.shirdrn.spring.scheduler.quartz.cron; import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class ContextInitializer { public static void main(String[] args) { ApplicationContext ctx = new ClassPathXmlApplicationContext( "org/shirdrn/spring/scheduler/quartz/cron/quartz.xml"); ctx.getBean("myScheduler"); } }