Quzrtz的使用

使用SimpleTrigger 

SimpleTrigger擁有多個重載的構造函數，用以在不一樣場合下構造出對應的實例： 

• SimpleTrigger(String name, String group)：經過該構造函數指定Trigger所屬組和名稱；
• SimpleTrigger(String name, String group, Date startTime)：除指定Trigger所屬組和名稱外，還能夠指定觸發的開發時間；
• SimpleTrigger(String name, String group, Date startTime, Date endTime, int repeatCount, long repeatInterval)：除指定以上信息外，還能夠指定結束時間、重複執行次數、時間間隔等參數； 
• SimpleTrigger(String name, String group, String jobName, String jobGroup, Date startTime, Date endTime, int repeatCount, long repeatInterval)：這是最複雜的一個構造函數，在指定觸發參數的同時，還經過jobGroup和jobName，讓該Trigger和 Scheduler中的某個任務關聯起來。

 

經過實現 org.quartz.Job 接口，可使 Java 類化身爲可調度的任務。代碼清單1提供了 Quartz 任務的一個示例： 

代碼清單1   SimpleJob：簡單的Job實現類

import java.util.Date;

import org.quartz.Job;

import org.quartz.JobExecutionContext;

import org.quartz.JobExecutionException;

 

public class SimpleJob implements Job { 

①實例Job接口方法

public void  execute(JobExecutionContext jobCtx) throws JobExecutionException { 

    System.out.println(jobCtx.getTrigger().getName()+ " triggered. time is:" + (new Date())); 

    } 

}

這個類用一條很是簡單的輸出語句實現了Job接口的execute(JobExecutionContext context) 方法，這個方法能夠包含想要執行的

任何代碼。

 

下面，咱們經過SimpleTrigger對SimpleJob進行調度：

代碼清單2  SimpleTriggerRunner：使用SimpleTrigger進行調度

import java.util.Date; 

import org.quartz.JobDetail; 

import org.quartz.Scheduler; 

import org.quartz.SchedulerFactory; 

import org.quartz.SimpleTrigger; 

import org.quartz.impl.StdSchedulerFactory; 

public class SimpleTriggerRunner {

 

    public static void main(String[] args) {

        try {

            // ① 建立一個JobDetail實例，指定SimpleJob

            JobDetail jobDetail = new JobDetail("job1_1", "jGroup1", SimpleJob.class);

            // ② 經過SimpleTrigger定義調度規則：立刻啓動，每2秒運行一次，共運行100次

            SimpleTrigger simpleTrigger = new SimpleTrigger("trigger1_1", "tgroup1");

            simpleTrigger.setStartTime(new Date());

            simpleTrigger.setRepeatInterval(2000);

            simpleTrigger.setRepeatCount(100);

            // ③ 經過SchedulerFactory獲取一個調度器實例

            SchedulerFactory schedulerFactory = new StdSchedulerFactory();

            Scheduler scheduler = schedulerFactory.getScheduler();

            // ④ 註冊並進行調度

            scheduler.scheduleJob(jobDetail, simpleTrigger);

            // ⑤ 調度啓動

            scheduler.start();

        } catch (Exception e) {

            e.printStackTrace();

        }

    }

}

 

首先在①處經過JobDetail封裝SimpleJob，同時指定Job在Scheduler中所屬組及名稱，這裏，組名爲jGroup1，而名稱爲job1_1。

在②處建立一個SimpleTrigger實例，指定該Trigger在Scheduler中所屬組及名稱。接着設置調度的時間規則。 最後，須要建立Scheduler實例，並將JobDetail和Trigger實例註冊到Scheduler中。這裏，咱們經過 StdSchedulerFactory獲取一個Scheduler實例，並經過scheduleJob(JobDetail jobDetail, Trigger trigger)完成兩件事： 

1. 將JobDetail和Trigger註冊到Scheduler中；
2. 將Trigger指派給JobDetail，將二者關聯起來。

當Scheduler啓動後，Trigger將按期觸發並執行SimpleJob的execute(JobExecutionContext jobCtx)方法，而後每 10 秒重複一次，直到任務被執行 100 次後中止。還能夠經過SimpleTrigger的setStartTime(java.util.Date startTime)和setEndTime(java.util.Date endTime)指定運行的時間範圍，當運行次數和時間範圍衝突時，超過期間範圍的任務運行不被執行。如能夠經過impleTrigger.setStartTime(new Date(System.currentTimeMillis() + 60000L))指定60秒鐘之後開始。除了經過scheduleJob(jobDetail, simpleTrigger)創建Trigger和JobDetail的關聯，還有另一種關聯Trigger和JobDetail的方式：

JobDetail jobDetail = new JobDetail("job1_1", "jGroup1", SimpleJob.class);

            SimpleTrigger simpleTrigger = new SimpleTrigger("trigger1_1", "tgroup1");

            simpleTrigger.setJobGroup("jGroup1"); // ①-1：指定關聯的Job組名

            simpleTrigger.setJobName("job1_1");// ①-2：指定關聯的Job名稱

            scheduler.addJob(jobDetail, true);// ② 註冊JobDetail

  scheduler.scheduleJob(simpleTrigger);//③ 註冊指定了關聯JobDetail的Trigger

在這種方式中，Trigger經過指定Job所屬組及Job名稱，而後使用Scheduler的scheduleJob(Trigger trigger)方法註冊Trigger。有兩個值得注意的地方： 經過這種方式註冊的Trigger實例必須已經指定Job組和Job名稱，不然調用註冊Trigger的方法將拋出異常；引用的JobDetail對象必須已經存在於Scheduler中。也即，代碼中①、②和③的前後順序不能互換。

在構造Trigger實例時，能夠考慮使用org.quartz.TriggerUtils工具類，該工具類不但提供了衆多獲取特定時間的方法，還擁有衆多獲取常見Trigger的方法，如makeSecondlyTrigger(String trigName)方法將建立一個每秒執行一次的Trigger，而

makeWeeklyTrigger(String trigName, int dayOfWeek, int hour, int minute)將建立一個每星期某一特定時間點執行一次的

Trigger。而getEvenMinuteDate(Date date)方法將返回某一時間點一分鐘之後的時間。        

 

使用CronTrigger 

CronTrigger 可以提供比 SimpleTrigger 更有具體實際意義的調度方案，調度規則基於 Cron 表達式，CronTrigger 支持日曆相關的重複時間間隔（好比每個月第一個週一執行），而不是簡單的週期時間間隔。所以，相對於SimpleTrigger而言，CronTrigger在使用上也要複雜一些。

Cron表達式

Quartz使用相似於Linux下的Cron表達式定義時間規則，Cron表達式由6或7個由空格分隔的時間字段組成，以下所示：

 

Cron表達式時間字段表

位置	時間域名	容許值	容許的特殊字符
1	秒	0-59	,  -  *  /
2	分鐘	0-59	,  -  *  /
3	小時	0-23	,  -  *  /
4	日期	1-31	,  -  *  ?  /  L  W  C
5	月份	1-12	,  -  *  /
6	星期	1-7	,  -  *  ?  /  L  C  #
7	年(可選)	空值1970-2099	,  -  * /

  

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表達式對特殊字符的大小寫不敏感，對錶明星期的縮寫英文大小寫也不敏感。

 

下面給出一些完整的Cron表示式的實例：

Cron表示式示例表

表示式	說明
"0 0 12 * * ? "	天天12點運行
"0 15 10 ? * *"	天天10:15運行
"0 15 10 * * ?"	天天10:15運行
"0 15 10 * * ? *"	天天10:15運行
"0 15 10 * * ? 2008"	在2008年的天天10：15運行
"0 * 14 * * ?"	天天14點到15點之間每分鐘運行一次，開始於14:00，結束於14:59
"0  0/5  14 * * ?"	天天14點到15點每5分鐘運行一次，開始於14:00，結束於14:55
"0  0/5 14,18 * * ?"	天天14點到15點每5分鐘運行一次，此外天天18點到19點每5鍾也運行一次
"0  0-5  14  *  *  ?"	天天14:00點到14:05，每分鐘運行一次
"0  10,44  14 ? 3 WED"	3月每週三的14:10分到14: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 2007-2009"	在2007,2008,2009年每月的最後一個星期五的10:15分運行
"0 15 10 ? * 6#3"	每個月第三個星期五的10:15分運行

 

 

CronTrigger實例

下面，咱們使用CronTrigger對SimpleJob進行調度，經過Cron表達式制定調度規則，讓它每5秒鐘運行一次：

 

代碼清單3  CronTriggerRunner：使用CronTrigger進行調度

import org.quartz.CronExpression;

import org.quartz.CronTrigger;

import org.quartz.JobDetail;

import org.quartz.Scheduler;

import org.quartz.SchedulerFactory;

import org.quartz.impl.StdSchedulerFactory;

 

public class CronTriggerRunner {

    public static void main(String args[]) {

        try {

            JobDetail jobDetail = new JobDetail("job1_2", "jGroup1", SimpleJob.class); // ①-1：建立CronTrigger，指定組及名稱

 

            CronTrigger cronTrigger = new CronTrigger("trigger1_2", "tgroup1");

            CronExpression cexp = new CronExpression("0/5 * * * * ?");// ①-2：定義Cron表達式

 

            cronTrigger.setCronExpression(cexp);// ①-3：設置Cron表達式

 

            SchedulerFactory schedulerFactory = new StdSchedulerFactory();

            Scheduler scheduler = schedulerFactory.getScheduler();

            scheduler.scheduleJob(jobDetail, cronTrigger);

            scheduler.start(); // ②

 

        } catch (Exception e) {

            e.printStackTrace();

        }

    }

}

運行CronTriggerRunner，每5秒鐘將觸發運行SimpleJob一次。默認狀況下Cron表達式對應當前的時區，能夠經過

 CronTriggerRunner的setTimeZone(java.util.TimeZone timeZone)方法顯式指定時區。你還也能夠經過

setStartTime(java.util.Date startTime)和setEndTime(java.util.Date endTime)指定開始和結束的時間。

在代碼清單3的②處須要經過Thread.currentThread.sleep()的方式讓主線程睡眠，以便調度器能夠繼續工做執行任務調度。不然在調度器啓動後，由於主線程立刻退出，也將同時引發調度器關閉，調度器中的任務都將相應銷燬，這將致使看不到實際的運行效果。在單元測試的時候，讓主線程睡眠常用的辦法。對於某些長週期任務調度的測試，你能夠簡單地調整操做系統時間進行模擬。 

使用Calendar 

在實際任務調度中，咱們不可能一成不變地按照某個週期性的調度規則運行任務，必須考慮到實現生活中日曆上特定日期，就象習慣了大男人做風的人在2月14號也會有不一樣表現同樣。 下面，咱們安排一個任務，每小時運行一次，並將五一節和國際節排除在外，其

代碼如代碼清單4所示：

代碼清單4  CalendarExample：使用Calendar 

import java.util.Calendar;

import java.util.Date;

import java.util.GregorianCalendar;

import org.quartz.impl.calendar.AnnualCalendar;import org.quartz.TriggerUtils;„

 

public class CalendarExample {

    public static void main(String[] args) throws Exception {

        SchedulerFactory sf = new StdSchedulerFactory();

        Scheduler scheduler = sf.getScheduler();

        // ①法定節日是以每一年爲週期的，因此使用AnnualCalendar

        AnnualCalendar holidays = new AnnualCalendar();

        // ②五一勞動節

        Calendar laborDay = new GregorianCalendar();

        laborDay.add(Calendar.MONTH, 5);

        laborDay.add(Calendar.DATE, 1);

        holidays.setDayExcluded(laborDay, true); // ②-1：排除的日期，若是設置爲false則爲包含

 

        // ③國慶節

        Calendar nationalDay = new GregorianCalendar();

        nationalDay.add(Calendar.MONTH, 10);

        nationalDay.add(Calendar.DATE, 1);

        holidays.setDayExcluded(nationalDay, true);// ③-1：排除該日期

 

        scheduler.addCalendar("holidays", holidays, false, false);// ④向Scheduler註冊日曆

 

        Date runDate = TriggerUtils.getDateOf(0, 0, 10, 1, 4);// ⑤4月1號上午10點

 

        JobDetail job = new JobDetail("job1", "group1", SimpleJob.class);

        SimpleTrigger trigger = new SimpleTrigger("trigger1", "group1", runDate, null,

                SimpleTrigger.REPEAT_INDEFINITELY, 60L * 60L * 1000L);

        trigger.setCalendarName("holidays");// ⑥讓Trigger應用指定的日曆規則

 

        scheduler.scheduleJob(job, trigger);

        scheduler.start(); // 實際應用中主線程不能中止，不然Scheduler得不到執行，此處從略

    }

}

因爲節日是每一年重複的，因此使用org.quartz.Calendar的AnnualCalendar實現類，經過②、③的代碼，指定五一和國慶兩個節日並經過AnnualCalendar#setDayExcluded(Calendar day, boolean exclude)方法添加這兩個日期。exclude爲true時表示排除指定的日期，若是爲false時表示包含指定的日期。 

在定製好org.quartz.Calendar後，還須要經過Scheduler#addCalendar(String calName, Calendar calendar, boolean replace, boolean updateTriggers)

進行註冊，若是updateTriggers爲true，Scheduler中已引用Calendar的Trigger將獲得更新，如④所示在⑥處，咱們讓一個Trigger

指定使用Scheduler中表明節日的Calendar，這樣Trigger就會避開五一和國慶這兩個特殊日子了。

 

任務調度信息存儲

在默認狀況下Quartz將任務調度的運行信息保存在內存中，這種方法提供了最佳的性能，由於內存中數據訪問最快。不足之處是缺少數據的持久性，當程序路途中止或系統崩潰時，全部運行的信息都會丟失。好比咱們但願安排一個執行100次的任務，若是執行到50

次時系統崩潰了，系統重啓時任務的執行計數器將從0開始。在大多數實際的應用中，咱們每每並不須要保存任務調度的現場數據，由於不多須要規劃一個指定執行次數的任務。

對於僅執行一次的任務來講，其執行條件信息自己應該是已經持久化的業務數據（如鎖定到期解鎖任務，解鎖的時間應該是業務數據）

，當執行完成後，條件信息也會相應改變。固然調度現場信息不只僅是記錄運行次數，還包括調度規則、JobDataMap中的數據等。

若是確實須要持久化任務調度信息，Quartz容許你經過調整其屬性文件，將這些信息保存到數據庫中。使用數據庫保存任務調度信息後，即便系統崩潰後從新啓動，任務的調度信息將獲得恢復。如前面所說的例子，執行50次崩潰後從新運行，計數器將從51開始計數。使用了數據庫保存信息的任務稱爲持久化任務。

 

經過配置文件調整任務調度信息的保存策略

其實Quartz JAR文件的org.quartz包下就包含了一個quartz.properties屬性配置文件並提供了默認設置。若是須要調整默認配置，能夠在類路徑下創建一個新的quartz.properties，它將自動被Quartz加載並覆蓋默認的設置。

先來了解一下Quartz的默認屬性配置文件： 

代碼清單5 quartz.properties：默認配置

①集羣的配置，這裏不使用集羣

org.quartz.scheduler.instanceName = DefaultQuartzScheduler 

org.quartz.scheduler.rmi.export = false 

org.quartz.scheduler.rmi.proxy = false 

org.quartz.scheduler.wrapJobExecutionInUserTransaction = false 

②配置調度器的線程池

org.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.class = org.quartz.simpl.RAMJobStore

Quartz的屬性配置文件主要包括三方面的信息：

• 1) 集羣信息； 
• 2) 調度器線程池；
• 3) 任務調度現場數據的保存。

 若是任務數目很大時，能夠經過增大線程池的大小獲得更好的性能。默認狀況下，Quartz採用org.quartz.simpl.RAMJobStore

保存任務的現場數據，顧名思義，信息保存在RAM內存中，咱們能夠經過如下設置將任務調度現場數據保存到數據庫中：

 

代碼清單6 quartz.properties：使用數據庫保存任務調度現場數據

„

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

org.quartz.jobStore.tablePrefix = QRTZ_    ①數據表前綴

org.quartz.jobStore.dataSource = qzDS   ②數據源名稱

③定義數據源的具體屬性

org.quartz.dataSource.qzDS.driver = oracle.jdbc.driver.OracleDriver 

org.quartz.dataSource.qzDS.URL = jdbc:oracle:thin:@localhost:1521:ora9i 

org.quartz.dataSource.qzDS.user = stamen 

org.quartz.dataSource.qzDS.password = abc 

org.quartz.dataSource.qzDS.maxConnections = 10 

要將任務調度數據保存到數據庫中，就必須使用org.quartz.impl.jdbcjobstore.JobStoreTX代替原來的

org.quartz.simpl.RAMJobStore並提供相應的數據庫配置信息。首先①處指定了Quartz數據庫表的前綴，在②處定義了一個數據源，

在③處具體定義這個數據源的鏈接信息。你必須事先在相應的數據庫中建立Quartz的數據表（共8張），在Quartz的完整發布包的

docs/dbTables目錄下擁有對應不一樣數據庫的SQL腳本。

 

查詢數據庫中的運行信息

任務的現場保存對於上層的Quartz程序來講是徹底透明的，咱們在src目錄下編寫一個如代碼清單6所示的quartz.properties文件後，從新運行代碼清單2或代碼清單3的程序，在數據庫表中將能夠看到對應的持久化信息。當調度程序運行過程當中途中止後，任務調度的現場數據將記錄在數據表中，在系統重啓時就能夠在此基礎上繼續進行任務的調度。

 

代碼清單7 JDBCJobStoreRunner：從數據庫中恢復任務的調度

import org.quartz.Scheduler;

import org.quartz.SchedulerFactory;

import org.quartz.SimpleTrigger;

import org.quartz.Trigger;

import org.quartz.impl.StdSchedulerFactory;

 

public class JDBCJobStoreRunner {

    public static void main(String args[]) {

        try {

            SchedulerFactory schedulerFactory = new StdSchedulerFactory();

            Scheduler scheduler = schedulerFactory.getScheduler();

            // ①獲取調度器中全部的觸發器組

            String[] triggerGroups = scheduler.getTriggerGroupNames();

            // ②從新恢復在tgroup1組中，名爲trigger1_1觸發器的運行

            for (int i = 0; i < triggerGroups.length; i++) {

                String[] triggers = scheduler.getTriggerNames(triggerGroups[i]);

                for (int j = 0; j < triggers.length; j++) {

                    Trigger tg = scheduler.getTrigger(triggers[j], triggerGroups[i]);

                    if (tg instanceof SimpleTrigger && tg.getFullName().equals("tgroup1.trigger1_1")) {

                        // ②-1:根據名稱判斷

                        // ②-1:恢復運行

                        scheduler.rescheduleJob(triggers[j], triggerGroups[i], tg);

                    }

                }

            }

            scheduler.start();

        } catch (

        Exception e) {

            e.printStackTrace();

        }

    }

}

當代碼清單2中的SimpleTriggerRunner執行到一段時間後非正常退出，咱們就能夠經過這個JDBCJobStoreRunner根據記錄在數據庫中的現場數據恢復任務的調度。Scheduler中的全部Trigger以及JobDetail的運行信息都會保存在數據庫中，這裏咱們僅恢復tgroup1

組中名稱爲trigger1_1的觸發器，這能夠經過如②-1所示的代碼進行過濾，觸發器的採用GROUP.TRIGGER_NAME 的全名格式。經過

Scheduler#rescheduleJob(String triggerName,String groupName,Trigger newTrigger)便可從新調度關聯某個Trigger的任務。

 

小結

Quartz提供了最爲豐富的任務調度功能，不但能夠制定週期性運行的任務調度方案，還可讓你按照日曆相關的方式進行任務調度。

Quartz框架的重要組件包括Job、JobDetail、Trigger、Scheduler以及輔助性的JobDataMap和SchedulerContext。

 

Quartz擁有一個線程池，經過線程池爲任務提供執行線程，你能夠經過配置文件對線程池進行參數定製。Quartz的另外一個重要功能是可將任務調度信息持久化到數據庫中，以便系統重啓時可以恢復已經安排的任務。此外，Quartz還擁有完善的事件體系，容許你註冊各類事件的監聽器。