更新時間:2022-09-28 15:22:05 來源:動力節點 瀏覽1403次
Quartz相較于Timer, Quartz增加了很多功能:
持久性作業 - 就是保持調度定時的狀態;
作業管理 - 對調度作業進行有效的管理;
1.引入依賴
<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>
2.入門案例
任務:將任務類執行 10 次,每次間隔 3 秒。
任務類,需要實現 Job 接口
package com.sugar.quartz.utils;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import java.text.SimpleDateFormat;
import java.util.Date;
/**
* 功能描述: 任務
*
* @author XiaoNianXin
* @date 2021/12/13 20:52
*/
public class HelloJob implements Job {
@Override
public void execute(JobExecutionContext context) throws JobExecutionException {
// 獲取當前時間,并格式化
Date date = new Date();
SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
String dateSrting = format.format(date);
// 業務功能模擬
System.out.println("開始備份數據庫,時間:" + dateSrting);
}
}
定時器類
package com.sugar.quartz.utils;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
/**
* 功能描述: 定時器配置
*
* @author XiaoNianXin
* @date 2021/12/13 21:08
*/
public class HelloSchedulerDemo {
public static void main(String[] args) throws SchedulerException {
// 1、調度器 - 從工廠獲取調度實例
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
// 2、任務實例 - 執行的任務對象
JobDetail job = JobBuilder.newJob(HelloJob.class)
.withIdentity("job1", "group1") // 任務名稱,組名稱
.build();
// 3、觸發器 - 控制執行次數和執行時間
Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity("trigger1", "group1") // 同上
.startNow() // 立刻啟動
.withSchedule(SimpleScheduleBuilder.simpleSchedule().
withIntervalInSeconds(3).
withRepeatCount(10)) // 循環10次,每次間隔3s
.build();
// 調度器關聯觸發器,并啟動
scheduler.scheduleJob(job,trigger);
scheduler.start();
}
}
3.Job 與 JobDetail
Job:基于反射的任務調度接口,所有任務類都要實現該接口,在接口的 execute 里編寫自己的業務邏輯。
Job 生命周期:每次執行 Job,在 execute 方法前會創建新的 Job實例,調用后實例被釋放,再被GC回收。
JobDetail:封裝 Job,給 Job 實例提供許多屬性。
JobDetail 屬性:name、group、jobClass、jobDataMap。
4.JobExecutionContext
下文將 JobExecutionContext 簡稱為 JEC
JEC :當調度器調用 Job 時,會將 JEC 傳遞給 Job 的 execute 方法。
JEC 作用:Job 通過 JEC 獲取運行環境信息,以及 Job 信息。
5.JobDataMap
下文將 JobDataMap 簡稱為 JDM
JDM:任務調度時,JDM 存儲在 JEC 中,方便獲取。
JDM 優點:實現 Map 接口,可以存取任何可序列化對象,Job 執行時會將參數傳給 JDM。
手動獲取 JDM 參數案例
HelloSchedulerDemo:
package com.sugar.quartz.utils;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
/**
* 功能描述: 定時器配置
*
* @author XiaoNianXin
* @date 2021/12/13 21:08
*/
public class HelloSchedulerDemo {
public static void main(String[] args) throws SchedulerException {
// 1、調度器 - 從工廠獲取調度實例
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
// 2、任務實例 - 執行的任務對象
JobDetail job = JobBuilder.newJob(HelloJob.class)
.withIdentity("job1", "group1") // 任務名稱,組名稱
.usingJobData("msg","JDM使用 - Detail") // JDM 傳遞參數
.build();
// 3、觸發器 - 控制執行次數和執行時間
Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity("trigger1", "group1") // 同上
.startNow() // 立刻啟動
.withSchedule(SimpleScheduleBuilder.simpleSchedule().
withIntervalInSeconds(3).
withRepeatCount(10)) // 循環10次,每次間隔3s
.usingJobData("msg","JDM使用 - Trigger")
.build();
// 調度器關聯觸發器,并啟動
scheduler.scheduleJob(job,trigger);
scheduler.start();
}
}
HelloJob:
package com.sugar.quartz.utils;
import org.quartz.Job;
import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import java.text.SimpleDateFormat;
import java.util.Date;
/**
* 功能描述: 定時業務功能
*
* @author XiaoNianXin
* @date 2021/12/13 20:52
*/
public class HelloJob implements Job {
@Override
public void execute(JobExecutionContext context) throws JobExecutionException {
// 獲取當前時間,并格式化
Date date = new Date();
SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
String dateSrting = format.format(date);
// 獲取 JDM
JobDataMap Detail_JDM = context.getJobDetail().getJobDataMap();
JobDataMap Trigger_JDM = context.getTrigger().getJobDataMap();
String detail_jdmString = Detail_JDM.getString("msg");
String trigger_jdmString = Trigger_JDM.getString("msg");
System.out.println("---------------------------------------------------");
System.out.println("detail_jdmString = " + detail_jdmString);
System.out.println("trigger_jdmString = " + trigger_jdmString);
// 業務功能模擬
System.out.println("開始備份數據庫,時間:" + dateSrting);
// 其他內容
System.out.println("Job 運行時間:" + context.getJobRunTime());
System.out.println("Job 當前運行時間:" + context.getFireTime());
System.out.println("Job 下次運行時間:" + context.getNextFireTime());
System.out.println("---------------------------------------------------");
}
}
HelloJob:
// 實例化時自動綁定 JDM key對應的值
private String msg;
public void setMsg(String msg) {
this.msg = msg;
}
// 獲取 JDM
System.out.println(Trigger JDM : " + msg);
問題:上文中 JobDetail 和 Trigger 中的 JDM 的 key 均為 "msg",那此 msg 是哪一個?
E.g:遇到同名key,Trigger 會覆蓋 JobDetail 的值,所以 msg 為 Trigger JDM 的值。
1.Job 狀態
有狀態 Job:多次調用 Job 期間,公用同一個 JDM。
有狀態 Job:多次調用 Job 期間,每次新建一個新的 JDM。
有無狀態 Job 區別案例
預期:無狀態 count 輸出永遠為 1,有狀態 count 輸出累加。
HelloSchedulerDemo:
// JobDeatil 添加一個 JDM,用做計數器
.usingJobData("count",0)
無狀態 HelloJob:
package com.sugar.quartz.utils;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import java.text.SimpleDateFormat;
import java.util.Date;
/**
* 功能描述: 任務類
*
* @author XiaoNianXin
* @date 2021/12/13 20:52
*/
public class HelloJob implements Job {
// 實例化時自動綁定 JDM key對應的值
private String msg;
private Integer count;
public void setMsg(String msg) {
this.msg = msg;
}
public void setCount(Integer count) {
this.count = count;
}
@Override
public void execute(JobExecutionContext context) throws JobExecutionException {
// 獲取當前時間,并格式化
Date date = new Date();
SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
String dateSrting = format.format(date);
// 獲取 JDM
System.out.println("---------------------------------------------------");
System.out.println("Trigger JDM : " + msg);
System.out.println("Count : " + count);
// 更新 JobDetail JDM 的 count
count++;
context.getJobDetail().getJobDataMap().put("count",count);
// 業務功能模擬
System.out.println("開始備份數據庫,時間:" + dateSrting);
// 其他內容
System.out.println("Job 運行時間:" + context.getJobRunTime());
System.out.println("Job 當前運行時間:" + context.getFireTime());
System.out.println("Job 下次運行時間:" + context.getNextFireTime());
System.out.println("---------------------------------------------------");
}
}
有狀態 HelloJob:
// 任務類加上下面注解,多次調用 Job,會持久化 Job,JDM 的數據會被保存,供下次使用
@PersistJobDataAfterExecution
2.Trigger
Trigger 常用:SimpleTrigger、CronTrigger。
JobKey:Job 實例標識,觸發器觸發時,執行 JobKey 對應任務。
StartTime:第一次觸發時間。
EndTime:終止觸發時間。
Trigger 獲取參數案例
HelloSchedulerTriggerDemo:
package com.sugar.quartz.utils;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
import java.util.Date;
/**
* 功能描述: 定時器配置2
*
* @author XiaoNianXin
* @date 2021/12/13 21:08
*/
public class HelloSchedulerTriggerDemo {
public static void main(String[] args) throws SchedulerException {
// 任務開始時間推遲 3 s,結束時間推遲 10 s
Date startData = new Date();
startData.setTime(startData.getTime() + 3000);
Date endData = new Date();
endData.setTime(endData.getTime() + 10000);
// 1、調度器 - 從工廠獲取調度實例
Scheduler scheduler = StdSchedulerFactory.getDefaultScheduler();
// 2、任務實例 - 執行的任務對象
JobDetail job = JobBuilder.newJob(helloJobTrigger.class)
.withIdentity("job1", "group1") // 任務名稱,組名稱
.usingJobData("msg","JDM使用 - Detail") // JDM 傳遞參數
.build();
// 3、觸發器 - 控制執行次數和執行時間
Trigger trigger = TriggerBuilder.newTrigger()
.withIdentity("trigger1", "group1") // 同上
.startNow() // 立刻啟動
.startAt(startData)
.endAt(endData)
.build();
// 調度器關聯觸發器,并啟動
scheduler.scheduleJob(job,trigger);
scheduler.start();
}
}
helloJobTrigger:
package com.sugar.quartz.utils;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.quartz.PersistJobDataAfterExecution;
import java.text.SimpleDateFormat;
import java.util.Date;
/**
* 功能描述: 任務類2
*
* @author XiaoNianXin
* @date 2021/12/13 20:52
*/
@PersistJobDataAfterExecution
public class helloJobTrigger implements Job {
@Override
public void execute(JobExecutionContext context) throws JobExecutionException {
// 獲取當前時間,并格式化
Date date = new Date();
SimpleDateFormat format = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
String dateSrting = format.format(date);
// 業務功能模擬
System.out.println("---------------------------------------------------");
System.out.println("開始備份數據庫,時間:" + dateSrting);
// 獲取 JobKey,StartTime,EndTime
System.out.println("JobKey : " + context.getTrigger().getJobKey());
System.out.println("StartTime : " + format.format(context.getTrigger().getStartTime()));
System.out.println("EndTime : " + format.format(context.getTrigger().getEndTime()));
System.out.println("---------------------------------------------------");
}
}
// 運行結果
---------------------------------------------------
開始備份數據庫,時間:2021-12-13 23:25:06
JobKey : group1.job1
StartTime : 2021-12-13 23:25:06
EndTime : 2021-12-13 23:25:13
3.SimpleTripper
下文將 SimpleTripper 簡稱為 ST
ST:特定時間范圍啟動/結束,且以一個時間間隔重復 n 次 Job 所設計。
ST 屬性:開始時間、結束時間、重復次數和時間間隔。
ST 提示:指定了結束時間,那么結束時間優先級 > 重復次數。
0基礎 0學費 15天面授
有基礎 直達就業
業余時間 高薪轉行
工作1~3年,加薪神器
工作3~5年,晉升架構
提交申請后,顧問老師會電話與您溝通安排學習