Spring+Quartz實現定時任務 (二)

時間 2019-11-08

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

原文原文鏈接

在咱們進行軟件項目開發的過程當中，相信你們在不少時候都會遇到以下業務場景：天天、每週或每個月生成相應的業務報表；天天統計系統註冊人數；按期清理平臺長久不登陸的用戶等等。遇到這種業務場景須要怎樣去處理？人爲定時去數據庫操做來統計？別開玩笑了，這種事情哪用得着人來作，若是像這種任務還須要專人天天都去作統計，那估計不少人就要瘋掉了。針對於這種業務狀況，採用定時任務是個很是不錯的選擇。在Java領域中，定時任務的開源工具也很是多，小到一個Timer類，大到Quartz框架。整體來講，我的比較喜歡的仍是Quartz，功能強大並且使用方便。接下來咱們就看一下如何經過Spring和Quartz來實現業務系統中的定時任務。
html

Spring整合Quartz實現定時任務步驟很簡單，大體須要通過以下幾步：建立任務（Job）、配置JobDetail、配置觸發器（Trigger）、配置SchedulerFactoryBean
java

好了，廢話很少說了，下面進入正題。程序員

首先建立一個web項目並引入Spring和quartz的依賴
web

而後在web.xml文件中引入Spring支持spring

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
    id="WebApp_ID" version="2.5">
    <display-name>quartz_csdn</display-name>
    <welcome-file-list>
        <welcome-file>index.html</welcome-file>
        <welcome-file>index.htm</welcome-file>
        <welcome-file>index.jsp</welcome-file>
        <welcome-file>default.html</welcome-file>
        <welcome-file>default.htm</welcome-file>
        <welcome-file>default.jsp</welcome-file>
    </welcome-file-list>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:beans.xml</param-value>
    </context-param>
</web-app>

好了，到如今爲止，基本的環境算是搭建好了，接下來咱們就要開始Spring+Quartz實現定時任務了。數據庫

1、建立任務（Job）app

Spring+Quartz實現Job有兩種方式：一種是繼承 org.springframework.scheduling.quartz.QuartzJobBean類來實現Job任務，並實現裏面的抽象方法 executeInternal；另外一種是不繼承任何類，建立普通的Java類，而後本身指定任務的執行方法（我的感受此種方式較好，實現起來方便並且大大下降了系統的業務的耦合性）。框架

咱們先來看一下繼承QuartzJobBean類的這種形式，建立一個任務類ExampleJob，具體代碼以下：jsp

package com.mhy.quartz;

import java.text.SimpleDateFormat;
import java.util.Date;

import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.scheduling.quartz.QuartzJobBean;

/** 
 * 繼承QuartzJobBean形式的定時任務 
 */  
public class ExampleJob extends QuartzJobBean{
    private int timeout;  

    @Override
    protected void executeInternal(JobExecutionContext arg0)
            throws JobExecutionException {
         System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + "執行ExampleJob的定時任務");  
    }

    public int getTimeout() {
        return timeout;
    }

    public void setTimeout(int timeout) {
        this.timeout = timeout;
    }
    

}

爲了演示方便，executeInternal方法中沒有寫複雜的業務邏輯，只簡單的輸出一句話，真正的生產環境中在該方法中實現你所須要的業務邏輯便可。
ide

2、在Spring配置文件中配置JobDetail

<bean name="exampleJobDetail" class="org.springframework.scheduling.quartz.JobDetailBean">  
    <property name="jobClass" value="com.mhy.quartz.ExampleJob" />  
    <property name="jobDataAsMap">  
        <map>  
            <entry key="timeout" value="5" />  
        </map>  
    </property>  
</bean>

3、配置觸發器（Trigger）

Spring提供了兩種觸發器，以下：
一、org.springframework.scheduling.quartz.SimpleTriggerFactoryBean（此種方式是很隔多長時間進行觸發一次，好比每隔24小時觸發一次）
二、org.springframework.scheduling.quartz.CronTriggerFactoryBean（此種方式是在指定的時間進行觸發，好比只在週一進行觸發。不過根據配置也很方便的實現相似SimpleTriggerFactoryBean形式的定時任務）
Spring所提供的這兩種觸發器方式和前面提到的任務建立方式都可以相互之間混用，很靈活。
這裏咱們先使用SimpleTriggerFactoryBean這個trigger來配置

<bean id="exampleJobTrigger"  
    class="org.springframework.scheduling.quartz.SimpleTriggerFactoryBean">  
    <property name="jobDetail" ref="exampleJobDetail" />  
    <!-- 延遲觸發時間，延遲10秒進行觸發 -->  
    <property name="startDelay" value="10000" />  
    <!-- 重複觸發的時間間隔，5秒 -->  
    <property name="repeatInterval" value="5000" />  
</bean>

4、配置SchedulerFactoryBean

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

好了，到如今爲止，一個簡單的定時任務就完成了，下面咱們來啓動一下web項目，看運行結果如何。

很不幸的是運行失敗了，這是爲啥呢？彆着急，慢慢看看異常信息（學會分析異常信息也是程序員重要的能力之一噢）。從異常信息中咱們能夠看出，JobDetailBean引用了一個接口來做爲父類了。既然是這樣的話，那咱們就須要看一下JobDetailBean的源碼了。

在Quartz中JobDetail居然是一個接口。是否是搞錯了，你確定要問了。這是爲何呢，爲何呢，爲何呢？哈哈，這個就得談到 Quartz的歷史問題了。Quartz從1.X升級到2.X以後，JobDetail由類修改成接口了，爲啥要改？那你得去問Quartz做者了，嘿嘿。那若是再繼續採用這種模式的話那確定會錯嘍。那咱們對它就沒有法子了麼？怎麼可能。處理它很簡單啊：1、把Quartz降到1.X版本；2、更改 Job的實現方式。

首先咱們來試試使用1.X版本的Quartz

能夠看到在Quartz1.X版本中，JobDetail仍是一個類。接下來咱們再啓動一下web項目看看運行結果何如。

能夠看到，在更換Quartz版本爲1.X以後，定時任務正常運行了。

看到這，想必你們就要問了，其餘方式呢，總不能讓咱們一直使用Quartz1.X版本吧？固然不是，咱們還有不少辦法，你們慢慢往下看。

第二部分：實現Spring3+Quartz2的定時任務。

首先建立一個基本的Java類來作爲Job任務類，代碼以下：

package com.mhy.quartz;

import java.text.SimpleDateFormat;
import java.util.Date;

/** 
 * 繼承QuartzJobBean形式的定時任務 
 */  
public class ExampleJob2 {
    /** 
     * 執行定時統計任務 
     * 自行指定方法 
     */ 
    public void execute(){
         System.out.println(new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date()) + "執行ExampleJob2");  
         
    }

}

接下來是在Spring配置文件中配置JobDetail、Trigger、SchedulerFactoryBean

<bean id="exampleJob2" class="com.mhy.quartz.ExampleJob2"></bean>  
<bean id="exampleJob2Detail"  
    class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">  
    <!-- 指定任務類 -->  
    <property name="targetObject" ref="exampleJob2" />  
    <!-- 指定任務執行的方法 -->  
    <property name="targetMethod" value="execute" />  
</bean>  
<bean id="exampleJob2Trigger"  
    class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">  
    <property name="jobDetail" ref="exampleJob2Detail" />  
    <!-- 每10秒運行一次 -->  
    <property name="cronExpression" value="0/10 * * * * ?" />  
</bean>  
  
<bean class="org.springframework.scheduling.quartz.SchedulerFactoryBean">  
    <property name="triggers">  
        <list>  
            <!-- <ref bean="exampleJobTrigger" /> -->  
            <ref bean="exampleJob2Trigger" />  
        </list>  
    </property>  
</bean>

好了，配置完以後咱們再啓動一下程序，看看定時任務時否運行良好（這裏咱們使用的Trigger是CronTriggerFactoryBean，固然也可使用SimpleTriggerFactoryBean）

關於Trigger中時間如何配置，quartz官網描述的很清楚，你們能夠參考以下網址：http://quartz-scheduler.org/documentation/quartz-2.2.x/tutorials/crontrigger

OK，沒有問題，好了，關於Spring+Quartz實現定時任務暫就告一段落，歡迎你們多多交流，有不當以後還請你們指正出來。

順便貼一下cronExpression表達式備忘：字段容許值容許的特殊字符

秒 0-59 , – * /

分 0-59 , – * /

小時 0-23 , – * /

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

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

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

年（可選）留空, 1970-2099 , – * /

表達式意義