Spring整合Quartz實現定時任務調度
Spring 提供了幾個幫助類用于在應用中做調度,包括JDK Timer類和OpenSymphony Quartz Scheduler兩種.
Quartz基礎
Quartz包括五種主要結構用于實現調度:
Job接口 JobDetail類 Trigger 抽象類 Scheduler接口 SchedulerFactory 接口 Job接口表示一個作業(job)。一個作業專注做一件事。它的API非常簡潔。只有一個execute方法,該方法在作業被執行時有Quartz調度。該方法有一個JobExecuteContext參數,可以通過該參數給execute()方法傳遞有用信息。
public interface Job{ void execute(JobExecuteContext ctx); }
一些數據可以通過JobDataMap傳遞給作業。如果一個JobDataMap被注冊到JobDetail中,就能夠在作業中通過 JobExecuteContext來訪問。JobDetail用來描述一個特定Job的信息。Job通過觸發器(Trigger)觸發。Quartz提供了集中Trigger的實現,如SimpleTrigger和CronTrigger。SimpleTrigger類似一個簡單時鐘,你可以定義開始是建,結束時間,重復次數,重復周期。CronTrigger類似Linux系統中的cron。CronTrigger的設置可以非常詳細,如在每個月最后一個周五的上午10:15執行作業。需要注意的是Trigger和Job是具名的,可以被賦值給一個組,在同一組內不能出現同名。你可以對一個組創建一個 觸發器,在該組內的所有Job都將會執行。 SchedulerFactory 用于獲得Scheduler實例,可以用于注冊作業和觸發器。
實現一個簡單的實例:每十秒鐘打印一次歡迎。
首先實現一個作業:
public class SimpleJob implements Job { @Override public void execute(JobExecutionContext arg0) throws JobExecutionException { System.out.println("[JOB] Welcome to Quartz!"); } }
定義一個Scheduler,注冊觸發器和作業:
public class SimpleSchedule { public static void main(String[] args) { SchedulerFactory factory=new StdSchedulerFactory(); try { Scheduler scheduler = factory.getScheduler(); scheduler.start(); JobDetail jobDetail = new JobDetail("SimpleJob",null, SimpleJob.class); Trigger simplerTrigger = TriggerUtils.makeSecondlyTrigger(10); simplerTrigger.setName("SimpleTrigger"); scheduler.scheduleJob(jobDetail, simplerTrigger); }catch (SchedulerException e) { // TODO Auto-generated catch block e.printStackTrace(); } } }
執行過后,每十秒輸出[JOB] Welcome to Quartz!
Spring中的Quartz
Spring中的Quartz API位于org.springframework.scheduling.quartz包中。主要類結構包括:
QuartzJobBean 抽象類 JobDetailBean SimpleTriggerBean CronTriggerBean SchedulerFactoryBean MethodInvokingDetailFactoryBean
很明顯對應實現Quartz中相應的接口。QuartzJob實現Job,JobDetailBean繼承JobDetail。 SimpleTriggerBean和CronTriggerBean繼承自相應的Trigger。 MethodInvokingJobDetailFactoryBean用于在類中調用任何對象的方法。聲明Job
JobDetailBean用于聲明作業。可以為其設置作業名,以及需要的數據。
<bean name="simpleJob" class="org.springframework.scheduling.quartz.JobDetailBean"> <property name="jobClass" value="com.alibaba.jiang.learn.quartz.SimpleJob" /> <property name="jobDataAsMap"> <map> <entry key="message" value="Welcome to Quartz" /> </map> </property> </bean>
實現Job類:
public class SimpleJob extends QuartzJobBean { @Override protected void executeInternal(JobExecutionContext ctx) throws JobExecutionException { String message = ctx.getJobDetail().getJobDataMap().getString("message"); System.out.println(message); } }
還可以通過setter注入的方式注入message。聲明觸發器:
<bean name="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean"> <property name="jobDetail" ref="simpleJob"/> <property name="startDelay" value="0"/> <property name="repeatInterval" value="10000"/> </bean>
聲明調度器,設置Job和Trigger:
<bean name="schedulerFactory" class="org.springframework.scheduling.quartz.SchedulerFactoryBean"> <property name="triggers"> <list> <ref bean="simpleTrigger"/> </list> </property> </bean>
所有都設置好后,可以通過加載Context,調度器將自動執行:
public class SimpleSpringQuartz { public static void main(String[] args) { ApplicationContext ctx = new ClassPathXmlApplicationContext("beans.xml"); } }
使用MethodInvokingJobFactoryBean
上面的范例使用的是Quartz Job,事實上在Spring中可以使用自定義Pojo Bean,無須繼承自QuartzJobBean。首先聲明一個PojoBean
<bean name="welcomeBean" class="com.alibaba.jiang.learn.quartz.WelcomeBean"> <property name="message" value="Welcome to Quartz Method"/> </bean>
對應的Pojo Bean:
public class WelcomeBean { private String message; public void setMessage(String message) { this.message = message; } public void welcome(){ System.out.println(message); } }
聲明MethodInvokingJobDetailFactoryBean:
<bean name="methodInvokingJob" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean"> <property name="targetObject" ref="welcomeBean"/> <property name="targetMethod" value="welcome"/> </bean> <bean name="methodTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean"> <property name="jobDetail" ref="methodInvokingJob" /> <property name="startDelay" value="0"/> <property name="repeatInterval" value="10000"/> </bean>
注意
一個觸發器只能觸發一個Job,不過一個Job可以有多個Trigger觸發,這回帶來并發問題。在Quartz中,如果你不想并發執行一個同一個 Job,你可以實現StatefulJob,而不是Job。在Spring中如果使用 MethodInvokingJobDetailFactoryBean,可以通過設置concurrent="false"屬性來實現。
尾注
在Spring中使用Quartz而不是單獨的一個應用的好處包括:
將所有的任務調度設置放在同一個地方,是任務易于維護。
只對Job編碼,Trigger和Scheduler可以通過配置設置
可以使用Pojo Java Bean執行job,而無需實現Job接口
Cron表達式的詳細用法
字段 允許值 允許的特殊字符 秒 0-59 , - * / 分 0-59 , - * / 小時 0-23 , - * / 日期 1-31 , - * ? / L W C 月份 1-12 或者 JAN-DEC , - * / 星期 1-7 或者 SUN-SAT , - * ? / L C # 年(可選) 留空, 1970-2099 , - * / 例子: 0/5 * * * * ? : 每5秒執行一次
“”字符被用來指定所有的值。如:""在分鐘的字段域里表示“每分鐘”。
“?”字符只在日期域和星期域中使用。它被用來指定“非明確的值”。當你需要通過在這兩個域中的一個來指定一些東西的時候,它是有用的。看下面的例子你就會明白。
月份中的日期和星期中的日期這兩個元素時互斥的一起應該通過設置一個問號來表明不想設置那個字段。
“-”字符被用來指定一個范圍。如:“10-12”在小時域意味著“10點、11點、12點”。
“,”字符被用來指定另外的值。如:“MON,WED,FRI”在星期域里表示”星期一、星期三、星期五”。
“/”字符用于指定增量。如:“0/15”在秒域意思是每分鐘的0,15,30和45秒。“5/15”在分鐘域表示每小時的5,20,35和50。符號“”在“/”前面(如:/10)等價于0在“/”前面(如:0/10)。記住一條本質:表達式的每個數值域都是一個有最大值和最小值的集合,如:秒域和分鐘域的集合是0-59,日期域是 1-31,月份域是1-12。字符“/”可以幫助你在每個字符域中取相應的數值。如:“7/6”在月份域的時候只有當7月的時候才會觸發,并不是表示每個 6月。
L是‘last’的省略寫法可以表示day-of-month和day-of-week域,但在兩個字段中的意思不同,例如day-of- month域中表示一個月的最后一天。如果在day-of-week域表示‘7’或者‘SAT’,如果在day-of-week域中前面加上數字,它表示一個月的最后幾天,例如‘6L’就表示一個月的最后一個星期五。
字符“W”只允許日期域出現。這個字符用于指定日期的最近工作日。例如:如果你在日期域中寫 “15W”,表示:這個月15號最近的工作日。所以,如果15號是周六,則任務會在14號觸發。如果15好是周日,則任務會在周一也就是16號觸發。如果是在日期域填寫“1W”即使1號是周六,那么任務也只會在下周一,也就是3號觸發,“W”字符指定的最近工作日是不能夠跨月份的。字符“W”只能配合一個單獨的數值使用,不能夠是一個數字段,如:1-15W是錯誤的。
“L”和“W”可以在日期域中聯合使用,LW表示這個月最后一周的工作日。
字符“#”只允許在星期域中出現。這個字符用于指定本月的某某天。例如:“6#3”表示本月第三周的星期五(6表示星期五,3表示第三周)。“2#1”表示本月第一周的星期一。“4#5”表示第五周的星期三。
字符“C”允許在日期域和星期域出現。這個字符依靠一個指定的“日歷”。也就是說這個表達式的值依賴于相關的“日歷”的計算結果,如果沒有“日歷” 關聯,則等價于所有包含的“日歷”。如:日期域是“5C”表示關聯“日歷”中第一天,或者這個月開始的第一天的后5天。星期域是“1C”表示關聯“日歷” 中第一天,或者星期的第一天的后1天,也就是周日的后一天(周一)。
表達式舉例
"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觸發