Quartz入門-v2.2.2

原文地址:Getting Started with Quartz Scheduler
本文中“工作”對(duì)應(yīng)“job”,“任務(wù)”對(duì)應(yīng)“task”。關(guān)系是工作是若干任務(wù)的集合,任務(wù)是工作中需要做的具體事情。通俗的例子,“教師”是一個(gè)“工作”,它包含的具體“任務(wù)”有{“備課”,“上課”,“批改作業(yè)”,... }

什么是Quartz Scheduler?

Quartz Scheduler是一個(gè)功能豐富的開源的工作調(diào)度庫,可以被真實(shí)地整合到任何Java應(yīng)用中--從最小的獨(dú)立應(yīng)用到最大的電商系統(tǒng)。Quartz可以被用來構(gòu)建簡單或者復(fù)雜的調(diào)度,用來執(zhí)行十個(gè)、百個(gè)或者甚至萬個(gè)工作。任務(wù)被定義為標(biāo)準(zhǔn)的Java組件,這些組件會(huì)真實(shí)地執(zhí)行任何你通過編程指定給它們的事情。Quartz Schedulers包含了許多的企業(yè)級(jí)類的特性,比如它支持JTA事務(wù)和集群。

Quartz可以為你做什么?

如果你的應(yīng)用中有一些任務(wù)需要在給定的一個(gè)時(shí)候及時(shí)地執(zhí)行,或者如果你的系統(tǒng)有一些循環(huán)的維護(hù)工作,那么Quartz會(huì)是你理想中的解決方案。
使用Quartz來工作調(diào)度例子:

  • 驅(qū)動(dòng)過程工作流:當(dāng)一個(gè)新的訂單被初始化后,調(diào)度一個(gè)工作來在2個(gè)小時(shí)內(nèi)精確的執(zhí)行,它會(huì)檢查訂單的狀態(tài)。并且如果一個(gè)關(guān)于這個(gè)訂單確認(rèn)信息還沒有收到的話,會(huì)觸發(fā)一個(gè)警告通知,同時(shí)改變訂單的狀態(tài)為“等待介入”。
  • 系統(tǒng)維護(hù):調(diào)度一個(gè)工作在每個(gè)工作日的11:30PM,去將數(shù)據(jù)庫的內(nèi)容倒入一個(gè)XML文件。
  • 在一個(gè)應(yīng)用中提供提醒服務(wù)。

Quartz特色功能


運(yùn)行時(shí)環(huán)境

  • Quartz可以嵌入式地運(yùn)行在另一個(gè)完全獨(dú)立的應(yīng)用中
  • Quartz可以在一個(gè)應(yīng)用服務(wù)器(或者servlet容器)中被實(shí)例化,并且加入到XA事務(wù)中
  • Quartz可以作為一個(gè)獨(dú)立的程序運(yùn)行(使用它自己的JVM),通過RMI的方式被使用
  • Quartz可以作為一個(gè)獨(dú)立程序(有著負(fù)載均衡和容錯(cuò)能力)的集群被實(shí)例化,來執(zhí)行工作

工作調(diào)度

當(dāng)一個(gè)給定的觸發(fā)器發(fā)生的時(shí)候,工作將被調(diào)度。觸發(fā)器幾乎可以被創(chuàng)建為任何下面的策略,包括:

  • 一天中一個(gè)確定的時(shí)間(精確到毫秒)
  • 一周中確定的日子
  • 一月中確定的日子
  • 一年中確定的日子
  • 在一個(gè)注冊(cè)的日歷中排除一些確定的日子(比如法定假日)
  • 重復(fù)一個(gè)確定的次數(shù)
  • 重復(fù)直到一個(gè)確定的時(shí)間/日期
  • 無限重復(fù)
  • 延遲一段時(shí)間重復(fù)

工作被它們的創(chuàng)建者給定名字,并同樣可以通過組名將它們分組。觸發(fā)器同樣會(huì)被指定名字并放入組中,為了更容易地在調(diào)度過程中組織它們。工作可以被一次性地添加到調(diào)度器中,然而被多個(gè)觸發(fā)器所注冊(cè)。在一個(gè)企業(yè)級(jí)的Java環(huán)境中,工作會(huì)執(zhí)行它們的任務(wù)作為一個(gè)分布式(XA)事務(wù)的一部分。

工作執(zhí)行

  • 工作可以是任何實(shí)現(xiàn)了簡單Job接口的Java類,為你工作能做的事情留下了無限的可能。
  • 工作類的實(shí)例可以通過Quartz被實(shí)例化,活著通過你的應(yīng)用的框架。
  • 當(dāng)一個(gè)觸發(fā)器發(fā)生的時(shí)候,調(diào)度器會(huì)通知0個(gè)或更多Java對(duì)象去實(shí)現(xiàn)JobListener和TriggerListener接口(listener可以是簡單的Java對(duì)象,或者EJB,或者JMS發(fā)布者,等等)。這些監(jiān)聽器在工作執(zhí)行以后同樣會(huì)被通知。
  • 當(dāng)工作完成,它們返回一個(gè)JobCompletionCode來告訴調(diào)度器是成功還是失敗。JobCompletionCode同樣會(huì)指示調(diào)度器的任何它應(yīng)該根據(jù)成功/失敗碼所進(jìn)行的行為,比如立刻重新執(zhí)行工作。

工作持久化

  • Quartz的設(shè)計(jì)包含了一個(gè)JobStore接口,它可以被實(shí)現(xiàn)來提供各種各樣的機(jī)制來存儲(chǔ)工作。
  • 通過使用JDBCJobStore,所有的工作和觸發(fā)器都被配置為“non-volatile”被通過JDBC存儲(chǔ)在一個(gè)關(guān)系型數(shù)據(jù)庫中。
  • 通過使用RAMJobStore,所有的工作和觸發(fā)器都被存在RAM中,并且在程序執(zhí)行之間不會(huì)持久化--但是這有一個(gè)好處就是不需要一個(gè)外部的數(shù)據(jù)庫。

事務(wù)

  • Quartz可以參與到JTA事務(wù)中,通過使用JobStoreCMT(一個(gè)JDBCJobStore的子類)。
  • Quartz可以管理JTA事務(wù)(開始并提交它們)在工作執(zhí)行的時(shí)候,以便于工作在做的事情在一個(gè)JTA事務(wù)中可以自動(dòng)地發(fā)生。

集群特性

  • 提供容錯(cuò)
  • 提供負(fù)載均衡
  • Quartz的內(nèi)建集群特性依賴于通過JDBCJobStore的數(shù)據(jù)庫實(shí)例化。
  • Terracotta對(duì)Quartz提供的擴(kuò)展提供了集群能力,而不需要一個(gè)后端的數(shù)據(jù)庫。

監(jiān)聽器 & 插件

  • 應(yīng)用可以通過實(shí)現(xiàn)一個(gè)或多個(gè)監(jiān)聽器接口來捕獲調(diào)度時(shí)間來監(jiān)視或者控制job/trigger的行為。
  • 插件機(jī)制可以被用來添加功能到Quartz,如此保持一個(gè)工作執(zhí)行的歷史,或者從一個(gè)文件中加載job和trigger。
  • Quartz通過整合一些“工廠構(gòu)建”插件和監(jiān)聽器來運(yùn)行。

下載和安裝Quartz


首先,從http://quartz-scheduler.org/downloads下載最新的穩(wěn)定版本。注冊(cè)不是必須的。解壓發(fā)行包并安裝使得你的應(yīng)用可以看到它。

Quartz的jar文件

Quartz的包里有若干jar文件,在發(fā)行包的根目錄下。主要的Quartz庫的名字叫做quartz-xxx.jar(xxx是版本號(hào))。為了使用任何Quartz的特性,這個(gè)jar必須放置在你應(yīng)用的classpath下面。
如果你使用Quartz主要在一個(gè)應(yīng)用服務(wù)器的環(huán)境,你可以將Quartz JAR放置在你的應(yīng)用中(.ear或者.war文件)。如果你想使Quartz對(duì)于許多應(yīng)用都可用,確保它在你應(yīng)用服務(wù)器中classpath下面。如果你正在一個(gè)獨(dú)立的應(yīng)用中使用它,將它放置在應(yīng)用的classpath下,并把你應(yīng)用所依賴的其它JAR文件也放置過去。
Quartz依賴若干第三方的庫(通過jar的形式),它們?cè)?zip發(fā)布包的lib目錄下。為了使用Quartz的所有特性,這些jar必須同樣存在于你的classpath下。如果你在構(gòu)建一個(gè)獨(dú)立的Quartz應(yīng)用,請(qǐng)?zhí)砑铀械膸斓絚lasspath下。

注意:在一個(gè)應(yīng)用服務(wù)器的環(huán)境,如果環(huán)境中包含不同版本的相同的jar包,那么不可預(yù)見的結(jié)果可能會(huì)出現(xiàn)。比如,WebLogic包含一個(gè)J2EE的實(shí)現(xiàn)(在weblogic.jar里),這有可能和servlet.jar中的那個(gè)不同。在這種情況下,將servlet.jar排除在你的應(yīng)用之外通常是更好的做法,以便于你知道哪個(gè)類正在被使用。

屬性文件

Quartz使用一個(gè)叫做quartz.properties的屬性文件。這個(gè)文件最初不是必須的,但是當(dāng)你想要使用任何基本配置以外的東西時(shí),就需要用到它。當(dāng)你使用這個(gè)文件,它必須在你的classpath下面。
如果你在構(gòu)建一個(gè)web應(yīng)用(比如,一個(gè).war文件的形式),你可以將quartz.properties文件放在WEB-INF/classes文件夾下,從而放置在了應(yīng)用的classpath下。

提示:如果你使用WebLogic Workshop開發(fā)你的應(yīng)用,你可以保留你的配置文件(包括quartz.properties)在你應(yīng)用的根目錄下面的一個(gè)項(xiàng)目中。當(dāng)你打包你的應(yīng)用到一個(gè).ear文件中時(shí),配置項(xiàng)目將會(huì)把最終的.ear中包含的打包到一個(gè).jar中。這樣做將會(huì)自動(dòng)的將quartz.properties文件放置在你的classpath下。

配置Quartz調(diào)度器


為了配置Quartz,你編輯quartz.properties文件,并把它放置在你的application的classpath下面。

注意:Quartz調(diào)度器的發(fā)布包中包含了若干quartz.properties文件的例子在example/directory中。

下面的例子展示了一個(gè)基本的quartz.properties文件的內(nèi)容:

org.quartz.scheduler.instanceName = MyScheduler
org.quartz.threadPool.threadCount = 3
org.quartz.jobStore.class = org.quartz.simpl.RAMJobStore

這個(gè)例子指定了以下的屬性:

  • org.quartz.scheduler.instanceName屬性為調(diào)度器分配了一個(gè)名字為“MyScheduler”。
  • org.quartz.threadPool.threadCount屬性在線程池中分配了三個(gè)線程,意味著最多三個(gè)job同時(shí)進(jìn)行。
  • org.quartz.jobStore.class屬性配置調(diào)度器去使用RAMJobStore來進(jìn)行數(shù)據(jù)存儲(chǔ)。這意味著調(diào)度器將會(huì)保持這個(gè)job和trigger的數(shù)據(jù)在內(nèi)存中而不是數(shù)據(jù)庫。

開始一個(gè)示例應(yīng)用


下面的代碼獲取一個(gè)調(diào)度器實(shí)力,啟動(dòng)它,然后關(guān)閉它。
Quartz.java

import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.impl.StdSchedulerFactory;
import static org.quartz.JobBuilder.*;
import static org.quartz.TriggerBuilder.*;
import static org.quartz.SimpleScheduleBuilder.*;

注意:一旦你使用StdSchedulerFactory.getDefaultScheduler()獲得了一個(gè)調(diào)度器,你的應(yīng)用將會(huì)一直運(yùn)行直到你調(diào)用了scheduler.shutdown()。因?yàn)檫@將是活動(dòng)的線程。

注意這里使用了static引入,這將在下面的代碼中發(fā)揮作用。
如果你還沒有設(shè)置日志,日志的信息將會(huì)被發(fā)送到console中。你的輸出將像下面這樣:

[INFO] 21 Jan 08:46:27.857 AM main [org.quartz.core.QuartzScheduler]
Quartz Scheduler v.2.0.0-SNAPSHOT created.
[INFO] 21 Jan 08:46:27.859 AM main [org.quartz.simpl.RAMJobStore]
RAMJobStore initialized.
[INFO] 21 Jan 08:46:27.865 AM main [org.quartz.core.QuartzScheduler]
Scheduler meta-data: Quartz Scheduler (v2.0.0) 'Scheduler' with instanceId 'NON_CLUSTERED'
  Scheduler class: 'org.quartz.core.QuartzScheduler' - running locally.
  NOT STARTED.
  Currently in standby mode.
  Number of jobs executed: 0
  Using thread pool 'org.quartz.simpl.SimpleThreadPool' - with 50 threads.
  Using job-store 'org.quartz.simpl.RAMJobStore' - which does not support
        persistence. and is not clustered.
[INFO] 21 Jan 08:46:27.865 AM main [org.quartz.impl.StdSchedulerFactory]
Quartz scheduler 'Scheduler' initialized from default resource file in Quartz
         package: 'quartz.properties'
[INFO] 21 Jan 08:46:27.866 AM main [org.quartz.impl.StdSchedulerFactory]
Quartz scheduler version: 2.0.0
[INFO] 21 Jan 08:46:27.866 AM main [org.quartz.core.QuartzScheduler]
Scheduler Scheduler_$_NON_CLUSTERED started.
[INFO] 21 Jan 08:46:27.866 AM main [org.quartz.core.QuartzScheduler]
Scheduler Scheduler_$_NON_CLUSTERED shutting down.
[INFO] 21 Jan 08:46:27.866 AM main [org.quartz.core.QuartzScheduler]
Scheduler Scheduler_$_NON_CLUSTERED paused.
[INFO] 21 Jan 08:46:27.867 AM main [org.quartz.core.QuartzScheduler]
Scheduler Scheduler_$_NON_CLUSTERED shutdown complete.

為了做一些事情,你需要在start()shutdown()的調(diào)用之間提供一些代碼。你將同樣需要允許一些時(shí)候在調(diào)用shutdown()之前,對(duì)job進(jìn)行觸發(fā)和執(zhí)行。對(duì)于一個(gè)簡單的像這樣的例子,你應(yīng)該調(diào)用:

Thread.sleep(60000);
// define the job and tie it to our HelloJob class
JobDetail job = newJob(HelloJob.class)
    .withIdentity("job1", "group1")
    .build();
// Trigger the job to run now, and then repeat every 40 seconds
Trigger trigger = newTrigger()
    .withIdentity("trigger1", "group1")
    .startNow()
    .withSchedule(simpleSchedule()
            .withIntervalInSeconds(40)
            .repeatForever())
    .build();
// Tell quartz to schedule the job using our trigger
scheduler.scheduleJob(job, trigger);
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

推薦閱讀更多精彩內(nèi)容