作業調度框架 Quartz 學習筆記
作業被安排在一個給定的觸發時運行。觸發器可以使用以下指令的接近任何組合來創建:
- 在一天中的某個時間(到毫秒)
- 在一週的某幾天
- 在每月的某一天
- 在一年中的某些日期
- 不在註冊的日曆中列出的特定日期(如商業節假日除外)
- 重複特定次數
- 重複進行,直到一個特定的時間/日期
- 無限重複
- 重複的延遲時間間隔
作業(job)是由其創建者賦予的名字,也可以組織成命名組(group)。觸發器(trigger)也可以給予名稱和放置在組中,以方便地將它們調度內組織。作業可以被添加到所述調度器一次,而是具有多個觸發器註冊。在企業Java環境中,作業可以執行自己的工作作爲分佈式(XA)事務的一部分。
helloworld
導入maven依賴
<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>
HelloJob.java
package com.zttech.demo.quartz;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
/**
* Quartz中定義要執行的工作
* @author guoqicheng
*
*/
public class HelloJob implements Job {
@Override
public void execute(JobExecutionContext context) throws JobExecutionException {
System.out.println("Hello Quartz!");
}
}
CronTriggerExample.java
package com.zttech.demo.quartz;
import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
/**
* Quartz觸發器
* CronTrigger例子
* 每間隔5秒運行
* @author guoqicheng
*
*/
public class CronTriggerExample {
public static void main( String[] args ) throws Exception
{
JobDetail job = JobBuilder.newJob(HelloJob.class)
.withIdentity("dummyJobName", "group1").build();
//CronTrigger – 允許UNIX cron表達式來指定日期和時間來運行作業
Trigger trigger = TriggerBuilder
.newTrigger()
.withIdentity("dummyTriggerName", "group1")
.withSchedule(CronScheduleBuilder.cronSchedule("0/5 * * * * ?"))
.build();
//調度類鏈接“工作”和“觸發器”到一起,並執行它
Scheduler scheduler = new StdSchedulerFactory().getScheduler();
scheduler.start();
scheduler.scheduleJob(job, trigger);
}
}
運行結果:從0秒開始,每隔5秒輸出一次Hello Quartz!。
JobListener
創建一個JobListener並且觀察工作運行狀態的變化。
HelloJob.java
package com.zttech.demo.jobListener;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
public class HelloJob implements Job {
@Override
public void execute(JobExecutionContext arg0) throws JobExecutionException {
System.out.println("Hello Quartz! - by guoqicheng");
//Throw exception for testing
throw new JobExecutionException("Testing Exception");
}
}
HelloJobListener.java
package com.zttech.demo.jobListener;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.quartz.JobListener;
/**
* 創建一個JobListener,只是實現了JobListener接口,並覆蓋所有的接口的方法。
* @author guoqicheng
*
*/
public class HelloJobListener implements JobListener {
public static final String LISTENER_NAME = "dummyJobListenerName";
@Override
public String getName() {
return LISTENER_NAME; //must return a name
}
@Override
public void jobExecutionVetoed(JobExecutionContext context) {
System.out.println("jobExecutionVetoed");
}
// Run this if job is about to be executed.
@Override
public void jobToBeExecuted(JobExecutionContext context) {
String jobName = context.getJobDetail().getKey().toString();
System.out.println("Job : " + jobName + " is going to start...");
System.out.println("jobToBeExecuted");
}
//Run this after job has been executed
@Override
public void jobWasExecuted(JobExecutionContext context,
JobExecutionException jobException) {
System.out.println("jobWasExecuted");
String jobName = context.getJobDetail().getKey().toString();
System.out.println("Job : " + jobName + " is finished...");
if (!jobException.getMessage().equals("")) {
System.out.println("Exception thrown by: " + jobName
+ " Exception: " + jobException.getMessage());
}
}
}
CronTriggerExample.java
package com.zttech.demo.jobListener;
import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.JobKey;
import org.quartz.Scheduler;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
import org.quartz.impl.matchers.KeyMatcher;
public class CronTriggerExample {
public static void main(String[] args) throws Exception {
JobKey jobKey = new JobKey("dummyJobName", "group1");
JobDetail job = JobBuilder.newJob(HelloJob.class).withIdentity(jobKey).build();
Trigger trigger = TriggerBuilder.newTrigger().withIdentity("dummyTriggerName", "group1")
.withSchedule(CronScheduleBuilder.cronSchedule("0/5 * * * * ?")).build();
Scheduler scheduler = new StdSchedulerFactory().getScheduler();
// Listener attached to jobKey
scheduler.getListenerManager().addJobListener(new HelloJobListener(), KeyMatcher.keyEquals(jobKey));
// Listener attached to group named "group 1" only.
// scheduler.getListenerManager().addJobListener(
// new HelloJobListener(), GroupMatcher.jobGroupEquals("group1")
// );
scheduler.start();
scheduler.scheduleJob(job, trigger);
}
}
運行結果:
Job : group1.dummyJobName is going to start…
jobToBeExecuted
Hello Quartz! - by guoqicheng
jobWasExecuted
Job : group1.dummyJobName is finished…
Exception thrown by: group1.dummyJobName Exception: Testing Exception
Quartz執行多作業
在Quartz調度框架中,每個作業將被連接到一個唯一的觸發,並且由調度器運行它。在 Quartz 中,一個觸發器觸發多個作業是不可以的。
創建3個作業JobA、JobB、JobC。
CronTriggerExample.java
package com.zttech.demo.jobListeners;
import org.quartz.CronScheduleBuilder;
import org.quartz.JobBuilder;
import org.quartz.JobDetail;
import org.quartz.JobKey;
import org.quartz.Scheduler;
import org.quartz.Trigger;
import org.quartz.TriggerBuilder;
import org.quartz.impl.StdSchedulerFactory;
/**
* 使用QuartzAPI聲明上述3個作業,分配它們到特定觸發器並調度它
* @author guoqicheng
*
*/
public class CronTriggerExample {
public static void main( String[] args ) throws Exception
{
JobKey jobKeyA = new JobKey("jobA", "group1");
JobDetail jobA = JobBuilder.newJob(JobA.class)
.withIdentity(jobKeyA).build();
JobKey jobKeyB = new JobKey("jobB", "group1");
JobDetail jobB = JobBuilder.newJob(JobB.class)
.withIdentity(jobKeyB).build();
JobKey jobKeyC = new JobKey("jobC", "group1");
JobDetail jobC = JobBuilder.newJob(JobC.class)
.withIdentity(jobKeyC).build();
Trigger trigger1 = TriggerBuilder
.newTrigger()
.withIdentity("dummyTriggerName1", "group1")
.withSchedule(
CronScheduleBuilder.cronSchedule("0/3 * * * * ?"))
.build();
Trigger trigger2 = TriggerBuilder
.newTrigger()
.withIdentity("dummyTriggerName2", "group1")
.withSchedule(
CronScheduleBuilder.cronSchedule("0/5 * * * * ?"))
.build();
Trigger trigger3 = TriggerBuilder
.newTrigger()
.withIdentity("dummyTriggerName3", "group1")
.withSchedule(
CronScheduleBuilder.cronSchedule("0/10 * * * * ?"))
.build();
Scheduler scheduler = new StdSchedulerFactory().getScheduler();
scheduler.start();
scheduler.scheduleJob(jobA, trigger1);
scheduler.scheduleJob(jobB, trigger2);
scheduler.scheduleJob(jobC, trigger3);
}
}
在調度器中A,B,C三個作業分別每隔3、5、10秒運行一次。
cron表達式
格式: [秒] [分] [小時] [日] [月] [周] [年]
序號 | 說明 | 是否必填 | 允許填寫的值 | 允許的通配符 |
---|---|---|---|---|
1 | 秒 | 是 | 0-59 | , - * / |
2 | 分 | 是 | 0-59 | , - * / |
3 | 小時 | 是 | 0-23 | , - * / |
4 | 日 | 是 | 1-31 | , - * ? / L W |
5 | 月 | 是 | 1-12 or JAN-DEC | , - * / |
6 | 周 | 是 | 1-7 or SUN-SAT | , - * ? / L # |
7 | 年 | 否 | empty 或 1970-2099 | , - * / |
通配符說明:
表示所有值. 例如:在分的字段上設置 ““,表示每一分鐘都會觸發。
? 表示不指定值。使用的場景爲不需要關心當前設置這個字段的值。例如:要在每月的10號觸發一個操作,但不關心是周幾,所以需要周位置的那個字段設置爲”?” 具體設置爲 0 0 0 10* ?
- 表示區間。例如 在小時上設置 “10-12”,表示 10,11,12點都會觸發。
, 表示指定多個值,例如在周字段上設置 “MON,WED,FRI” 表示週一,週三和週五觸發
/用於遞增觸發。如在秒上面設置”5/15” 表示從5秒開始,每增15秒觸發(5,20,35,50)。 在月字段上設置’1/3’所示每月1號開始,每隔三天觸發一次。
L 表示最後的意思。在日字段設置上,表示當月的最後一天(依據當前月份,如果是二月還會依據是否是潤年[leap]), 在周字段上表示星期六,相當於”7”或”SAT”。如果在”L”前加上數字,則表示該數據的最後一個。例如在周字段上設置”6L”這樣的格式,則表示“本月最後一個星期五”
W 表示離指定日期的最近那個工作日(週一至週五). 例如在日字段上設置”15W”,表示離每月15號最近的那個工作日觸發。如果15號正好是週六,則找最近的週五(14號)觸發, 如果15號是周未,則找最近的下週一(16號)觸發.如果15號正好在工作日(週一至週五),則就在該天觸發。如果指定格式爲 “1W”,它則表示每月1號往後最近的工作日觸發。如果1號正是週六,則將在3號下週一觸發。(注,”W”前只能設置具體的數字,不允許區間”-“).
小提示 ‘L’和 ‘W’可以一組合使用。如果在日字段上設置”LW”,則表示在本月的最後一個工作日觸發
# 序號(表示每月的第幾個周幾),例如在周字段上設置”6#3”表示在每月的第三個週六.注意如果指定”#5”,正好第五週沒有周六,則不會觸發該配置(用在母親節和父親節再合適不過了)
小提示 :周字段的設置,若使用英文字母是不區分大小寫的 MON 與mon相同.
舉例:
- 1 * * * * ? 每分鐘第一秒觸發
- 59 15 13 * * ? 每天13點15分59秒觸發
- 0 15 10 * * ? 2017 2017年每天10點15分觸發
- 0/3 * * * * ? 從0秒開始每隔3秒觸發一次
- 0 10,44 14 ? 3 WED 3月分每週三下午的 2點10分和2點44分觸發
- 0 15 10 ? * MON-FRI 從週一到週五每天上午的10點15分觸發
- 0 15 10 ? * 6L 每月最後一週的星期五的10點15分觸發
- 0 15 10 ? * 6#3 每月的第三週的星期五開始觸發