使用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實現類
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()));
}
}
這個類用一條非常簡單的輸出語句實現了Job接口的execute(JobExecutionContext context) 方法,這個方法可以包含想要執行的任何代碼。下面,我們通過SimpleTrigger對SimpleJob進行調度:
代碼清單2 SimpleTriggerRunner:使用SimpleTrigger進行調度
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();
}
}
}
首先在①處通過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)指定運行的時間範圍,當運行次數和時間範圍衝突時,超過時間範圍的任務運行不被執行。如可以通過simpleTrigger.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個由空格分隔的時間字段組成,如表1所示:
表1 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表達式對特殊字符的大小寫不敏感,對代表星期的縮寫英文大小寫也不敏感。
表2下面給出一些完整的Cron表示式的實例:
表2 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進行調度
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)指定開始和結束的時間。
在代碼清單3的②處需要通過Thread.currentThread.sleep()的方式讓主線程睡眠,以便調度器可以繼續工作執行任務調度。否則在調度器啓動後,因爲主線程馬上退出,也將同時引起調度器關閉,調度器中的任務都將相應銷燬,這將導致看不到實際的運行效果。在單元測試的時候,讓主線程睡眠經常使用的辦法。對於某些長週期任務調度的測試,你可以簡單地調整操作系統時間進行模擬。
使用Calendar
在實際任務調度中,我們不可能一成不變地按照某個週期性的調度規則運行任務,必須考慮到實現生活中日曆上特定日期,就象習慣了大男人作風的人在2月14號也會有不同表現一樣。
下面,我們安排一個任務,每小時運行一次,並將五一節和國際節排除在外,其代碼如代碼清單4所示:
代碼清單4 CalendarExample:使用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的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就會避開五一和國慶這兩個特殊日子了。