quartz 是一款開源且豐富特性的Java 任務排程庫,用於實現任務排程和定時任務。它支援各種任務型別和靈活的設定選項,具備作業持久化、叢集和分散式排程、錯誤處理和重試機制等功能。Quartz被廣泛應用於各種應用程式中,提供可靠和靈活的任務排程解決方案。
我們想要排程的任務都必須實現 org.quartz.job 介面,然後實現介面中定義的 execute( ) 方法即可。
但是我們這裡使用設定類的方法,可不實現 job介面 直接,在裡面定義自己的方法,去實現任務邏輯
Trigger 作為執行任務的排程器,它規定安排了關聯的任務會在什麼時候執行,並且表明了再次執行的時機。我們如果想要凌晨1點執行備份資料的任務,那麼 Trigger 就會設定凌晨1點執行該任務。
其中 Trigger 的實現又分為 SimpleTrigger , CronTrigger ,CalendarIntervalTrigger, DailyTimeIntervalTrigger, MutableTrigger ,OperableTrigger 幾種
一般情況下我們使用是的是 CronTrigger ,因為這個可以編寫 cron 表示式,對時間的客製化化更高,編寫更方便。對 Trigger 的各種實現和更詳細的內容本文就不過多介紹,有興趣的小夥伴可以自行百度。
這裡提供一個cron表示式線上生成網址:http://cron.ciding.cc/
Scheduler 為任務的排程器,它會將任務 Job 及觸發器 Trigger 整合起來,負責基於 Trigger 設定的時間來執行 Job
三者的關係圖為:
兩個任務分別不同時間去執行:
QuartzFirst :每天晚上22.30 執行
QuartzSecond:每天晚上 23.00 執行
想馬上看到效果可自己修改cron 表示式,或者把下面提供 cron 註釋開啟
在 pom.xml 中新增 Quartz 依賴,
<!--定時任務 核心包-->
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz</artifactId>
<version>2.3.2</version>
</dependency>
<!--工具-->
<dependency>
<groupId>org.quartz-scheduler</groupId>
<artifactId>quartz-jobs</artifactId>
<version>2.3.2</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.7</version>
<scope>compile</scope>
</dependency>
@Configuration
public class QuartzConfig {
/**
* 設定定時任務1的任務範例
* @param job 任務 QuartzFirst 這個是自己定義job,這裡是 類名
*/
@Bean(name = "firstJobDetail")
public MethodInvokingJobDetailFactoryBean firstJobDetail(QuartzFirst job) {
MethodInvokingJobDetailFactoryBean jobDetail = new MethodInvokingJobDetailFactoryBean();
// 是否並行執行
jobDetail.setConcurrent(false);
// 為需要執行的實體類對應的物件
jobDetail.setTargetObject(job);
// 需要執行的方法
jobDetail.setTargetMethod("JobTest");
return jobDetail;
}
/**
* 設定觸發器1
* @param firstJobDetail 第一個觸發器
* @return
*/
@Bean(name = "firstTrigger")
public CronTriggerFactoryBean firstTrigger(JobDetail firstJobDetail) {
CronTriggerFactoryBean trigger = new CronTriggerFactoryBean();
trigger.setJobDetail(firstJobDetail);
// 設定任務啟動延遲
trigger.setStartDelay(0);
// 設定定時任務啟動時間
trigger.setStartTime(new Date());
// 每晚 22.30 執行
trigger.setCronExpression("0 30 22 ? * *");
// 每3秒 執行一次
//trigger.setCronExpression("0/3 * * * * ?");
// 每5秒執行一次
//trigger.setRepeatInterval(5000);
return trigger;
}
/**
* 設定定時任務2的任務範例
* @param job 任務 QuartzSecond 這個是自己定義job,這裡是 類名
*/
@Bean(name = "secondJobDetail")
public MethodInvokingJobDetailFactoryBean secondJobDetail(QuartzSecond job) {
MethodInvokingJobDetailFactoryBean jobDetail = new MethodInvokingJobDetailFactoryBean();
// 是否並行執行
jobDetail.setConcurrent(true);
// 為需要執行的實體類對應的物件
jobDetail.setTargetObject(job);
// 需要執行的方法
jobDetail.setTargetMethod("JobTest");
return jobDetail;
}
/**
* 設定觸發器2
* @param secondJobDetail 第二個觸發器
* @return
*/
@Bean(name = "secondTrigger")
public CronTriggerFactoryBean secondTrigger(JobDetail secondJobDetail) {
CronTriggerFactoryBean trigger = new CronTriggerFactoryBean();
trigger.setJobDetail(secondJobDetail);
// 設定定時任務啟動時間
trigger.setStartTime(new Date());
// cron表示式(每天晚上23點執行)
trigger.setCronExpression("0 0 23 ? * *");
// 每 5 秒 執行一次
//trigger.setCronExpression("0/5 * * * * ?");
return trigger;
}
/**
* 定義 任務,傳入 triggers
* @param triggers 觸發器
* @return
*/
@Bean
public SchedulerFactoryBean scheduler1(Trigger... triggers){
SchedulerFactoryBean factoryBean = new SchedulerFactoryBean();
// 設定 triggers
factoryBean.setTriggers( triggers );
// 用於quartz叢集,QuartzScheduler 啟動時更新己存在的Job
factoryBean.setOverwriteExistingJobs(true);
// 延時啟動,應用啟動3秒後
factoryBean.setStartupDelay(3);
return factoryBean;
}
}
上面 QuartzFirst 和 QuartzSecond 類是自己定義的job類,把 類名 作為引數傳遞,然後中 job 類中就可以實現自己的業務邏輯。
QuartzFirst
@Configuration
public class QuartzFirst {
public Logger log = LoggerFactory.getLogger(QuartzFirst.class);
@Resource
AttendanceRecordBiz attendanceRecordBiz;
public void JobTest(){
// DateUtil 這個是hutool 的工具類
log.info(" 執行開始時間為:" + DateUtil.date());
/**
* 在這裡就可以實現自己的邏輯,比如執行某個方法,和 DB 互動等,都可以在上面進行注入,和寫普通的是實現方法一樣就行
*
**/
log.info("點個贊哦 ~~~")
log.info(" 執行結束時間為:" + DateUtil.date());
}
}
QuartzSecond
@Configuration
public class QuartzSecond {
public Logger log = LoggerFactory.getLogger(QuartzSecond.class);
@Resource
SalaryDataBiz salaryDataBiz;
public void JobTest(){
// DateUtil 這個是hutool 的工具類
log.info(" 執行開始時間為:" + DateUtil.date());
/**
* 在這裡就可以實現自己的邏輯,比如執行某個方法,和 DB 互動等,都可以在上面進行注入,和寫普通的是實現方法一樣就行
*
**/
log.info("點個贊哦 ~~~")
log.info(" 執行結束時間為:" + DateUtil.date());
}
}
到這裡就實現定時任務了,在專案啟動的時候後 3 秒就會去開啟定時任務了。程式碼簡單,功能強大。
歡迎大家多多點贊支援 o~o