一、什么是Quartz

Quartz是OpenSymphony開源組織在Job scheduling領(lǐng)域又一個(gè)開源項(xiàng)目

二、什么是Quartz

Quartz是一個(gè)強(qiáng)大任務(wù)調(diào)度框架，我工作時(shí)候會在這些情況下使用到quartz框架，當(dāng)然還有很多的應(yīng)用場景，在這里只列舉2個(gè)實(shí)際用到的
餐廳系統(tǒng)會在每周四晚上的22點(diǎn)自動審核并生成報(bào)表
人事系統(tǒng)會在每天早晨8點(diǎn)給有待辦的人員自動發(fā)送Email提醒

Quartz是一個(gè)完全由java編寫的開源作業(yè)調(diào)度框架。不要讓作業(yè)調(diào)度這個(gè)術(shù)語嚇著你。 盡管Quartz框架整合了許多額外功能， 但就其簡易形式看，你會發(fā)現(xiàn)它易用得簡直讓人受不了！ 簡單地創(chuàng)建一個(gè)實(shí)現(xiàn)org.quartz.Job接口的java類。Job接口包含唯一的方法： public void execute(JobExecutionContext context) throws JobExecutionException; 在你的Job接口實(shí)現(xiàn)類里面，添加一些邏輯到execute()方法。 一旦你配置好Job實(shí)現(xiàn)類并設(shè)定好調(diào)度時(shí)間表，Quartz將密切注意剩余時(shí)間。 當(dāng)調(diào)度程序確定該是通知你的作業(yè)的時(shí)候，Quartz框架將調(diào)用你Job實(shí)現(xiàn)類（作業(yè)類）上的execute()方法并允許做它該做的事情。 無需報(bào)告任何東西給調(diào)度器或調(diào)用任何特定的東西。 僅僅執(zhí)行任務(wù)和結(jié)束任務(wù)即可。如果配置你的作業(yè)在隨后再次被調(diào)用，Quartz框架將在恰當(dāng)?shù)臅r(shí)間再次調(diào)用它。

三、使用Quartz之前的準(zhǔn)備

1.建立一個(gè)Maven項(xiàng)目

2.引入quartz的依賴

使用quartz，我們僅僅需要在maven的pom文件中添加依賴即可。我使用的是版本2.3.0，大家可以在maven的倉庫獲取到最新的版本依賴，地址：http://mvnrepository.com/artifact/org.quartz-scheduler/quartz

<!-- https://mvnrepository.com/artifact/org.quartz-scheduler/quartz --> <dependency><groupId>org.quartz-scheduler</groupId><artifactId>quartz</artifactId><version>2.3.0</version> </dependency>

四、編寫第一個(gè)Quartz任務(wù)案例 - 每隔3秒鐘打印一次HelloQuartz

先實(shí)現(xiàn)一下這個(gè)基本的Quartz的任務(wù)再來介紹一下Quartz的3個(gè)重要組成，JobDetail，Trigger，Scheduler

1.創(chuàng)建一個(gè)類 MyJob.java，這個(gè)類是編寫我們的具體要實(shí)現(xiàn)任務(wù)（打印Hello Quartz）

這個(gè)類一定要實(shí)現(xiàn)job接口 這個(gè)接口里只有一個(gè)方法 execute

import org.quartz.Job; import org.quartz.JobExecutionContext; import org.quartz.JobExecutionException;public class MyJob implements Job {@Overridepublic void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {System.out.println("Hello Quartz");} }

2.創(chuàng)建一個(gè)類QuartzTest .java，這個(gè)是具體觸發(fā)我們的任務(wù)

第二步 雖然你寫了一個(gè)類 實(shí)現(xiàn)了job 你得讓quartz知道它是來做什么工作 這個(gè)類是你自己寫的 這里就涉及到一個(gè)組件 JobDetail

public class QuartzTest {public static void demo1()throws Exception{//1. 創(chuàng)建一個(gè)JobDetail，把實(shí)現(xiàn)了Job接口的類邦定到JobDetail 構(gòu)建者模式 綁定job withIdentity這里起一個(gè)唯一的名字JobDetail jobDetail= JobBuilder.newJob(MyJob.class).withIdentity("demo1").build();//第二個(gè)組件 Trigger觸發(fā)器//2.創(chuàng)建一個(gè)Trigger觸發(fā)器的實(shí)例，定義該job立即執(zhí)行，并且每2秒執(zhí)行一次，一直執(zhí)行 repeatForever重復(fù)SimpleTrigger trigger= TriggerBuilder.newTrigger().withIdentity("trriger1").startNow().withSchedule(SimpleScheduleBuilder.simpleSchedule().withIntervalInSeconds(2).repeatForever()).build();//創(chuàng)建schedule實(shí)例 三 調(diào)度器 StdSchedulerFactory 工廠模式StdSchedulerFactory factory = new StdSchedulerFactory();//獲取調(diào)度器實(shí)例Scheduler scheduler = factory.getScheduler();//開啟調(diào)度器scheduler.start();//把SimpleTrigger和JobDetail注冊給調(diào)度器scheduler.scheduleJob(jobDetail,trigger);}public static void main(String[] args) throws Exception {demo1();}}

3.執(zhí)行main方法，Run 'QuartzTest .main()

4.一句話看懂quartz

1、創(chuàng)建調(diào)度工廠(); 　　 //工廠模式
2、根據(jù)工廠取得調(diào)度器實(shí)例(); 　　//工廠模式
3、Builder模式構(gòu)建子組件<Job,Trigger> 　　 // builder模式, 如JobBuilder、TriggerBuilder、DateBuilder
4、通過調(diào)度器組裝子組件 調(diào)度器.組裝<子組件1,子組件2…> 　　//工廠模式
5、調(diào)度器.start();　　 //工廠模式

五.圖看quartz

五、第二個(gè)案例 - 每日的9點(diǎn)40分觸發(fā)任務(wù)打印HelloQuartz

與上一個(gè)的簡單案例的區(qū)別在于，SimpleTrigger/CronTrigger. 簡單的定時(shí)任務(wù),可以采用SimpleTrigger,復(fù)雜的任務(wù)一般采用CronTrigger.cronTrigger不僅可以設(shè)定單的觸發(fā)時(shí)間表,更可以設(shè)定非常復(fù)雜的觸發(fā)時(shí)間表。 CronTrigger 是基于 Unix類似于 cron 表達(dá)式,如果對cron表達(dá)式比較熟悉,那么學(xué)習(xí)起來經(jīng)非常簡單. 即使對cron表達(dá)式不熟悉,花一會兒的功夫也可以學(xué)會。（在工作中我們直接使用網(wǎng)上的在線生成表達(dá)式即可又快又準(zhǔn)確）生成地址：http://cron.qqe2.com/
先上代碼，然后介紹一下cron表達(dá)式生成規(guī)則。

1.編寫任務(wù)類 SecondJob.java，具體情況編寫具體內(nèi)容，如生成報(bào)表，發(fā)送郵件。

public class SecondJob implements Job{public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {//打印當(dāng)前的執(zhí)行時(shí)間 Date date = new Date();SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");System.out.println("現(xiàn)在的時(shí)間是："+ sf.format(date));//具體的業(yè)務(wù)邏輯System.out.println("開始生成任務(wù)報(bào)表 或 開始發(fā)送郵件");} }

2.編寫任務(wù)觸發(fā)類 QuartzTest.java

public static void demo2()throws Exception{//1. 創(chuàng)建一個(gè)JobDetail，把實(shí)現(xiàn)了Job接口的類邦定到JobDetailJobDetail jobDetail= JobBuilder.newJob(SecondJob.class).withIdentity("demo2").build();//每日的10點(diǎn)50分45秒觸發(fā)任務(wù)CronTrigger trigger=TriggerBuilder.newTrigger().withIdentity("trriger2").withSchedule(CronScheduleBuilder.cronSchedule("45 50 10 * * ?")).build();//創(chuàng)建schedule實(shí)例StdSchedulerFactory factory = new StdSchedulerFactory();//獲取調(diào)度器實(shí)例Scheduler scheduler = factory.getScheduler();//開啟調(diào)度器scheduler.start();//把SimpleTrigger和JobDetail注冊給調(diào)度器scheduler.scheduleJob(jobDetail,trigger);}

六、cron表達(dá)式編寫規(guī)則

今年的8月30是星期一 那么明年30號就不是星期一了

1.　Quartz Cron 表達(dá)式支持7個(gè)域 ,分別是秒/分/時(shí)/日/月/周/年.期中年是非必須項(xiàng).如下圖

注意在cron表達(dá)式中不區(qū)分大小寫.

星號(*)：可用在所有字段中，表示對應(yīng)時(shí)間域的每一個(gè)時(shí)刻，例如， 在分鐘字段時(shí)，表示“每分鐘”；

問號（?）：該字符只在日期和星期字段中使用，它通常指定為“無意義的值”，相當(dāng)于點(diǎn)位符；

減號(-)：表達(dá)一個(gè)范圍，如在小時(shí)字段中使用“10-12”，則表示從10到12點(diǎn)，即10,11,12；

逗號(,)：表達(dá)一個(gè)列表值，如在星期字段中使用“MON,WED,FRI”，則表示星期一，星期三和星期五；

斜杠(/)：x/y表達(dá)一個(gè)等步長序列，x為起始值，y為增量步長值。如在分鐘字段中使用0/15，則表示為0,15,30和45秒，而5/15在分鐘字段中表示5,20,35,50，你也可以使用*/y，它等同于0/y；

L：該字符只在日期和星期字段中使用，代表“Last”的意思，但它在兩個(gè)字段中意思不同。L在日期字段中，表示這個(gè)月份的最后一天，如一月的31號，非閏年二月的28號；如果L用在星期中，則表示星期六，等同于7。但是，如果L出現(xiàn)在星期字段里，而且在前面有一個(gè)數(shù)值X，則表示“這個(gè)月的最后X天”，例如，6L表示該月的最后星期五；

W：該字符只能出現(xiàn)在日期字段里，是對前導(dǎo)日期的修飾，表示離該日期最近的工作日。例如15W表示離該月15號最近的工作日，如果該月15號是星期六，則匹配14號星期五；如果15日是星期日，則匹配16號星期一；如果15號是星期二，那結(jié)果就是15號星期二。但必須注意關(guān)聯(lián)的匹配日期不能夠跨月，如你指定1W，如果1號是星期六，結(jié)果匹配的是3號星期一，而非上個(gè)月最后的那天。W字符串只能指定單一日期，而不能指定日期范圍；

LW組合：在日期字段可以組合使用LW，它的意思是當(dāng)月的最后一個(gè)工作日；

井號(#)：該字符只能在星期字段中使用，表示當(dāng)月某個(gè)工作日。如6#3表示當(dāng)月的第三個(gè)星期五(6表示星期五，#3表示當(dāng)前的第三個(gè))，而4#5表示當(dāng)月的第五個(gè)星期三，假設(shè)當(dāng)月沒有第五個(gè)星期三，忽略不觸發(fā)；

C：該字符只在日期和星期字段中使用，代表“Calendar”的意思。它的意思是計(jì)劃所關(guān)聯(lián)的日期，如果日期沒有被關(guān)聯(lián)，則相當(dāng)于日歷中所有日期。例如5C在日期字段中就相當(dāng)于日歷5日以后的第一天。1C在星期字段中相當(dāng)于星期日后的第一天。

Cron表達(dá)式對特殊字符的大小寫不敏感，對代表星期的縮寫英文大小寫也不敏感。

2.官方的一些案例

七、Quartz的三個(gè)基本要素

Quartz對任務(wù)調(diào)度的領(lǐng)域問題進(jìn)行了高度的抽象，提出了調(diào)度器、任務(wù)和觸發(fā)器這3個(gè)核心的概念，并在org.quartz通過接口和類對重要的這些核心概念進(jìn)行描述：

●Job：是一個(gè)接口，只有一個(gè)方法void execute(JobExecutionContext context)，開發(fā)者實(shí)現(xiàn)該接口定義運(yùn)行任務(wù)，JobExecutionContext類提供了調(diào)度上下文的各種信息。Job運(yùn)行時(shí)的信息保存在JobDataMap實(shí)例中；

●JobDetail：Quartz在每次執(zhí)行Job時(shí)，都重新創(chuàng)建一個(gè)Job實(shí)例，所以它不直接接受一個(gè)Job的實(shí)例，相反它接收一個(gè)Job實(shí)現(xiàn)類，以便運(yùn)行時(shí)通過newInstance()的反射機(jī)制實(shí)例化Job。因此需要通過一個(gè)類來描述Job的實(shí)現(xiàn)類及其它相關(guān)的靜態(tài)信息，如Job名字、描述、關(guān)聯(lián)監(jiān)聽器等信息，JobDetail承擔(dān)了這一角色。

通過該類的構(gòu)造函數(shù)可以更具體地了解它的功用：JobDetail(java.lang.String name, java.lang.String group, java.lang.Class jobClass)，該構(gòu)造函數(shù)要求指定Job的實(shí)現(xiàn)類，以及任務(wù)在Scheduler中的組名和Job名稱；

●Trigger：是一個(gè)類，描述觸發(fā)Job執(zhí)行的時(shí)間觸發(fā)規(guī)則。主要有SimpleTrigger和CronTrigger這兩個(gè)子類。當(dāng)僅需觸發(fā)一次或者以固定時(shí)間間隔周期執(zhí)行，SimpleTrigger是最適合的選擇；而CronTrigger則可以通過Cron表達(dá)式定義出各種復(fù)雜時(shí)間規(guī)則的調(diào)度方案：如每早晨9:00執(zhí)行，周一、周三、周五下午5:00執(zhí)行等；

●Calendar：org.quartz.Calendar和java.util.Calendar不同，它是一些日歷特定時(shí)間點(diǎn)的集合（可以簡單地將org.quartz.Calendar看作java.util.Calendar的集合——java.util.Calendar代表一個(gè)日歷時(shí)間點(diǎn)，無特殊說明后面的Calendar即指org.quartz.Calendar）。一個(gè)Trigger可以和多個(gè)Calendar關(guān)聯(lián)，以便排除或包含某些時(shí)間點(diǎn)。

假設(shè)，我們安排每周星期一早上10:00執(zhí)行任務(wù)，但是如果碰到法定的節(jié)日，任務(wù)則不執(zhí)行，這時(shí)就需要在Trigger觸發(fā)機(jī)制的基礎(chǔ)上使用Calendar進(jìn)行定點(diǎn)排除。針對不同時(shí)間段類型，Quartz在org.quartz.impl.calendar包下提供了若干個(gè)Calendar的實(shí)現(xiàn)類，如AnnualCalendar、MonthlyCalendar、WeeklyCalendar分別針對每年、每月和每周進(jìn)行定義；

●Scheduler：代表一個(gè)Quartz的獨(dú)立運(yùn)行容器，Trigger和JobDetail可以注冊到Scheduler中，兩者在Scheduler中擁有各自的組及名稱，組及名稱是Scheduler查找定位容器中某一對象的依據(jù)，Trigger的組及名稱必須唯一，JobDetail的組和名稱也必須唯一（但可以和Trigger的組和名稱相同，因?yàn)樗鼈兪遣煌愋偷?#xff09;。Scheduler定義了多個(gè)接口方法，允許外部通過組及名稱訪問和控制容器中Trigger和JobDetail。

Scheduler可以將Trigger綁定到某一JobDetail中，這樣當(dāng)Trigger觸發(fā)時(shí)，對應(yīng)的Job就被執(zhí)行。一個(gè)Job可以對應(yīng)多個(gè)Trigger，但一個(gè)Trigger只能對應(yīng)一個(gè)Job。可以通過SchedulerFactory創(chuàng)建一個(gè)Scheduler實(shí)例。Scheduler擁有一個(gè)SchedulerContext，它類似于ServletContext，保存著Scheduler上下文信息，Job和Trigger都可以訪問SchedulerContext內(nèi)的信息。SchedulerContext內(nèi)部通過一個(gè)Map，以鍵值對的方式維護(hù)這些上下文數(shù)據(jù)，SchedulerContext為保存和獲取數(shù)據(jù)提供了多個(gè)put()和getXxx()的方法。可以通過Scheduler# getContext()獲取對應(yīng)的SchedulerContext實(shí)例；

●ThreadPool：Scheduler使用一個(gè)線程池作為任務(wù)運(yùn)行的基礎(chǔ)設(shè)施，任務(wù)通過共享線程池中的線程提高運(yùn)行效率。

Job有一個(gè)StatefulJob子接口，代表有狀態(tài)的任務(wù)，該接口是一個(gè)沒有方法的標(biāo)簽接口，其目的是讓Quartz知道任務(wù)的類型，以便采用不同的執(zhí)行方案。無狀態(tài)任務(wù)在執(zhí)行時(shí)擁有自己的JobDataMap拷貝，對JobDataMap的更改不會影響下次的執(zhí)行。而有狀態(tài)任務(wù)共享共享同一個(gè)JobDataMap實(shí)例，每次任務(wù)執(zhí)行對JobDataMap所做的更改會保存下來，后面的執(zhí)行可以看到這個(gè)更改，也即每次執(zhí)行任務(wù)后都會對后面的執(zhí)行發(fā)生影響。

正因?yàn)檫@個(gè)原因，無狀態(tài)的Job可以并發(fā)執(zhí)行，而有狀態(tài)的StatefulJob不能并發(fā)執(zhí)行，這意味著如果前次的StatefulJob還沒有執(zhí)行完畢，下一次的任務(wù)將阻塞等待，直到前次任務(wù)執(zhí)行完畢。有狀態(tài)任務(wù)比無狀態(tài)任務(wù)需要考慮更多的因素，程序往往擁有更高的復(fù)雜度，因此除非必要，應(yīng)該盡量使用無狀態(tài)的Job。

如果Quartz使用了數(shù)據(jù)庫持久化任務(wù)調(diào)度信息，無狀態(tài)的JobDataMap僅會在Scheduler注冊任務(wù)時(shí)保持一次，而有狀態(tài)任務(wù)對應(yīng)的JobDataMap在每次執(zhí)行任務(wù)后都會進(jìn)行保存。

Trigger自身也可以擁有一個(gè)JobDataMap，其關(guān)聯(lián)的Job可以通過JobExecutionContext#getTrigger().getJobDataMap()獲取Trigger中的JobDataMap。不管是有狀態(tài)還是無狀態(tài)的任務(wù)，在任務(wù)執(zhí)行期間對Trigger的JobDataMap所做的更改都不會進(jìn)行持久，也即不會對下次的執(zhí)行產(chǎn)生影響。

Quartz擁有完善的事件和監(jiān)聽體系，大部分組件都擁有事件，如任務(wù)執(zhí)行前事件、任務(wù)執(zhí)行后事件、觸發(fā)器觸發(fā)前事件、觸發(fā)后事件、調(diào)度器開始事件、關(guān)閉事件等等，可以注冊相應(yīng)的監(jiān)聽器處理感興趣的事件。

八.JobDetail & Job和JobDataMap

JobDetail是任務(wù)的定義，而Job是任務(wù)的執(zhí)行邏輯。在JobDetail里會引用一個(gè)Job Class定義。

每一個(gè)JobDetail都會有一個(gè)JobDataMap。JobDataMap本質(zhì)就是一個(gè)Map的擴(kuò)展類，只是提供了一些更便捷的方法，比如getString()之類的。

1.編寫觸發(fā)類

public static void demo2()throws Exception{//1. 創(chuàng)建一個(gè)JobDetail，把實(shí)現(xiàn)了Job接口的類邦定到JobDetailJobDetail jobDetail= JobBuilder.newJob(SecondJob.class).withIdentity("demo2").usingJobData("name","zhangan").usingJobData("age",22).build();CronTrigger trigger=TriggerBuilder.newTrigger().withIdentity("trriger2").withSchedule(CronScheduleBuilder.cronSchedule("45 50 10 * * ?")).build();//創(chuàng)建schedule實(shí)例StdSchedulerFactory factory = new StdSchedulerFactory();//獲取調(diào)度器實(shí)例Scheduler scheduler = factory.getScheduler();//開啟調(diào)度器scheduler.start();//把SimpleTrigger和JobDetail注冊給調(diào)度器scheduler.scheduleJob(jobDetail,trigger);}

2.編寫具體任務(wù)類

public class SecondJob implements Job {@Overridepublic void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {//打印當(dāng)前的執(zhí)行時(shí)間 例如 2021-08-30 10:12:00Date date = new Date();//格式化時(shí)間SimpleDateFormat sf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");System.out.println("現(xiàn)在的時(shí)間是："+ sf.format(date));//具體的業(yè)務(wù)邏輯System.out.println("開始生成任務(wù)報(bào)表 或 開始發(fā)送郵件");JobDataMap jobDataMap = jobExecutionContext.getJobDetail().getJobDataMap();String name= jobDataMap.getString("name");int age= jobDataMap.getInt("age");System.out.println("name="+name+",age="+age);} }

總結(jié)

以上是生活随笔為你收集整理的quartz怎么玩？（基本使用和入门）的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。