一、什么是Quartz

Quartz是OpenSymphony開源組織在Job scheduling領域又一個開源項目

二、什么是Quartz

Quartz是一個強大任務調度框架，我工作時候會在這些情況下使用到quartz框架，當然還有很多的應用場景，在這里只列舉2個實際用到的
餐廳系統會在每周四晚上的22點自動審核并生成報表
人事系統會在每天早晨8點給有待辦的人員自動發送Email提醒

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

三、使用Quartz之前的準備

1.建立一個Maven項目

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>

四、編寫第一個Quartz任務案例 - 每隔3秒鐘打印一次HelloQuartz

先實現一下這個基本的Quartz的任務再來介紹一下Quartz的3個重要組成，JobDetail，Trigger，Scheduler

1.創建一個類 MyJob.java，這個類是編寫我們的具體要實現任務（打印Hello Quartz）

這個類一定要實現job接口 這個接口里只有一個方法 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.創建一個類QuartzTest .java，這個是具體觸發我們的任務

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

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

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

4.一句話看懂quartz

1、創建調度工廠(); 　　 //工廠模式
2、根據工廠取得調度器實例(); 　　//工廠模式
3、Builder模式構建子組件<Job,Trigger> 　　 // builder模式, 如JobBuilder、TriggerBuilder、DateBuilder
4、通過調度器組裝子組件 調度器.組裝<子組件1,子組件2…> 　　//工廠模式
5、調度器.start();　　 //工廠模式

五.圖看quartz

五、第二個案例 - 每日的9點40分觸發任務打印HelloQuartz

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

1.編寫任務類 SecondJob.java，具體情況編寫具體內容，如生成報表，發送郵件。

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

2.編寫任務觸發類 QuartzTest.java

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

六、cron表達式編寫規則

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

1.　Quartz Cron 表達式支持7個域 ,分別是秒/分/時/日/月/周/年.期中年是非必須項.如下圖

注意在cron表達式中不區分大小寫.

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

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

減號(-)：表達一個范圍，如在小時字段中使用“10-12”，則表示從10到12點，即10,11,12；

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

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

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

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

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

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

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

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

2.官方的一些案例

七、Quartz的三個基本要素

Quartz對任務調度的領域問題進行了高度的抽象，提出了調度器、任務和觸發器這3個核心的概念，并在org.quartz通過接口和類對重要的這些核心概念進行描述：

●Job：是一個接口，只有一個方法void execute(JobExecutionContext context)，開發者實現該接口定義運行任務，JobExecutionContext類提供了調度上下文的各種信息。Job運行時的信息保存在JobDataMap實例中；

●JobDetail：Quartz在每次執行Job時，都重新創建一個Job實例，所以它不直接接受一個Job的實例，相反它接收一個Job實現類，以便運行時通過newInstance()的反射機制實例化Job。因此需要通過一個類來描述Job的實現類及其它相關的靜態信息，如Job名字、描述、關聯監聽器等信息，JobDetail承擔了這一角色。

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

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

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

假設，我們安排每周星期一早上10:00執行任務，但是如果碰到法定的節日，任務則不執行，這時就需要在Trigger觸發機制的基礎上使用Calendar進行定點排除。針對不同時間段類型，Quartz在org.quartz.impl.calendar包下提供了若干個Calendar的實現類，如AnnualCalendar、MonthlyCalendar、WeeklyCalendar分別針對每年、每月和每周進行定義；

●Scheduler：代表一個Quartz的獨立運行容器，Trigger和JobDetail可以注冊到Scheduler中，兩者在Scheduler中擁有各自的組及名稱，組及名稱是Scheduler查找定位容器中某一對象的依據，Trigger的組及名稱必須唯一，JobDetail的組和名稱也必須唯一（但可以和Trigger的組和名稱相同，因為它們是不同類型的）。Scheduler定義了多個接口方法，允許外部通過組及名稱訪問和控制容器中Trigger和JobDetail。

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

●ThreadPool：Scheduler使用一個線程池作為任務運行的基礎設施，任務通過共享線程池中的線程提高運行效率。

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

正因為這個原因，無狀態的Job可以并發執行，而有狀態的StatefulJob不能并發執行，這意味著如果前次的StatefulJob還沒有執行完畢，下一次的任務將阻塞等待，直到前次任務執行完畢。有狀態任務比無狀態任務需要考慮更多的因素，程序往往擁有更高的復雜度，因此除非必要，應該盡量使用無狀態的Job。

如果Quartz使用了數據庫持久化任務調度信息，無狀態的JobDataMap僅會在Scheduler注冊任務時保持一次，而有狀態任務對應的JobDataMap在每次執行任務后都會進行保存。

Trigger自身也可以擁有一個JobDataMap，其關聯的Job可以通過JobExecutionContext#getTrigger().getJobDataMap()獲取Trigger中的JobDataMap。不管是有狀態還是無狀態的任務，在任務執行期間對Trigger的JobDataMap所做的更改都不會進行持久，也即不會對下次的執行產生影響。

Quartz擁有完善的事件和監聽體系，大部分組件都擁有事件，如任務執行前事件、任務執行后事件、觸發器觸發前事件、觸發后事件、調度器開始事件、關閉事件等等，可以注冊相應的監聽器處理感興趣的事件。

八.JobDetail & Job和JobDataMap

JobDetail是任務的定義，而Job是任務的執行邏輯。在JobDetail里會引用一個Job Class定義。

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

1.編寫觸發類

public static void demo2()throws Exception{//1. 創建一個JobDetail，把實現了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();//創建schedule實例StdSchedulerFactory factory = new StdSchedulerFactory();//獲取調度器實例Scheduler scheduler = factory.getScheduler();//開啟調度器scheduler.start();//把SimpleTrigger和JobDetail注冊給調度器scheduler.scheduleJob(jobDetail,trigger);}

2.編寫具體任務類

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

總結

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

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。