使用背景
相信大家在工作過程中,肯定會遇到很多任務定時執行,修改定時任務的時間,執行一次定時任務等等。下面我就通過案例來幫大家解決這些問題!
下面的案例是結合SpringMVC Web工程來說的。
當然任何類型的工程都可以使用Quartz來實現定時任務的管理。
准備工作
開發環境:
jdk
Intellij IDEA 2018.1
google chrome
運行環境:
tomcat8/tomcat9
windows7-10
實現功能:
實現web工程下定時任務的執行與管理
代碼結構
程序實現
Quartz下載
下載
使用maven管理jar包下載:
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz</artifactId>
<version>2.2.1</version>
</dependency>
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz-jobs</artifactId>
<version>2.2.1</version>
</dependency>
Quartz 使用
Quartz 對於定時任務,提供了一個Job接口。所有你需要實現的定時任務都需要實現Job接口。
例如:
public class Job1Impl implements Job {
@Override
public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
//do something you want to do
SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss");
String time = format.format(new Date());
System.out.println("job 1 start at " + time);
}
}
cron表達式
Quartz里面有一個cron表達式,用來設置定時任務執行的時間
1.Cron表達式是一個字符串,字符串以5或6個空格隔開,分為6或7個域,每一個域代表一個含義,Cron有如下兩種語法格式:
Seconds Minutes Hours DayofMonth Month DayofWeek Year或 Seconds Minutes Hours DayofMonth Month DayofWeek
2.每一個域可出現的字符如下:
Seconds:可出現", - * /"四個字符,有效范圍為0-59的整數
Minutes:可出現", - * /"四個字符,有效范圍為0-59的整數
Hours:可出現", - * /"四個字符,有效范圍為0-23的整數
DayofMonth:可出現", - * / ? L W C"八個字符,有效范圍為0-31的整數
Month:可出現", - * /"四個字符,有效范圍為1-12的整數或JAN-DEc
DayofWeek:可出現", - * / ? L C #"四個字符,有效范圍為1-7的整數或SUN-SAT兩個范圍。1表示星期天,2表示星期一, 依次類推
Year:可出現", - * /"四個字符,有效范圍為1970-2099年
每一個域都使用數字,但還可以出現如下特殊字符,它們的含義是:
(1)*:表示匹配該域的任意值,假如在Minutes域使用*, 即表示每分鍾都會觸發事件。
(2)?:只能用在DayofMonth和DayofWeek兩個域。它也匹配域的任意值,但實際不會。因為DayofMonth和DayofWeek會相互影響。
例如想在每月的20日觸發調度,不管20日到底是星期幾,則只能使用如下寫法: 13 13 15 20 * ?,
其中最后一位只能用?,而不能使用*,如果使用*表示不管星期幾都會觸發,實際上並不是這樣。
(3)-: 表示范圍,例如在Minutes域使用5-20,表示從5分到20分鍾每分鍾觸發一次 。
(4)/:表示起始時間開始觸發,然后每隔固定時間觸發一次,例如在Minutes域使用5/20,則意味着5分鍾觸發一次,而25,45等分別觸發一次.。
(5),: 表示列出枚舉值值。例如:在Minutes域使用5,20,則意味着在5和20分每分鍾觸發一次。
(6)L: 表示最后,只能出現在DayofWeek和DayofMonth域,如果在DayofWeek域使用5L,意味着在最后的一個星期四觸發。
(7)W: 表示有效工作日(周一到周五),只能出現在DayofMonth域,系統將在離指定日期的最近的有效工作日觸發事件。例如:在
DayofMonth使用5W,如果5日是星期六,則將在最近的工作日:星期五,即4日觸發。如果5日是星期天,則在6日(周一)觸發;
如果5日在星期一到星期五中的一天,則就在5日觸發。另外一點,W的最近尋找不會跨過月份。
(8)LW: 這兩個字符可以連用,表示在某個月最后一個工作日,即最后一個星期五。
(9)#: 用於確定每個月第幾個星期幾,只能出現在DayofMonth域。例如在4#2,表示某月的第二個星期三。
舉幾個例子:
0 0 2 1 * ? * 表示在每月的1日的凌晨2點調度任務
0 15 10 ? * MON-FRI 表示周一到周五每天上午10:15執行作業
0 15 10 ? 6L 2002-2006 表示2002-2006年的每個月的最后一個星期五上午10:15執行作
一個cron表達式有至少6個(也可能7個)有空格分隔的時間元素。
按順序依次為
秒(0~59)
分鍾(0~59)
小時(0~23)
天(月)(0~31,但是你需要考慮你月的天數)
月(0~11)
天(星期)(1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT)
年份(1970-2099
其中每個元素可以是一個值(如6),一個連續區間(9-12),一個間隔時間(8-18/4)(/表示每隔4小時),一個列表(1,3,5),通配符。由於"月份中的日期"和"星期中的日期"這兩個元素互斥的,必須要對其中一個設置?
0 0 10,14,16 * * ? 每天上午10點,下午2點,4點
0 0/30 9-17 * * ? 朝九晚五工作時間內每半小時
0 0 12 ? * WED 表示每個星期三中午12點
"0 0 12 * * ?" 每天中午12點觸發
"0 15 10 ? * *" 每天上午10:15觸發
"0 15 10 * * ?" 每天上午10:15觸發
"0 15 10 * * ? *" 每天上午10:15觸發
"0 15 10 * * ? 2005" 2005年的每天上午10:15觸發
"0 * 14 * * ?" 在每天下午2點到下午2:59期間的每1分鍾觸發
"0 0/5 14 * * ?" 在每天下午2點到下午2:55期間的每5分鍾觸發
"0 0/5 14,18 * * ?" 在每天下午2點到2:55期間和下午6點到6:55期間的每5分鍾觸發
"0 0-5 14 * * ?" 在每天下午2點到下午2:05期間的每1分鍾觸發
"0 10,44 14 ? 3 WED" 每年三月的星期三的下午2:10和2: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 2002-2005" 2002年至2005年的每月的最后一個星期五上午10:15觸發
"0 15 10 ? * 6#3" 每月的第三個星期五上午10:15觸發
3. 有些子表達式能包含一些范圍或列表。
例如:子表達式(天(星期))可以為 “MON-FRI”,“MON,WED,FRI”,“MON-WED,SAT”
“*”字符代表所有可能的值
因此,“*”在子表達式(月)里表示每個月的含義,“*”在子表達式(天(星期))表示星期的每一天
4. “/”字符用來指定數值的增量
例如:在子表達式(分鍾)里的“0/15”表示從第0分鍾開始,每15分鍾
在子表達式(分鍾)里的“3/20”表示從第3分鍾開始,每20分鍾(它和“3,23,43”)的含義一樣
5. “?”字符僅被用於天(月)和天(星期)兩個子表達式,表示不指定值
當2個子表達式其中之一被指定了值以后,為了避免沖突,需要將另一個子表達式的值設為“?”
“L” 字符僅被用於天(月)和天(星期)兩個子表達式,它是單詞“last”的縮寫,但是它在兩個子表達式里的含義是不同的。
在天(月)子表達式中,“L”表示一個月的最后一天
在天(星期)自表達式中,“L”表示一個星期的最后一天,也就是SAT
如果在“L”前有具體的內容,它就具有其他的含義了
例如:“6L”表示這個月的倒數第6天,“FRIL”表示這個月的最一個星期五
注意:在使用“L”參數時,不要指定列表或范圍,因為這會導致問題。
添加定時任務
/**
* 功能: 添加一個定時任務
* @param jobName 任務名(同一個任務組中唯一)
* @param jobGroupName 任務組名
* @param triggerName 觸發器名(同一個觸發器組中唯一)
* @param triggerGroupName 觸發器組名
* @param jobClass 任務的類類型 eg:TimedMassJob.class
* @param cron 時間設置 表達式,參考quartz說明文檔
* @param objects 可變參數需要進行傳參的值
*/
public static void addjob(String jobName, String jobGroupName, String triggerName,String triggerGroupName, Class jobClass, String cron, Object... objects){
try {
Scheduler scheduler = schedulerFactory.getScheduler();
JobDetail jobDetail = JobBuilder.newJob(jobClass).withIdentity(jobName, jobGroupName).build();
if(objects != null){
Integer i = 0;
for (Object obj: objects) {
jobDetail.getJobDataMap().put("data"+i, obj);
i++;
}
}
TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger();
triggerBuilder.withIdentity(triggerName, triggerGroupName);
triggerBuilder.startNow();
triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(cron));
CronTrigger cronTrigger = (CronTrigger)triggerBuilder.build();
scheduler.scheduleJob(jobDetail, cronTrigger);
if(!scheduler.isShutdown()){
scheduler.start();
}
} catch (SchedulerException e) {
logger.error("error:\n",e);
}
}
刪除定時任務
/**
* 功能: 移除一個任務
* @param jobName
* @param jobGroupName
* @param triggerName
* @param triggerGroupName
*/
public static void removeJob(String jobName, String jobGroupName,String triggerName, String triggerGroupName){
try {
Scheduler scheduler = schedulerFactory.getScheduler();
TriggerKey triggerKey = TriggerKey.triggerKey(triggerName, triggerGroupName);
scheduler.pauseTrigger(triggerKey);
scheduler.unscheduleJob(triggerKey);
scheduler.deleteJob(JobKey.jobKey(jobName,jobGroupName));
} catch (SchedulerException e) {
logger.error("error:\n",e);
}
}
修改定時任務執行時間
/**
* 功能:修改一個任務的觸發時間
* @param triggerName 觸發器名
* @param triggerGroupName 觸發器組名
* @param cron 時間設置,參考quartz說明文檔
*/
public static void modifyJobTime(String triggerName,String triggerGroupName, String cron){
try {
Scheduler scheduler = schedulerFactory.getScheduler();
TriggerKey triggerKey = TriggerKey.triggerKey(triggerName, triggerGroupName);
CronTrigger trigger = (CronTrigger)scheduler.getTrigger(triggerKey);
if(trigger == null){
return;
}
String oldTime = trigger.getCronExpression();
if(!oldTime.equalsIgnoreCase(cron)){
TriggerBuilder<Trigger> triggerBuilder = TriggerBuilder.newTrigger();
triggerBuilder.withIdentity(triggerName, triggerGroupName);
triggerBuilder.startNow();
triggerBuilder.withSchedule(CronScheduleBuilder.cronSchedule(cron));
trigger = (CronTrigger) triggerBuilder.build();
scheduler.rescheduleJob(triggerKey, trigger);
}
} catch (SchedulerException e) {
logger.error("error:\n",e);
}
}
啟動所有任務
public static void startJobs(){
try {
Scheduler scheduler = schedulerFactory.getScheduler();
scheduler.start();
} catch (SchedulerException e) {
logger.error("error:\n",e);
}
}
關閉所有定時任務
public static void shutdownJobs(){
try {
Scheduler scheduler = schedulerFactory.getScheduler();
scheduler.shutdown();
} catch (SchedulerException e) {
logger.error("error:\n",e);
}
}
運行結果
1.在Intellij IDEA里面按照下面三張圖片中添加配置Edit Configurations-> add tomcat server->Edit deployment
2.直接點Run即可
3.Run完后在chrome瀏覽器中顯示如下
4.在chrome瀏覽器中或者相關http請求工具中運行addjob,modifyjob的功能測試如下
我測試用的Restlet Client插件工具
- addjob
- modifyjob
5.在Intellij IDEA里面查看結果運行如下
Quartz+SpringMVC實現web定時管理任務
注:本文著作權歸作者,由demo大師代發,拒絕轉載,轉載需要作者授權