Spring整合Quartz實現定時任務調度

時間  2019-11-24
標籤 spring 整合 quartz 實現 定時 任務 調度 欄目 Spring 简体版
原文   原文鏈接

Spring 提供了幾個幫助類用於在應用中作調度，包括JDK Timer類和OpenSymphony Quartz Scheduler兩種.html

Quartz基礎
Quartz包括五種主要結構用於實現調度：spring

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，註冊觸發器和做業:ide

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!this

Spring中的Quartz
Spring中的Quartz API位於org.springframework.scheduling.quartz包中。主要類結構包括：編碼

QuartzJobBean 抽象類
JobDetailBean
SimpleTriggerBean
CronTriggerBean
SchedulerFactoryBean
MethodInvokingDetailFactoryBean
很明顯對應實現Quartz中相應的接口。QuartzJob實現Job，JobDetailBean繼承JobDetail。 SimpleTriggerBean和CronTriggerBean繼承自相應的Trigger。 MethodInvokingJobDetailFactoryBean用於在類中調用任何對象的方法。聲明Jobspa

JobDetailBean用於聲明做業。能夠爲其設置做業名，以及須要的數據。.net

<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」在星期域裏表示」星期1、星期3、星期五」。

「/」字符用於指定增量。如：「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觸發
在數據庫中建表。建表模版在Quartz包下docs/dbTables下，選擇相應的數據庫和版本便可。ORACLE的11個Table列表以下：

QRTZ_JOB_LISTENERS：存儲有關已配置的 JobListener 的信息

 JOB_NAME
 JOB_GROUP
 JOB_LISTENER
QRTZ_TRIGGER_LISTENERS：存儲已配置的 TriggerListener 的信息

QRTZ_FIRED_TRIGGERS：存儲與已觸發的 Trigger 相關的狀態信息，以及相聯 Job的執行信息

QRTZ_PAUSED_TRIGGER_GRPS：存儲已暫停的 Trigger 組的信息

QRTZ_SCHEDULER_STATE：存儲集羣中note實例信息，quartz會定時讀取該表的信息判斷集羣中每一個實例的當前狀態

 INSTANCE_NAME 以前配置文件中org.quartz.scheduler.instanceId配置的名字，就會寫入該字段，若是設置爲AUTO,quartz會根據物理機名和當前時間產生一個名字
 LAST_CHECKIN_TIME：上次檢查時間
 CHECKIN_INTERVAL ：檢查間隔時間
QRTZ_LOCKS：存儲程序的悲觀鎖的信息(假如使用了悲觀鎖) 

QRTZ_SIMPLE_TRIGGERS：存儲簡單的Trigger，包括重複次數，間隔，以及已觸的次數

 TRIGGER_NAME ：qrtz_triggers表trigger_name的外鍵
 TRIGGER_GROUP：qrtz_triggers表trigger_group的外鍵
 REPEAT_COUNT ：重複次數
 REPEAT_INTERVAL：時間間隔
 TIMES_TRIGGERED：觸發次數
QRTZ_CRON_TRIGGERS：存儲cron表達式表

 TRIGGER_NAME ：qrtz_triggers表trigger_name的外鍵
 TRIGGER_GROUP：qrtz_triggers表trigger_group的外鍵 
 CRON_EXPRESSION：cron表達式
 TIME_ZONE_ID ：時區
QRTZ_TRIGGERS：保存trigger信息

 TRIGGER_NAME ：trigger的名字,該名字用戶本身能夠隨意定製,無強行要求
 TRIGGER_GROUP：所屬組的名字,該名字用戶本身隨意定製,無強行要求
 JOB_NAME ：qrtz_job_details表job_name的外鍵
 JOB_GROUP ：qrtz_job_details表job_group的外鍵
 IS_VOLATILE 0
 DESCRIPTION
 NEXT_FIRE_TIME
 PREV_FIRE_TIME
 PRIORITY 5
 TRIGGER_STATE ：當前trigger狀態，設置爲ACQUIRED,若是設置爲WAITING,則job不會觸發
 TRIGGER_TYPE：觸發器類型,使用cron表達式
 START_TIME
 END_TIME
 CALENDAR_NAME
 MISFIRE_INSTR
 JOB_DATA
QRTZ_JOB_DETAILS：保存job詳細信息,該表須要用戶根據實際狀況初始化

 JOB_NAME ：集羣中job的名字,該名字用戶本身能夠隨意定製,無強行要求
 JOB_GROUP ：集羣中job的所屬組的名字,該名字用戶本身隨意定製,無強行要求 
 DESCRIPTION
 JOB_CLASS_NAME：集羣中個note job實現類的徹底包名,quartz就是根據這個路徑到classpath找到該job類 
 IS_DURABLE：是否持久化,把該屬性設置爲1，quartz會把job持久化到數據庫中
 IS_VOLATILE
 IS_STATEFUL
 REQUESTS_RECOVERY
 JOB_DATA ：一個blob字段，存放持久化job對象
QRTZ_CALENDARS：以 Blob 類型存儲 Quartz 的 Calendar 信息

QRTZ_BLOB_TRIGGERS：做爲 Blob 類型存儲(用於 Quartz 用戶用 JDBC建立他們本身定製的 Trigger 類型，JobStore 並不知道如何存儲實例的時候) 

 TRIGGER_NAME ：qrtz_triggers表trigger_name的外鍵
 TRIGGER_GROUP：qrtz_triggers表trigger_group的外鍵 
 BLOB_DATA

Quartz 調度任務所需的配置文件 

org.quartz.scheduler.instanceName屬性可爲任何值，用在 JDBC JobStore 中來惟一標識實例，可是全部集羣節點中必須相同。 

org.quartz.scheduler.instanceName = HumsScheduler 

##org.quartz.scheduler.instanceId　屬性爲 AUTO便可，基於主機名和時間戳來產生實例 ID。 

org.quartz.scheduler.instanceId = AUTO 

orgorg.quartz.threadPool.class = org.quartz.simpl.SimpleThreadPool 

org.quartz.threadPool.threadCount = 10 

org.quartz.threadPool.threadPriority = 5 

org.quartz.threadPool.threadsInheritContextClassLoaderOfInitializingThread = true 

org.quartz.jobStore.misfireThreshold = 60000 

##org.quartz.jobStore.class屬性爲 JobStoreTX，將任務持久化到數據中。 

##由於集羣中節點依賴於數據庫來傳播 Scheduler 實例的狀態，你只能在使用 JDBC JobStore 時應用 Quartz 集羣。 

##這意味着你必須使用 JobStoreTX 或是 JobStoreCMT 做爲 Job 存儲；你不能在集羣中使用 RAMJobStore。 

orgorg.quartz.jobStore.class = org.quartz.impl.jdbcjobstore.JobStoreTX 

orgorg.quartz.jobStore.driverDelegateClass=org.quartz.impl.jdbcjobstore.StdJDBCDelegate 

org.quartz.jobStore.tablePrefix = QRTZ_ 

org.quartz.jobStore.maxMisfiresToHandleAtATime=10 

##org.quartz.jobStore.isClustered 屬性爲 true，你就告訴了 Scheduler 實例要它參與到一個集羣當中。 

##這一屬性會貫穿於調度框架的始終，用於修改集羣環境中操做的默認行爲。 

org.quartz.jobStore.isClustered = true 

##org.quartz.jobStore.clusterCheckinInterval 屬性定義了Scheduler 實例檢入到數據庫中的頻率(單位：毫秒)。 

##Scheduler 檢查是否其餘的實例到了它們應當檢入的時候未檢入；這能指出一個失敗的 Scheduler 實例，且當前 Scheduler 會以此來接管任何執行失敗並可恢復的 Job。 

##經過檢入操做，Scheduler 也會更新自身的狀態記錄。clusterChedkinInterval 越小，Scheduler 節點檢查失敗的 Scheduler 實例就越頻繁。默認值是 15000 (即15 秒)。 

org.quartz.jobStore.clusterCheckinInterval = 20000

 

<!-- 定時調度 -->
	<bean name="scheduler"
		class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
		<property name="dataSource" ref="dataSource" />
		<property name="configLocation" value="classpath:quartz.properties" />
		<property name="autoStartup" value="true" /><!-- 開發時能夠改爲false -->
		<!-- 添加監聽器 -->
		<property name="globalTriggerListeners">
			<list>
				<ref bean="catLogTriggerListener" />
			</list>
		</property>
	</bean>

	<bean id="catLogTriggerListener" class="com.becom.schedule.trigger.CatLogTriggerListener"></bean>
package com.becom.schedule.trigger;

import org.quartz.JobExecutionContext;
import org.quartz.Trigger;
import org.quartz.Trigger.CompletedExecutionInstruction;
import org.quartz.TriggerListener;

import com.dianping.cat.Cat;

public class CatLogTriggerListener implements TriggerListener {

    public String getName() {
	return "CatLogTriggerListener";
    }

    /**
     * 被調度時觸發，和它相關的org.quartz.jobdetail即將執行。 該方法優先vetoJobExecution()執行
     */
    public void triggerFired(Trigger trigger, JobExecutionContext context) {
    }

    /**
     * 被調度時觸發，和它相關的org.quartz.jobdetail即將執行。
     */
    public boolean vetoJobExecution(Trigger trigger, JobExecutionContext context) {
	return false;
    }

    /**
     * 被調度時，觸發失敗時觸發
     */
    public void triggerMisfired(Trigger trigger) {
	Object className = trigger.getJobKey().getName();
	if (className == null)
	    return;
	String classStr = className.toString();
	Class cls = null;
	try {
	    cls = Class.forName(classStr);
	} catch (ClassNotFoundException e1) {
	    return;
	}
	// 啞火
	Cat.logEvent("SCHEDULE_TRIGGER_MISFIRED", cls.getSimpleName(),
		"FAILED", null);
    }

    /**
     * 執行完畢時觸發
     */
    public void triggerComplete(Trigger trigger, JobExecutionContext context,
	    int triggerInstructionCode) {
    }

    @Override
    public void triggerComplete(Trigger trigger, JobExecutionContext context,
	    CompletedExecutionInstruction triggerInstructionCode) {
    }

}

原文：http://www.open-open.com/lib/view/open1423663054857.html

http://blog.csdn.net/zxl315/article/details/10830105

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程