(一)、Trigger觸發(fā)器
??Job中包含了任務執(zhí)行的邏輯,Scheduler負責掃描需要執(zhí)行的Job任務,那么Scheduler如何知道何時執(zhí)行這個Job任務呢?接下來就需要觸發(fā)器上場了。
??觸發(fā)器(org.quartz.Trigger)抽象類的幾個主要屬性和JobDetail差不多,這里就不說明了,主要注意的是下面表格中的屬性和misfireInstruction這個屬性,misfireInstruction這個屬性的是觸發(fā)器錯失執(zhí)行(misfire)后的一個錯失觸發(fā)機制標識。當線程池中沒有可用的線程執(zhí)行任務時,就會錯過觸發(fā)時間,Trigger抽象類中默認錯失觸發(fā)機制是常量0(聰明的策略)。派生類有它們自己的錯失觸發(fā)機制。
下面對觸發(fā)器的子類分別進行講述,我們主要看Trigger的4個可用的派生類(注:共5個,UICronTrigger1.5版本后已廢棄),分別是:
- org.quartz.SimpleTrigger
- org.quartz.CronTrigger (常用)
- org.quartz.DateIntervalTrigger
- org.quartz.NthIncludedDayTrigger
以上派生類的幾個主要屬性:
| 屬性名 | 詳細介紹 |
|---|---|
| startTime | 首次觸發(fā)時間 |
| endTime | 截止時間,就算指定的執(zhí)行次數沒有執(zhí)行完也立即結束 |
| nextFireTime | 下一次觸發(fā)時間 |
| previousFireTime | 上一次觸發(fā)時間 |
| repeatCount | (不提供get/set)重復執(zhí)行次數(不包含首次執(zhí)行) |
| repeatInterval | (不提供get/set) 重復執(zhí)行間隔,單位為毫秒 |
| timesTriggered | (不提供get/set) 總觸發(fā)次數 |
了解了觸發(fā)器的幾個關鍵屬性,接下來通過代碼來看看幾個觸發(fā)器具體的使用。
下面這個Job打印了觸發(fā)器的幾種時間,示例代碼中的幾種觸發(fā)器都使用到了這個Job。
package com.xk.quartz.test;
import java.util.Date;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.quartz.Trigger;
/**
* 演示job
*/
public class DemoJob implements Job{
@Override
public void execute(JobExecutionContext context) throws JobExecutionException {
// 獲取觸發(fā)器
Trigger trigger = context.getTrigger();
// 獲取幾種時間
Date startTime = trigger.getStartTime();
Date endTime = trigger.getEndTime();
Date previousFireTime = trigger.getPreviousFireTime();
Date nextFireTime = trigger.getNextFireTime();
System.out.println("首次執(zhí)行時間:" + startTime.toLocaleString());
System.out.println("最后截止時間:" + (endTime != null ? endTime.toLocaleString() : null));
System.out.println("上一次執(zhí)行時間:" + previousFireTime.toLocaleString());
System.out.println("下一次執(zhí)行時間:" + (nextFireTime != null ? nextFireTime.toLocaleString() : null));
System.out.println("*******************************");
}
}
接下來對每個觸發(fā)器進行分別演示。
(1)、org.quartz.SimpleTrigger
??SimpleTrigger是一種設置和使用簡單的觸發(fā)器,它是在指定日期/時間且可能需要重復執(zhí)行n次的時機下使用的。這種觸發(fā)器不適合每天定時執(zhí)行任務這種場景,舉個栗子,假設指定任務首次觸發(fā)時間是中午12點整,間隔時間為1天,那么理論上來講以后的每一天中午12點整都會準時執(zhí)行,但是,只要出現了一次misfire,假設錯失執(zhí)行后等待可用線程的時間為1分鐘,即此任務會在12點01分被恢復觸發(fā),那么觸發(fā)器記錄的此次執(zhí)行時間就是12點01分鐘,又因為間隔時間設定的是1天,所以下一次執(zhí)行時間也會被推算到第二天的12點01分。
為了方便演示,下面使用的Quartz框架沒有持久化配置,僅使用RAMJobStore(存放在內存中),這樣的好處是可以使用默認配置并且直接main方法啟動。
package com.xk.quartz.test;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.SimpleTrigger;
import org.quartz.impl.StdSchedulerFactory;
/**
* SimpleTrigger演示
*/
public class SimpleTriggerTest {
public static void main(String[] args) throws SchedulerException {
// 獲取默認調度器 內部加載順序在調度器章節(jié)提到過
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
// 啟動調度器
scheduler.start();
// 創(chuàng)建job詳情
JobDetail jobDetail = new JobDetail("demoJob演示", DemoJob.class);
// 以下是觸發(fā)器的不同構造
// 立即執(zhí)行
SimpleTrigger simpleTrigger = new SimpleTrigger("simpleTrigger演示");
// 立即執(zhí)行
// SimpleTrigger simpleTrigger = new SimpleTrigger("simpleTrigger演示", new Date());
// 當前立即執(zhí)行,指定重復次數3次,間隔500毫秒
// 總執(zhí)行次數為4次(首次執(zhí)行+3次重復執(zhí)行)
// SimpleTrigger simpleTrigger = new SimpleTrigger("simpleTrigger演示", 3, 500);
// 當前時間2秒后執(zhí)行,當前時間5秒后結束,指定重復次數20次,間隔1000毫秒
// 這里雖然指定執(zhí)行次數為20次,但是實際只能執(zhí)行3次(首次執(zhí)行+2次重復執(zhí)行),因為有"當前時間5秒后結束"這個因素在
// SimpleTrigger simpleTrigger = new SimpleTrigger("simpleTrigger演示", new Date(System.currentTimeMillis() + 2000), new Date(System.currentTimeMillis() + 5000), 20, 1000);
// TODO
// 只要明白上面幾種創(chuàng)建方式 其他沒有寫出的夠著就很容易明白
// 注冊job和觸發(fā)器
scheduler.scheduleJob(jobDetail, simpleTrigger);
}
}
(2)、org.quartz.CronTrigger
??CronTrigger觸發(fā)器比SimpleTrigger觸發(fā)器強大很多,上面的代碼可以看出,使用SimpleTrigger觸發(fā)器時,需要設置不同的屬性來支撐,代碼編寫相對較多,而且不是很靈活。而接下來CronTrigger觸發(fā)器,可以設定復雜的觸發(fā)時間表,設置方式也很簡單,唯一的難點就是需要理解時間表達式如何編寫。
??為了更深刻的了解CronTrigger,我們需要了解一下Cron到底是什么?
??Cron概念是來自UNIX(Linux也是基于UNIX的)操作系統(tǒng)的,它就是一個執(zhí)行計劃任務的服務器或程序,你只需要將你的計劃和執(zhí)行時間交給它,它就會根據指定時間來調度工作任務。這里不要混淆UNIX的Cron和Quartz的Cron,因為他們之間有一些很明顯的差別,UNIX cron 計劃僅支持至分鐘級,而Quartz支持到秒級的計劃。說這些就是讓大家了解下Quartz Cron的歷史。
下面先看一下幾個示例,會感覺也沒多難,很好理解:
package com.xk.quartz.test;
import java.text.ParseException;
import org.quartz.CronTrigger;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.impl.StdSchedulerFactory;
/**
* CronTrigger演示
*/
public class CronTriggerTest {
public static void main(String[] args) throws SchedulerException {
// 獲取默認調度器 內部加載順序在調度器章節(jié)提到過
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
// 啟動調度器
scheduler.start();
// 創(chuàng)建job詳情
JobDetail jobDetail = new JobDetail("demoJob演示", DemoJob.class);
// 創(chuàng)建觸發(fā)器 下面只演示一種觸發(fā)器構造 其他的構造也很好理解
CronTrigger cronTrigger = null;
try {
// 每秒執(zhí)行一次兩種寫法
cronTrigger = new CronTrigger("cronTrigger演示", "DEFAULT", "* * * * * ?");
// cronTrigger = new CronTrigger("cronTrigger演示", "DEFAULT", "0/1 * * * * ?");
// 每分鐘的秒鐘等于30時執(zhí)行
// cronTrigger = new CronTrigger("cronTrigger演示", "DEFAULT", "30 * * * * ?");
// 每5分鐘的整分時執(zhí)行
// cronTrigger = new CronTrigger("cronTrigger演示", "DEFAULT", "0 0/5 * * * ?");
// 每天的9點和18點整執(zhí)行 (通知下班啦?)
// cronTrigger = new CronTrigger("cronTrigger演示", "DEFAULT", "0 0 9,18 * * ?");
// 每個月最后一天的23點59分59秒執(zhí)行 (做月統(tǒng)計時使用)
// cronTrigger = new CronTrigger("cronTrigger演示", "DEFAULT", "59 59 23 L * ?");
} catch (ParseException e) {
e.printStackTrace();
}
// 注冊job和觸發(fā)器
scheduler.scheduleJob(jobDetail, cronTrigger);
}
}
下面列出Quartz Cron表達式格式的7個域:
| 名稱 | 是否必須 | 允許值 | 特殊字符 |
|---|---|---|---|
| 秒 | 是 | 0-59 | , - * / |
| 分 | 是 | 0-59 | , - * / |
| 時 | 是 | 0-23 | , - * / |
| 日 | 是 | 1-31 | , - * ? / L W C |
| 月 | 是 | 1-12或 JAN-DEC | , - * / |
| 周 | 是 | 1-7 或 SUN-SAT | , - * ? / L C # |
| 年 | 否 | 空 或 1970-2099 | , - * / |
域之間通過空格進行分隔,年份不是必須項,月份和星期的名稱不區(qū)分大小寫,比如SUN和sun是一樣的。
- 星號( * )表示該域上所有合法的值都會被觸發(fā),如果使用在秒域上,就表示 每秒鐘
- 問號( ? )表示不為該域指定值。?號只能用在日和周兩個域上,但不能兩個域同時使用,只要記住一點,在這兩個域的其中一個指定了值,那另外一個值就放一個?問號,這樣不會出現混亂
- 逗號( , )表示該域上指定一個值列表,例如秒的域上使用值0,20,40 表示秒鐘等于0、20或40時觸發(fā)
- 斜杠( / )表示時間表遞增,上面逗號舉例20秒觸發(fā)一次,也可以在秒域上寫成 0/20
- 中劃線( - )表示取值范圍,例如時域上指定9-18,那么表示上午9點到下午6點每小時觸發(fā)一次
- 字母( L )表示合法范圍的最后一個值,只能在日和周兩個域上使用,用在日上時表示指定月份的最后一天;用在周上時表示周的最后一天,注意是數字7或者星期六(國外周日是星期的第一天),用在周上時還可以用一個數字與 L 連起來表示月份的最后一個星期 X。例如,表達式 0 0 0 ? * 1L表示在每個月的最后一個星期日觸發(fā)
- 字母( W )表示指定日的最近的一個工作日(周一到周五),并且只能用在日域上。假如日字段指定的是15W,那么就表示該月15號最相近的工作日執(zhí)行。如果15號是周六,那么就是14號周五觸發(fā);如果15號是周日,那么就會在16號周一觸發(fā);如果15號是周三,那就當天觸發(fā)
- 井號( # )表示指定月份中第幾周的第幾天,只能用在周域上。例如值為1#2,表示某月第二周的星期日觸發(fā),2表示第二周,1表示星期日。如果把2改為大于4的數字,比如5或6,那么就不會被觸發(fā),因為一個月中不會超過4周
- 字母( C )表示計算需要依賴日歷(org.quartz.impl.calendar.CronCalendar)類的計算結果,只能用在日和周兩個域上。
下面是一些例子,可以照葫蘆畫瓢進行延伸擴展:
| 表達式 | 含義 |
|---|---|
| 0 0 12 * * ? | 每天中午12點整觸發(fā) |
| 0 0 12 ? * * | 每天中午12點整觸發(fā) |
| 0 0 12 * * ? 2018 | 2018年的每天中午12點整觸發(fā) |
| 0 0/5 12 * * ? | 每天12點開始到12點55分結束每5分鐘觸發(fā) |
| 0 0-5 12 * * ? | 每天12:00到12:05每分鐘觸發(fā) |
| 0 0 12,13,14 * * ? | 每天12點、13點、14點整點時各觸發(fā) |
| 0 0 12 ? 6 WED | 6月份的每個周三中午12點整觸發(fā) |
| 0 0 12 L * ? | 每個月最后一天12點整觸發(fā) |
| 0 0 12 15W * ? | 每個月15號最近的工作日(周一到周五)觸發(fā)一次 |
| 0 0 12 ? * 2#3 | 每個月第三周的星期一觸發(fā) |
(3)、org.quartz.DateIntervalTrigger
??這是quartz1.7版本以后加入的觸發(fā)器,該觸發(fā)器適用于每小時,每幾周,每幾月重復執(zhí)行的任務。
??舉個例子,假如任務需求是需要每5個月間隔時觸發(fā)一次,如果用Cron來實現,那表達式就是“0 0 12 * 0/5 ?“,啟動時會報一個解析異常ParseException: Month values must be between 1 and 12。雖然我們也可以使用SimpleTrigger觸發(fā)器,但是上面提到,SimpleTrigger當出現misfire時,下一次執(zhí)行的時間也會向后延遲。而DateIntervalTrigger就不會有這些問題。使用DateIntervalTrigger時只要注意一個問題,如果使用的Unit單位為月,開始執(zhí)行時間是1月31日,那么第二次執(zhí)行將會是2月28日(可能29日),第三次執(zhí)行會是3月28日,以后都是28日,而不會出現31日了,這是需要注意點。如果想要實現每個月最后一天觸發(fā),那就使用CronTrigger觸發(fā)器去實現(示例代碼中有提到)。
上代碼:
package com.xk.quartz.test;
import org.quartz.DateIntervalTrigger;
import org.quartz.DateIntervalTrigger.IntervalUnit;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.impl.StdSchedulerFactory;
/**
* DateIntervalTrigger演示
*/
public class DateIntervalTriggerTest {
public static void main(String[] args) throws SchedulerException {
// 獲取默認調度器 內部加載順序在調度器章節(jié)提到過
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
// 啟動調度器
scheduler.start();
// 創(chuàng)建job詳情
JobDetail jobDetail = new JobDetail("demoJob演示", DemoJob.class);
// 創(chuàng)建觸發(fā)器 只演示一種構造方法 其他構造屬性和以上觸發(fā)器屬性類似
// 每一個月觸發(fā)一次 IntervalUnit.MONTH是個枚舉常量 1表示重復間隔
DateIntervalTrigger dateIntervalTrigger = new DateIntervalTrigger("dateIntervalTrigger演示", IntervalUnit.MONTH, 1);
// TODO
// 下面就不一一列舉了 IntervalUnit的其他常量很容易理解,每個常量對應了一個日期域
// 注冊job和觸發(fā)器
scheduler.scheduleJob(jobDetail, dateIntervalTrigger);
}
}
(4)、org.quartz.NthIncludedDayTrigger
NthIncludedDayTrigger適用于在每一個間隔類型(月或年等)的第N天觸發(fā)。直接上代碼:
package com.xk.quartz.test;
import org.quartz.Calendar;
import org.quartz.JobDetail;
import org.quartz.NthIncludedDayTrigger;
import org.quartz.Scheduler;
import org.quartz.SchedulerException;
import org.quartz.impl.StdSchedulerFactory;
/**
* NthIncludedDayTrigger演示
*/
public class NthIncludedDayTriggerTest {
public static void main(String[] args) throws SchedulerException {
// 獲取默認調度器 內部加載順序在調度器章節(jié)提到過
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
// 啟動調度器
scheduler.start();
// 創(chuàng)建job詳情
JobDetail jobDetail = new JobDetail("demoJob演示", DemoJob.class);
// 創(chuàng)建觸發(fā)器
// 下面觸發(fā)器表示每個月的第10天中午12點整觸發(fā)
NthIncludedDayTrigger nthIncludedDayTrigger = new NthIncludedDayTrigger("nthIncludedDayTrigger演示");
nthIncludedDayTrigger.setN(10);
nthIncludedDayTrigger.setIntervalType(NthIncludedDayTrigger.INTERVAL_TYPE_MONTHLY);
nthIncludedDayTrigger.setFireAtTime("12:00:00");
// 注冊job和觸發(fā)器
scheduler.scheduleJob(jobDetail, nthIncludedDayTrigger);
}
}
??四種觸發(fā)器的創(chuàng)建方式都演示了,大家平時需要考慮的就是哪些情況下使用哪種觸發(fā)器。這需要大家在開發(fā)的過程中自己進行研究和調試。大家使用最多的是CronTrigger,通過Cron表達式幾乎可以完成工作業(yè)務中的絕大多數任務。
(二)、使用TriggerUtils工具類創(chuàng)建觸發(fā)器
??下面介紹一個常用的觸發(fā)器工具類(org.quartz.TriggerUtils)。可以很方便創(chuàng)建一些簡單的觸發(fā)器。上代碼:
package com.xk.quartz.test;
import org.quartz.Trigger;
import org.quartz.TriggerUtils;
/**
* TriggerUtils演示
*/
public class TriggerUtilsTest {
public static void main(String[] args) {
// 構造函數有很多 下面只列舉常用的幾種
// 創(chuàng)建一個每2秒執(zhí)行一次 重復執(zhí)行5次的觸發(fā)器
Trigger trigger = TriggerUtils.makeSecondlyTrigger("trigger", 2, 5);
// 創(chuàng)建一個每5分鐘執(zhí)行一次的觸發(fā)器
Trigger trigger2 = TriggerUtils.makeMinutelyTrigger(5);
trigger2.setName("trigger2");
// 創(chuàng)建一個每2小時執(zhí)行一次 重復執(zhí)行5次的觸發(fā)器
Trigger trigger3 = TriggerUtils.makeHourlyTrigger(2, 5);
trigger3.setName("trigger3");
// 創(chuàng)建一個每天中午12點10分執(zhí)行的觸發(fā)器
Trigger trigger4 = TriggerUtils.makeDailyTrigger("trigger4", 12, 10);
// 創(chuàng)建一個每個月5號中午12點10執(zhí)行的觸發(fā)器
Trigger trigger5 = TriggerUtils.makeMonthlyTrigger("trigger5", 5, 12, 10);
// 創(chuàng)建一個每周三中午12點整執(zhí)行的觸發(fā)器
Trigger trigger6 = TriggerUtils.makeWeeklyTrigger("trigger6", 4, 12, 0);
// 創(chuàng)建一個立即觸發(fā)的觸發(fā)器
Trigger trigger7 = TriggerUtils.makeImmediateTrigger("trigger7", 0, 0);
}
}
下面是工具類中的其他方法,了解一下含義:
- computeFireTimes(Trigger trigg, org.quartz.Calendar cal, int numTimes)
返回下次執(zhí)行的日期列表 - computeFireTimesBetween(Trigger trigg, org.quartz.Calendar cal, Date from, Date to)
返回指定時間段內下次執(zhí)行的日期列表 - computeEndTimeToAllowParticularNumberOfFirings(Trigger trigg, org.quartz.Calendar cal, int numTimes)
返回第n次觸發(fā)后的第1秒時間 - getDateOf(int second, int minute, int hour)
返回指定時分秒的一個今天的日期對象,此方法有包含日,月,年參數重載方法 - getEvenHourDate(Date date)
返回一個舍入到下一個小時以上的日期。比如:入參 09:35:12 返回10:00:00
此方法也有多個重載。