Spring定時任務的實現

時間 2019-11-13

標籤 spring 定時任務實現欄目 Spring 简体版

原文原文鏈接

Spring定時任務的幾種實現

項目開發中常常須要執行一些定時任務，好比須要在天天凌晨時候，分析一次前一天的日誌信息，藉此機會整理了一下定時任務的幾種實現方式，因爲項目採用spring框架，因此我都將結合spring框架來介紹。java

一．分類

從實現的技術上來進行分類，目前主要有三種技術（或者說有三種產品）：

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代碼

import org.quartz.JobExecutionContext;  
import org.quartz.JobExecutionException;  
import org.springframework.scheduling.quartz.QuartzJobBean;  
public class Job1 extends QuartzJobBean {  
  
private int timeout;  
private static int i = 0;  
//調度工廠實例化後，通過timeout時間開始執行調度  
public void setTimeout(int timeout) {  
this.timeout = timeout;  
}  
  
/** 
* 要調度的具體任務 
*/  
@Override  
protected void executeInternal(JobExecutionContext context)  
throws JobExecutionException {  
  System.out.println("定時任務執行中…");  
}  
}

第二步：spring配置文件中配置做業類JobDetailBean

Xml代碼 
<bean name="job1" class="org.springframework.scheduling.quartz.JobDetailBean">  
<property name="jobClass" value="com.gy.Job1" />  
<property name="jobDataAsMap">  
<map>  
<entry key="timeout" value="0" />  
</map>  
</property>  
</bean>

說明：org.springframework.scheduling.quartz.JobDetailBean有兩個屬性，jobClass屬性即咱們在java代碼中定義的任務類，jobDataAsMap屬性即該任務類中須要注入的屬性值。

第三步：配置做業調度的觸發方式（觸發器）
Quartz的做業觸發器有兩種，分別是
org.springframework.scheduling.quartz.SimpleTriggerBean
org.springframework.scheduling.quartz.CronTriggerBean
第一種SimpleTriggerBean，只支持按照必定頻度調用任務，如每隔30分鐘運行一次。
配置方式以下：
Xml代碼

<bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean">  
<property name="jobDetail" ref="job1" />  
<property name="startDelay" value="0" /><!-- 調度工廠實例化後，通過0秒開始執行調度 -->  
<property name="repeatInterval" value="2000" /><!-- 每2秒調度一次 -->  
</bean>

第二種CronTriggerBean，支持到指定時間運行一次，如天天12:00運行一次等。
配置方式以下：
Xml代碼

<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">  
<property name="jobDetail" ref="job1" />  
<!—天天12:00運行一次 -->  
<property name="cronExpression" value="0 0 12 * * ?" />  
</bean>

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

第四步：配置調度工廠
Xml代碼

<bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">  
<property name="triggers">  
<list>  
<ref bean="cronTrigger" />  
</list>  
</property>  
</bean>

說明：該參數指定的就是以前配置的觸發器的名字。

第五步：啓動你的應用便可，即將工程部署至tomcat或其餘容器。

第二種，做業類不繼承特定基類。

Spring可以支持這種方式，歸功於兩個類：
org.springframework.scheduling.timer.MethodInvokingTimerTaskFactoryBean
org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean
這兩個類分別對應spring支持的兩種實現任務調度的方式，即前文提到到java自帶的timer task方式和Quartz方式。這裏我只寫MethodInvokingJobDetailFactoryBean的用法，使用該類的好處是,咱們的任務類再也不須要繼承自任何類，而是普通的pojo。
第一步：編寫任務類
Java代碼

public class Job2 {  
public void doJob2() {  
System.out.println("不繼承QuartzJobBean方式-調度進行中...");  
}  
}

能夠看出，這就是一個普通的類，而且有一個方法。

第二步：配置做業類
Xml代碼

<bean id="job2"  
class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">  
<property name="targetObject">  
<bean class="com.gy.Job2" />  
</property>  
<property name="targetMethod" value="doJob2" />  
<property name="concurrent" value="false" /><!-- 做業不併發調度 -->  
</bean>

說明：這一步是關鍵步驟，聲明一個MethodInvokingJobDetailFactoryBean，有兩個關鍵屬性：targetObject指定任務類，targetMethod指定運行的方法。往下的步驟就與方法一相同了，爲了完整，一樣貼出。

第三步：配置做業調度的觸發方式（觸發器）
Quartz的做業觸發器有兩種，分別是
org.springframework.scheduling.quartz.SimpleTriggerBean
org.springframework.scheduling.quartz.CronTriggerBean
第一種SimpleTriggerBean，只支持按照必定頻度調用任務，如每隔30分鐘運行一次。
配置方式以下：
Xml代碼

<bean id="simpleTrigger" class="org.springframework.scheduling.quartz.SimpleTriggerBean">  
<property name="jobDetail" ref="job2" />  
<property name="startDelay" value="0" /><!-- 調度工廠實例化後，通過0秒開始執行調度 -->  
<property name="repeatInterval" value="2000" /><!-- 每2秒調度一次 -->  
</bean>

第二種CronTriggerBean，支持到指定時間運行一次，如天天12:00運行一次等。
配置方式以下：

Xml代碼 
<bean id="cronTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">  
<property name="jobDetail" ref="job2" />  
<!—天天12:00運行一次 -->  
<property name="cronExpression" value="0 0 12 * * ?" />  
</bean>

以上兩種調度方式根據實際狀況，任選一種便可。

第四步：配置調度工廠
Xml代碼

<bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">  
<property name="triggers">  
<list>  
<ref bean="cronTrigger" />  
</list>  
</property>  
</bean>

說明：該參數指定的就是以前配置的觸發器的名字。

第五步：啓動你的應用便可，即將工程部署至tomcat或其餘容器。

到此，spring中Quartz的基本配置就介紹完了，固然了，使用以前，要導入相應的spring的包與Quartz的包，這些就不消多說了。
其實能夠看出Quartz的配置看上去仍是挺複雜的，沒有辦法，由於Quartz實際上是個重量級的工具，若是咱們只是想簡單的執行幾個簡單的定時任務，有沒有更簡單的工具，有！
請看我第下文Spring task的介紹。

Spring-Task

上節介紹了在Spring 中使用Quartz，本文介紹Spring3.0之後自主開發的定時任務工具，spring task，能夠將它比做一個輕量級的Quartz，並且使用起來很簡單，除spring相關的包外不須要額外的包，並且支持註解和配置文件兩種
形式，下面將分別介紹這兩種方式。

第一種：配置文件方式

第一步：編寫做業類
即普通的pojo，以下：
Java代碼

import org.springframework.stereotype.Service;  
@Service  
public class TaskJob {  
      
    public void job1() {  
        System.out.println(「任務進行中。。。」);  
    }  
}

第二步：在spring配置文件頭中添加命名空間及描述
Xml代碼

<beans xmlns="http://www.springframework.org/schema/beans"  
    xmlns:task="http://www.springframework.org/schema/task"   
    。。。。。。  
    xsi:schemaLocation="http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.0.xsd">

第三步：spring配置文件中設置具體的任務
Xml代碼

<task:scheduled-tasks>   
        <task:scheduled ref="taskJob" method="job1" cron="0 * * * * ?"/>   
</task:scheduled-tasks>  
  
<context:component-scan base-package=" com.gy.mytask " />

說明：ref參數指定的即任務類，method指定的即須要運行的方法，cron及cronExpression表達式，具體寫法這裏不介紹了，詳情見上篇文章附錄。
<context:component-scan base-package="com.gy.mytask" />這個配置不消多說了，spring掃描註解用的。
到這裏配置就完成了，是否是很簡單。

第二種：使用註解形式

也許咱們不想每寫一個任務類還要在xml文件中配置下，咱們可使用註解@Scheduled，咱們看看源文件中該註解的定義：
Java代碼

@Target({java.lang.annotation.ElementType.METHOD, java.lang.annotation.ElementType.ANNOTATION_TYPE})  
@Retention(RetentionPolicy.RUNTIME)  
@Documented  
public @interface Scheduled  
{  
  public abstract String cron();  
  
  public abstract long fixedDelay();  
  
  public abstract long fixedRate();  
}

能夠看出該註解有三個方法或者叫參數，分別表示的意思是：
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代碼

import org.springframework.scheduling.annotation.Scheduled;    
import org.springframework.stereotype.Component;  
  
@Component(「taskJob」)  
public class TaskJob {  
    @Scheduled(cron = "0 0 3 * * ?")  
    public void job1() {  
        System.out.println(「任務進行中。。。」);  
    }  
}

第二步：添加task相關的配置：
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:aop="http://www.springframework.org/schema/aop"  
    xmlns:context="http://www.springframework.org/schema/context"  
    xmlns:tx="http://www.springframework.org/schema/tx"  
    xmlns:task="http://www.springframework.org/schema/task"  
    xsi:schemaLocation="  
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd  
        http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.0.xsd  
        http://www.springframework.org/schema/context   
http://www.springframework.org/schema/jdbc/spring-jdbc-3.0.xsd  
        http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.0.xsd  
        http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.0.xsd"  
    default-lazy-init="false">  
  
  
    <context:annotation-config />  
    <!—spring掃描註解的配置   -->  
    <context:component-scan base-package="com.gy.mytask" />  
      
<!—開啓這個配置，spring才能識別@Scheduled註解   -->  
    <task:annotation-driven scheduler="qbScheduler" mode="proxy"/>  
    <task:scheduler id="qbScheduler" pool-size="10"/>