Quartz對任務調度的領域問題進行了高度的抽象,提出了調度器、任務和觸發器這3個核心的概念,並在org.quartz通過接口和類對重要的這些核心概念進行描述:
1.Job:是一個接口,只有一個方法void execute(JobExecutionContext context),開發者實現該接口定義運行任務,JobExecutionContext類提供了調度上下文的各種信息。Job運行時的信息保存在JobDataMap實例中;
2.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名稱;
3.Trigger:是一個類,描述觸發Job執行的時間觸發規則。主要有SimpleTrigger和CronTrigger這兩個子類。當僅需觸發一次或者以固定時間間隔週期執行,SimpleTrigger是最適合的選擇;而CronTrigger則可以通過Cron表達式定義出各種複雜時間規則的調度方案:如每早晨9:00執行,週一、週三、週五下午5:00執行等;
4.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分別針對每年、每月和每週進行定義;
5.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實例;
6.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擁有完善的事件和監聽體系,大部分組件都擁有事件,如任務執行前事件、任務執行後事件、觸發器觸發前事件、觸發後事件、調度器開始事件、關閉事件等等。
Scheduler的內部組件結構,SchedulerContext提供Scheduler全局可見的上下文信息,每一個任務都對應一個JobDataMap,虛線表達的JobDataMap表示對應有狀態的任務:
<img style="color: rgb(69, 69, 69); text-transform: none; line-height: 18px; text-indent: 0px; letter-spacing: normal; font-family: Verdana, Helvetica, Arial; font-style: normal; font-variant: normal; font-weight: normal; word-spacing: 0px; white-space: normal; cursor: pointer; background-color: rgb(247, 247, 247); -webkit-text-stroke-width: 0px;" src="http://img.zdnet.com.cn/0/246/liUzs8jeM8Hts.gif" "="">
一個Scheduler可以擁有多個Triger組和多個JobDetail組,註冊Trigger和JobDetail時,如果不顯式指定所屬的組,Scheduler將放入到默認組中,默認組的組名爲Scheduler.DEFAULT_GROUP。組名和名稱組成了對象的全名,同一類型對象的全名不能相同。
Scheduler本身就是一個容器,它維護着Quartz的各種組件並實施調度的規則。Scheduler還擁有一個線程池,線程池爲任務提供執行線程——這比執行任務時簡單地創建一個新線程要擁有更高的效率,同時通過共享節約資源的佔用。通過線程池組件的支持,對於繁忙度高、壓力大的任務調度,Quartz將可以提供良好的伸縮性。
使用SimpleTrigger類
SimpleTrigger擁有多個重載的構造函數,用以在不同場合下構造出對應的實例:
1.SimpleTrigger(String name, String group):通過該構造函數指定Trigger所屬組和名稱;
2.SimpleTrigger(String name, String group, Date startTime):除指定Trigger所屬組和名稱外,還可以指定觸發的開始時間;
3.SimpleTrigger(String name, String group, Date startTime, Date endTime, int repeatCount, long repeatInterval):除指定以上信息外,還可以指定結束時間、重複執行次數、時間間隔等參數;
4.SimpleTrigger(String name, String group, String jobName, String jobGroup, Date startTime, Date endTime, int repeatCount, long repeatInterval):這是最複雜的一個構造函數,在指定觸發參數的同時,還通過jobGroup和jobName,讓該Trigger和Scheduler中的某個任務關聯起來。
案例一(job實現類):
package com.baobaotao.basic.quartz;
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()));
}
}
案例二(trigger實現類):
package com.baobaotao.basic.quartz;
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();
}
}
}
還可以通過SimpleTrigger的setStartTime(java.util.Date startTime)和setEndTime(java.util.Date endTime)指定運行的時間範圍,當運行次數和時間範圍衝突時,超過時間範圍的任務運行不被執行。如可以通過simpleTrigger.setStartTime(new Date(System.currentTimeMillis() + 60000L))指定60秒鐘以後開始。
除了通過scheduleJob(jobDetail, simpleTrigger)建立Trigger和JobDetail的關聯,還有另外一種關聯Trigger和JobDetail的方式:
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個由空格分隔的時間字段組成):
位置 |
時間域名 |
允許值 |
允許的特殊字符 |
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表達式的時間字段除允許設置數值外,還可使用一些特殊的字符,提供列表、範圍、通配符等功能:
1.星號(*):可用在所有字段中,表示對應時間域的每一個時刻,例如,*在分鐘字段時,表示“每分鐘”;
2.問號(?):該字符只在日期和星期字段中使用,它通常指定爲“無意義的值”,相當於點位符;
3.減號(-):表達一個範圍,如在小時字段中使用“10-12”,則表示從10到12點,即10,11,12;
4.逗號(,):表達一個列表值,如在星期字段中使用“MON,WED,FRI”,則表示星期一,星期三和星期五;
5.斜槓(/):x/y表達一個等步長序列,x爲起始值,y爲增量步長值。如在分鐘字段中使用0/15,則表示爲0,15,30和45秒,而5/15在分鐘字段中表示5,20,35,50,你也可以使用*/y,它等同於0/y;
6.L:該字符只在日期和星期字段中使用,代表“Last”的意思,但它在兩個字段中意思不同。L在日期字段中,表示這個月份的最後一天,如一月的31號,非閏年二月的28號;如果L用在星期中,則表示星期六,等同於7。但是,如果L出現在星期字段裏,而且在前面有一個數值X,則表示“這個月的最後X天”,例如,6L表示該月的最後星期五;
7.W:該字符只能出現在日期字段裏,是對前導日期的修飾,表示離該日期最近的工作日。例如15W表示離該月15號最近的工作日,如果該月15號是星期六,則匹配14號星期五;如果15日是星期日,則匹配16號星期一;如果15號是星期二,那結果就是15號星期二。但必須注意關聯的匹配日期不能夠跨月,如你指定1W,如果1號是星期六,結果匹配的是3號星期一,而非上個月最後的那天。W字符串只能指定單一日期,而不能指定日期範圍;
8.LW組合:在日期字段可以組合使用LW,它的意思是當月的最後一個工作日;
9.井號(#):該字符只能在星期字段中使用,表示當月某個工作日。如6#3表示當月的第三個星期五(6表示星期五,#3表示當前的第三個),而4#5表示當月的第五個星期三,假設當月沒有第五個星期三,忽略不觸發;
10.C:該字符只在日期和星期字段中使用,代表“Calendar”的意思。它的意思是計劃所關聯的日期,如果日期沒有被關聯,則相當於日曆中所有日期。例如5C在日期字段中就相當於日曆5日以後的第一天。1C在星期字段中相當於星期日後的第一天。
注意: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分運行。 |
案例三(trigger實例):
package com.baobaotao.basic.quartz;
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)指定開始和結束的時間。
②處通過Thread.currentThread.sleep()的方式讓主線程睡眠,以便調度器可以繼續工作執行任務調度。否則在調度器啓動後,因爲主線程馬上退出,也將同時引起調度器關閉,調度器中的任務都將相應銷燬,這將導致看不到實際的運行效果。在單元測試的時候,讓主線程睡眠經常使用的辦法。對於某些長週期任務調度的測試,你可以簡單地調整操作系統時間進行模擬。
使用Calendar類:
案例四(calendar實例):
package com.baobaotao.basic.quartz;
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後,還需要通過Scheduler#addCalendar(String calName, Calendar calendar, boolean replace, boolean updateTriggers)進行註冊,如果updateTriggers爲true,Scheduler中已引用Calendar的Trigger將得到更新。
任務調度信息的存儲:
在默認情況下Quartz將任務調度的運行信息保存在內存中,這種方法提供了最佳的性能,因爲內存中數據訪問最快。不足之處是缺乏數據的持久性,當程序路途停止或系統崩潰時,所有運行的信息都會丟失。比如我們希望安排一個執行100次的任務,如果執行到50次時系統崩潰了,系統重啓時任務的執行計數器將從0開始。在大多數實際的應用中,我們往往並不需要保存任務調度的現場數據,因爲很少需要規劃一個指定執行次數的任務。
對於僅執行一次的任務來說,其執行條件信息本身應該是已經持久化的業務數據(如鎖定到期解鎖任務,解鎖的時間應該是業務數據),當執行完成後,條件信息也會相應改變。當然調度現場信息不僅僅是記錄運行次數,還包括調度規則、JobDataMap中的數據等等。
如果確實需要持久化任務調度信息,Quartz允許你通過調整其屬性文件,將這些信息保存到數據庫中。使用數據庫保存任務調度信息後,即使系統崩潰後重新啓動,任務的調度信息將得到恢復。如前面所說的例子,執行50次崩潰後重新運行,計數器將從51開始計數。使用了數據庫保存信息的任務稱爲持久化任務。
通過配置文件調整任務調度信息的保存策略:
Quartz JAR文件的org.quartz包下就包含了一個quartz.properties屬性配置文件並提供了默認設置。如果需要調整默認配置,可以在類路徑下建立一個新的quartz.properties,它將自動被Quartz加載並覆蓋默認的設置。
①集羣的配置,這裏不使用集羣
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 //任務現場數據保存在內存模式
數據庫保存任務現場數據配置方案:
…
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
案例五(JDBC恢復任務調度現場):
package com.baobaotao.basic.quartz;
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();
}
}
}
下面我們來觀察一下不同時期qrtz_simple_triggers表的數據:
1.運行代碼清單2的SimpleTriggerRunner一小段時間後退出:
2.運行代碼清單7的JDBCJobStoreRunner恢復trigger1_1的觸發器,運行一段時間後退出,這時qrtz_simple_triggers中的數據如下:
任務結束,數據庫清空。
(使用quartz 1.6版本,我們發現當後臺數據庫使用MySql時,數據保存不成功,該錯誤是Quartz的一個Bug,相信會在高版本中得到修復。因爲HSQLDB不支持SELECT * FROM TABLE_NAME FOR UPDATE的語法,所以不能使用HSQLDB數據庫。)