1. 程式人生 > >關於Spring定時任務(定時器)用法

關於Spring定時任務(定時器)用法

部落格分類:

Spring定時任務的幾種實現

近日專案開發中需要執行一些定時任務,比如需要在每天凌晨時候,分析一次前一天的日誌資訊,藉此機會整理了一下定時任務的幾種實現方式,由於專案採用spring框架,所以我都將結合

spring框架來介紹。

一.分類

  • 從實現的技術上來分類,目前主要有三種技術(或者說有三種產品):

  1. Java自帶的java.util.Timer類,這個類允許你排程一個java.util.TimerTask任務。使用這種方式可以讓你的程式按照某一個頻度執行,但不能在指定時間執行。一般用的較少,這篇文章將不做詳細介紹。

  2. 使用Quartz,這是一個功能比較強大的的排程器,可以讓你的程式在指定時間執行,也可以按照某一個頻度執行,配置起來稍顯複雜,稍後會詳細介紹。

  3. Spring3.0以後自帶的task,可以將它看成一個輕量級的Quartz,而且使用起來比Quartz簡單許多,稍後會介紹。

  • 從作業類的繼承方式來講,可以分為兩類:

  1. 作業類需要繼承自特定的作業類基類,如Quartz中需要繼承自org.springframework.scheduling.quartz.QuartzJobBean;java.util.Timer中需要繼承自java.util.TimerTask。

  2. 作業類即普通的java類,不需要繼承自任何基類。

注:個人推薦使用第二種方式,因為這樣所以的類都是普通類,不需要事先區別對待。

  • 從任務排程的觸發時機來分,這裡主要是針對作業使用的觸發器,主要有以下兩種:
  1. 每隔指定時間則觸發一次,在Quartz中對應的觸發器為:org.springframework.scheduling.quartz.SimpleTriggerBean

  2. 每到指定時間則觸發一次,在Quartz中對應的排程器為:org.springframework.scheduling.quartz.CronTriggerBean

注:並非每種任務都可以使用這兩種觸發器,如java.util.TimerTask任務就只能使用第一種。Quartz和spring task都可以支援這兩種觸發條件。

二.用法說明

詳細介紹每種任務排程工具的使用方式,包括Quartz和spring task兩種。

Quartz

第一種,作業類繼承自特定的基類:org.springframework.scheduling.quartz.QuartzJobBean。

第一步:定義作業類

Java程式碼  

  1. import org.quartz.JobExecutionContext;  

  2. import org.quartz.JobExecutionException;  

  3. import org.springframework.scheduling.quartz.QuartzJobBean;  

  4. public class Job1 extends QuartzJobBean {  

  5. private int timeout;  

  6. private static int i = 0;  

  7. //排程工廠例項化後,經過timeout時間開始執行排程  

  8. public void setTimeout(int timeout) {  

  9. this.timeout = timeout;  

  10. }  

  11. /** 

  12. * 要排程的具體任務 

  13. */  

  14. @Override  

  15. protected void executeInternal(JobExecutionContext context)  

  16. throws JobExecutionException {  

  17.   System.out.println("定時任務執行中…");  

  18. }  

  19. }  

 第二步:spring配置檔案中配置作業類JobDetailBean

Xml程式碼  

  1. <bean name="job1" class="org.springframework.scheduling.quartz.JobDetailBean">  

  2. <property name="jobClass" value="com.gy.Job1" />  

  3. <property name="jobDataAsMap">  

  4. <map>  

  5. <entry key="timeout" value="0" />  

  6. </map>  

  7. </property>  

  8. </bean>  

 說明:org.springframework.scheduling.quartz.JobDetailBean有兩個屬性,jobClass屬性即我們在java程式碼中定義的任務類,jobDataAsMap屬性即該任務類中需要注入的屬性值。

第三步:配置作業排程的觸發方式(觸發器)

Quartz的作業觸發器有兩種,分別是

org.springframework.scheduling.quartz.SimpleTriggerBean

org.springframework.scheduling.quartz.CronTriggerBean

第一種SimpleTriggerBean,只支援按照一定頻度呼叫任務,如每隔30分鐘執行一次。

配置方式如下:

Xml程式碼  

  1. <bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean">  

  2. <property name="jobDetail" ref="job1" />  

  3. <property name="startDelay" value="0" /><!-- 排程工廠例項化後,經過0秒開始執行排程 -->  

  4. <property name="repeatInterval" value="2000" /><!-- 每2秒排程一次 -->  

  5. </bean>  

第二種CronTriggerBean,支援到指定時間執行一次,如每天12:00執行一次等。

配置方式如下:

Xml程式碼  

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

  2. <property name="jobDetail" ref="job1" />  

  3. <!—每天12:00執行一次 -->  

  4. <property name="cronExpression" value="0 0 12 * * ?" />  

  5. </bean>  

 關於cronExpression表示式的語法參見附錄。

第四步:配置排程工廠 

Xml程式碼  

  1. <bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">  

  2. <property name="triggers">  

  3. <list>  

  4. <ref bean="cronTrigger" />  

  5. </list>  

  6. </property>  

  7. </bean>  

 說明:該引數指定的就是之前配置的觸發器的名字。

第五步:啟動你的應用即可,即將工程部署至tomcat或其他容器。

第二種,作業類不繼承特定基類。

Spring能夠支援這種方式,歸功於兩個類:

org.springframework.scheduling.timer.MethodInvokingTimerTaskFactoryBean

org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean

這兩個類分別對應spring支援的兩種實現任務排程的方式,即前文提到到java自帶的timer task方式和Quartz方式。這裡我只寫MethodInvokingJobDetailFactoryBean的用法,使用該類的好處是,我們的任 務類不再需要繼承自任何類,而是普通的pojo。

第一步:編寫任務類

Java程式碼  

  1. public class Job2 {  

  2. public void doJob2() {  

  3. System.out.println("不繼承QuartzJobBean方式-排程進行中...");  

  4. }  

  5. }  

 可以看出,這就是一個普通的類,並且有一個方法。

第二步:配置作業類

Xml程式碼  

  1. <bean id="job2"  

  2. class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">  

  3. <property name="targetObject">  

  4. <bean class="com.gy.Job2" />  

  5. </property>  

  6. <property name="targetMethod" value="doJob2" />  

  7. <property name="concurrent" value="false" /><!-- 作業不併發排程 -->  

  8. </bean>  

 說明:這一步是關鍵步驟,宣告一個MethodInvokingJobDetailFactoryBean,有兩個關鍵屬性:targetObject指定任務類,targetMethod指定執行的方法。往下的步驟就與方法一相同了,為了完整,同樣貼出。

第三步:配置作業排程的觸發方式(觸發器)

Quartz的作業觸發器有兩種,分別是

org.springframework.scheduling.quartz.SimpleTriggerBean

org.springframework.scheduling.quartz.CronTriggerBean

第一種SimpleTriggerBean,只支援按照一定頻度呼叫任務,如每隔30分鐘執行一次。

配置方式如下:

Xml程式碼  

  1. <bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean">  

  2. <property name="jobDetail" ref="job2" />  

  3. <property name="startDelay" value="0" /><!-- 排程工廠例項化後,經過0秒開始執行排程 -->  

  4. <property name="repeatInterval" value="2000" /><!-- 每2秒排程一次 -->  

  5. </bean>  

 第二種CronTriggerBean,支援到指定時間執行一次,如每天12:00執行一次等。

配置方式如下:

Xml程式碼  

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

  2. <property name="jobDetail" ref="job2" />  

  3. <!—每天12:00執行一次 -->  

  4. <property name="cronExpression" value="0 0 12 * * ?" />  

  5. </bean>  

以上兩種排程方式根據實際情況,任選一種即可。

第四步:配置排程工廠 

Xml程式碼  

  1. <bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">  

  2. <property name="triggers">  

  3. <list>  

  4. <ref bean="cronTrigger" />  

  5. </list>  

  6. </property>  

  7. </bean>  

說明:該引數指定的就是之前配置的觸發器的名字。

第五步:啟動你的應用即可,即將工程部署至tomcat或其他容器。

到此,spring中Quartz的基本配置就介紹完了,當然了,使用之前,要匯入相應的spring的包與Quartz的包,這些就不消多說了。

其實可以看出Quartz的配置看上去還是挺複雜的,沒有辦法,因為Quartz其實是個重量級的工具,如果我們只是想簡單的執行幾個簡單的定時任務,有沒有更簡單的工具,有!

請看我第下文Spring task的介紹。

Spring-Task

上節介紹了在Spring 中使用Quartz,本文介紹Spring3.0以後自主開發的定時任務工具,spring task,可以將它比作一個輕量級的Quartz,而且使用起來很簡單,除spring相關的包外不需要額外的包,而且支援註解和配置檔案兩種

形式,下面將分別介紹這兩種方式。

第一種:配置檔案方式

第一步:編寫作業類

即普通的pojo,如下:

Java程式碼  

  1. import org.springframework.stereotype.Service;  

  2. @Service  

  3. public class TaskJob {  

  4.     public void job1() {  

  5.         System.out.println(“任務進行中。。。”);  

  6.     }  

  7. }  

 第二步:在spring配置檔案頭中新增名稱空間及描述

Xml程式碼  

  1. <beans xmlns="http://www.springframework.org/schema/beans"  

  2.     xmlns:task="http://www.springframework.org/schema/task"   

  3.     。。。。。。  

  4.     xsi:schemaLocation="http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.0.xsd">  

 第三步:spring配置檔案中設定具體的任務

Xml程式碼  

  1.  <task:scheduled-tasks>   

  2.         <task:scheduled ref="taskJob" method="job1" cron="0 * * * * ?"/>   

  3. </task:scheduled-tasks>  

  4. <context:component-scan base-package=" com.gy.mytask " />  

說明:ref引數指定的即任務類,method指定的即需要執行的方法,cron及cronExpression表示式,具體寫法這裡不介紹了,詳情見上篇文章附錄。

<context:component-scan base-package="com.gy.mytask" />這個配置不消多說了,spring掃描註解用的。

到這裡配置就完成了,是不是很簡單。

第二種:使用註解形式

也許我們不想每寫一個任務類還要在xml檔案中配置下,我們可以使用註解@Scheduled,我們看看原始檔中該註解的定義:

Java程式碼  

  1. @Target({java.lang.annotation.ElementType.METHOD, java.lang.annotation.ElementType.ANNOTATION_TYPE})  

  2. @Retention(RetentionPolicy.RUNTIME)  

  3. @Documented  

  4. public @interface Scheduled  

  5. {  

  6.   public abstract String cron();  

  7.   public abstract long fixedDelay();  

  8.   public abstract long fixedRate();  

  9. }  

 可以看出該註解有三個方法或者叫引數,分別表示的意思是:

cron:指定cron表示式

fixedDelay:官方文件解釋:An interval-based trigger where the interval is measured from the completion time of the previous task. The time unit value is measured in milliseconds.即表示從上一個任務完成開始到下一個任務開始的間隔,單位是毫秒。

fixedRate:官方文件解釋:An interval-based trigger where the interval is measured from the start time of the previous task. The time unit value is measured in milliseconds.即從上一個任務開始到下一個任務開始的間隔,單位是毫秒。

下面我來配置一下。

第一步:編寫pojo

Java程式碼  

  1. import org.springframework.scheduling.annotation.Scheduled;    

  2. import org.springframework.stereotype.Component;  

  3. @Component(“taskJob”)  

  4. public class TaskJob {  

  5.     @Scheduled(cron = "0 0 3 * * ?")  

  6.     public void job1() {  

  7.         System.out.println(“任務進行中。。。”);  

  8.     }  

  9. }  

 第二步:新增task相關的配置:

Xml程式碼  

  1. <?xml version="1.0" encoding="UTF-8"?>  

  2. <beans xmlns="http://www.springframework.org/schema/beans"  

  3.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:aop="http://www.springframework.org/schema/aop"  

  4.     xmlns:context="http://www.springframework.org/schema/context"  

  5.     xmlns:tx="http://www.springframework.org/schema/tx"  

  6.     xmlns:task="http://www.springframework.org/schema/task"  

  7.     xsi:schemaLocation="  

  8.         http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd  

  9.         http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd  

  10.         http://www.springframework.org/schema/context   

  11. http://www.springframework.org/schema/jdbc/spring-jdbc-3.0.xsd  

  12.         http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd  

  13.         http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.0.xsd"  

  14.     default-lazy-init="false">  

  15.     <context:annotation-config />  

  16.     <!—spring掃描註解的配置   -->  

  17.     <context:component-scan base-package="com.gy.mytask" />  

  18. <!—開啟這個配置,spring才能識別@Scheduled註解   -->  

  19.     <task:annotation-driven scheduler="qbScheduler" mode="proxy"/>  

  20.     <task:scheduler id="qbScheduler" pool-size="10"/>  

說明:理論上只需要加上<task:annotation-driven />這句配置就可以了,這些引數都不是必須的。

 Ok配置完畢,當然spring task還有很多引數,我就不一一解釋了,具體參考xsd文件http://www.springframework.org/schema/task/spring-task-3.0.xsd。

附錄:

cronExpression的配置說明,具體使用以及引數請百度google

欄位   允許值   允許的特殊字元

秒    0-59    , - * /

分    0-59    , - * /

小時    0-23    , - * /

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

月份    1-12 或者 JAN-DEC    , - * /

星期    1-7 或者 SUN-SAT    , - * ? / L C #

年(可選)    留空, 1970-2099    , - * / 

- 區間  

* 萬用字元  

? 你不想設定那個欄位

下面只例出幾個式子

CRON表示式    含義 

"0 0 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分每分鐘一次觸發 

"0 0/5 14 * * ?"    每天從下午2點開始到2:55分結束每5分鐘一次觸發 

"0 0/5 14,18 * * ?"    每天的下午2點至2:55和6點至6點55分兩個時間段內每5分鐘一次觸發 

"0 0-5 14 * * ?"    每天14:00至14:05每分鐘一次觸發 

"0 10,44 14 ? 3 WED"    三月的每週三的14:10和14:44觸發 

"0 15 10 ? * MON-FRI"    每個週一、週二、週三、週四、週五的10:15觸發