Spring+Quartz實現(xiàn)動態(tài)任務(wù)調(diào)度詳解
更新時間：2024年01月09日 08:38:14 作者：it_lihongmin
這篇文章主要介紹了Spring+Quartz實現(xiàn)動態(tài)任務(wù)調(diào)度詳解,最近經(jīng)常基于spring?boot寫定時任務(wù),并且是使用注解的方式進行實現(xiàn),分成的方便將自己的類注入spring容器,需要的朋友可以參考下
一、定時任務(wù)的實現(xiàn)
1、配置文件方式
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd"> <beans> <bean id="userTimer" class="com.kevin.timer.XmlTimer"></bean> <bean id="userTask" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean"> <property name="targetObject"> <ref bean="userTimer" /> </property> <property name="targetMethod"> <value>execute</value> </property> </bean> <!-- 每隔5秒鐘執(zhí)行一次，我要在運行時動態(tài)修改為每小時執(zhí)行一次 --> <bean id="userTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean"> <property name="jobDetail"> <ref bean="userTask" /> </property> <property name="cronExpression"> <value>0/5 * * * * ?</value> </property> </bean> <bean id="startQuertz" lazy-init="false" autowire="no" class="org.springframework.scheduling.quartz.SchedulerFactoryBean"> <property name="triggers"> <list> <ref bean="userTrigger" /> </list> </property> </bean> </beans>
2、注解方式
我最近經(jīng)常基于spring boot寫定時任務(wù)，并且是使用注解的方式進行實現(xiàn)，分成的方便將自己的類注入spring容器（@conponent等），
并在要實現(xiàn)父方法上添加注解 @Scheduled(cron="0/10 * * * * ?") ,告知任務(wù)調(diào)度器質(zhì)性方法中的業(yè)務(wù)邏輯的質(zhì)性時間。
二、任務(wù)調(diào)用的工作原理
三、動態(tài)任務(wù)調(diào)用的實現(xiàn)
首先定義任務(wù)實體應(yīng)該具有的屬性：
package com.kevin.schedule.entity;
/**
* 調(diào)度任務(wù)定義
* @author Tom
*
*/
public class Task {
private String id; //任務(wù)ID,默認系統(tǒng)時間戳
private String parentId = ""; //父級任務(wù)ID
private String name = ""; //任務(wù)名稱
private String desc = ""; //任務(wù)描述
private int planExe = 0; //計劃執(zhí)行次數(shù),默認為0，表示滿足條件循環(huán)執(zhí)行
private String group = ""; //任務(wù)組名稱
private String groupDesc = ""; //任務(wù)組描述
private String cron = ""; //任務(wù)表達式
private String cronDesc = ""; //表達式描述
private String trigger = ""; //觸發(fā)器
private String triggerDesc = "";//觸發(fā)器描述
private int execute = 0; //任務(wù)被執(zhí)行過多少次
private Long lastExeTime = 0L; //最后一次開始執(zhí)行時間
private Long lastFinishTime = 0L;//最后一次執(zhí)行完成時間
private int state = 1; //任務(wù)狀態(tài)0禁用、1啟動、2刪除
private int deply = 0; //延時啟動，默認為0，表示不延時啟動
public Task(String taskId){
this.id = taskId;
}
public String getId() {
return id;
}
public void setId(String id) {
this.id = id;
}
public String getParentId() {
return parentId;
}
public void setParentId(String parentId) {
this.parentId = parentId;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getCron() {
return cron;
}
public void setCron(String cron) {
this.cron = cron;
}
public String getCronDesc() {
return cronDesc;
}
public void setCronDesc(String cronDesc) {
this.cronDesc = cronDesc;
}
// public List<ScheduleJob> getChildren() {
// return children;
// }
// public void setChildren(List<ScheduleJob> children) {
// this.children = children;
// }
public int getExecute() {
return execute;
}
public void setExecute(int execute) {
this.execute = execute;
}
public String getDesc() {
return desc;
}
public void setDesc(String desc) {
this.desc = desc;
}
public String getGroup() {
return group;
}
public void setGroup(String group) {
this.group = group;
}
public String getGroupDesc() {
return groupDesc;
}
public void setGroupDesc(String groupDesc) {
this.groupDesc = groupDesc;
}
public int getState() {
return state;
}
public void setState(int state) {
this.state = state;
}
public Long getLastExeTime() {
return lastExeTime;
}
public void setLastExeTime(Long lastExeTime) {
this.lastExeTime = lastExeTime;
}
public String getTrigger() {
return trigger;
}
public void setTrigger(String trigger) {
this.trigger = trigger;
}
public String getTriggerDesc() {
return triggerDesc;
}
public void setTriggerDesc(String triggerDesc) {
this.triggerDesc = triggerDesc;
}
public int getDeply() {
return deply;
}
public void setDeply(int deply) {
this.deply = deply;
}
public int getPlanExe() {
return planExe;
}
public void setPlanExe(int planExe) {
this.planExe = planExe;
}
// public String getTriggerGroup() {
// return triggerGroup;
// }
// public void setTriggerGroup(String triggerGroup) {
// this.triggerGroup = triggerGroup;
// }
// public String getTriggerGroupDesc() {
// return triggerGroupDesc;
// }
// public void setTriggerGroupDesc(String triggerGroupDesc) {
// this.triggerGroupDesc = triggerGroupDesc;
// }
public Long getLastFinishTime() {
return lastFinishTime;
}
public void setLastFinishTime(Long lastFinishTime) {
this.lastFinishTime = lastFinishTime;
}
}package com.kevin.schedule.proxy;
import java.lang.reflect.Method;
import org.quartz.Job;
import org.quartz.JobDataMap;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import com.gupaoedu.schedule.entity.Task;
/**
*
* @author Tom
*
*/
public class TriggerProxy implements Job{
public static final String DATA_TARGET_KEY = "target"; //目標對象，實例
public static final String DATA_TRIGGER_KEY = "trigger"; //方法名
public static final String DATA_TRIGGER_PARAMS_KEY = "trigger_params";//方法的參數(shù)值
public static final String DATA_TASK_KEY = "task"; //自己封裝的任務(wù)對象
private ThreadLocal<Entry> local = new ThreadLocal<Entry>();
//是由調(diào)度器自動調(diào)用的
public void execute(JobExecutionContext context) throws JobExecutionException {
// TriggerProxy.class.getResource("")
try {
local.set(new Entry());
//獲取參數(shù)信息
JobDataMap data = context.getTrigger().getJobDataMap();
Object target = data.get(DATA_TARGET_KEY);
Method method = (Method)data.get(DATA_TRIGGER_KEY);
Object[] params = (Object[])data.get(DATA_TRIGGER_PARAMS_KEY);
//修改任務(wù)執(zhí)行次數(shù)
Task task = (Task)data.get(DATA_TASK_KEY);
//任務(wù)沒執(zhí)行一次，需要累加1
task.setExecute(task.getExecute() + 1);
local.get().start = System.currentTimeMillis();
//調(diào)用觸發(fā)器，用反射調(diào)用我們自己定義的方法
method.invoke(target,params);
local.get().end = System.currentTimeMillis();
//記錄任務(wù)的最后一次執(zhí)行時間
task.setLastExeTime(local.get().start);
//記錄任務(wù)完成的時間
task.setLastFinishTime(local.get().end);
} catch (Exception e) {
e.printStackTrace();
}
}
class Entry{
public long start = 0L;
public long end = 0L;
}
}@Component
public class AnnotationTimer {
Logger LOG = Logger.getLogger(this.getClass());
@Scheduled(cron="0/10 * * * * ?")
@Async
public void a(){
LOG.info("annotation配置的任務(wù)執(zhí)行");
}
}定義動態(tài)任務(wù)調(diào)度需要的方法，在web項目中，通過界面的方式調(diào)用方法以動態(tài)控制和查看任務(wù)調(diào)度的執(zhí)行情況：
package com.kevin.schedule.service;
import java.util.List;
import com.gupaoedu.schedule.entity.Task;
public interface IScheduleService {
/**
* 獲取任務(wù)列表
* @return
*/
public List<Task> getAllTask();
/**
* 根據(jù)任務(wù)ID獲取一個任務(wù)
* @return
*/
public Task getTask(String taskId);
/**
* 新建一個任務(wù)
* @param taskName 任務(wù)名稱
* @param taskClassName 任務(wù)Class名稱
* @param triggerName 觸發(fā)器名稱
* @param cron 執(zhí)行表達式
* @throws Exception
*/
public Task createTask(String taskName,String taskClassName,String triggerName,String cron) throws Exception;
/**
* 修改一個任務(wù)的觸發(fā)時間(使用默認的任務(wù)組名，觸發(fā)器名，觸發(fā)器組名)
*
*/
public Task modifyTaskCron(String taskId, String cron);
/**
* 移除一個任務(wù)(使用默認的任務(wù)組名，觸發(fā)器名，觸發(fā)器組名)
*
*/
public Task removeTask(String taskId);
/**
* 重啟任務(wù)
* @param taskId
* @return
*/
public Task restartTask(String taskId);
/**
* 暫停定時任務(wù)
* @param taskId
* @return
*/
public Task pauseTask(String taskId);
/**
* 關(guān)閉定時任務(wù)
* @param taskId
* @return
*/
public Task shutdownTask(String taskId);
/**
* 啟動所有定時任務(wù)
*
*/
public void startAllTask();
/**
* 關(guān)閉所有定時任務(wù)
*/
public void shutdownAllTask();
}實現(xiàn)方法：
package com.kevin.schedule.service.impl;
import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.quartz.CronTrigger;
import org.quartz.JobDetail;
import org.quartz.Scheduler;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.scheduling.quartz.SchedulerFactoryBean;
import org.springframework.stereotype.Service;
import com.gupaoedu.schedule.entity.Task;
import com.gupaoedu.schedule.proxy.TriggerProxy;
import com.gupaoedu.schedule.service.IScheduleService;
/**
* 任務(wù)管理，負責(zé)輸出和管理日志
* @author Tom
*/
@Service
public class ScheduleService implements IScheduleService,ApplicationContextAware{
//自己不能再重新搞一個工廠出來，必須和Spring引用的調(diào)度工廠是同一個
//才能實現(xiàn)無縫集成，而且可以動態(tài)修改配置文件已經(jīng)配置好的任務(wù)
@Autowired private SchedulerFactoryBean schedulerFactory;
//保存所有任務(wù)表達式的描述
private Map<String,String> cronDesc = new LinkedHashMap<String,String>();
//所有的任務(wù)都放到任務(wù)池中
private static Map<String,Task> taskPool = new LinkedHashMap<String,Task>();
private static ApplicationContext app;
public ScheduleService(){}
/**
* 創(chuàng)建一個調(diào)度任務(wù)
* @param m
* @return
* @throws Exception
*/
private Task createTask(Method m) throws Exception{
//任務(wù)ID就是時間戳，再加上一個隨機數(shù)
Task task = new Task("" + System.currentTimeMillis());
//通過方法，可以獲取到方法所在的class
Class clazz = m.getDeclaringClass();
//設(shè)置任務(wù)組
task.setGroup(clazz.getName());
//設(shè)置觸發(fā)器信息
//一個觸發(fā)器對應(yīng)一個方法，在此處，所謂的觸發(fā)器還只是一個概念
//概念是一個字符描述，它記錄了觸發(fā)的目標信息
task.setTrigger(clazz.getName() + "." + m.getName());
Annotation sc = m.getAnnotation(Scheduled.class);
Method cronM = sc.getClass().getMethod("cron",null);
String cron = cronM.invoke(sc, null).toString();
task.setTriggerDesc(cronDesc.get(cron));
task.setCron(cron);
task.setCronDesc(cronDesc.get(cron));
//此時，就已經(jīng)完成一個task的封裝
return task;
}
@Override
public void setApplicationContext(ApplicationContext app) throws BeansException {
this.app = app;
//加載所有任務(wù)到任務(wù)隊列
for(String name : app.getBeanDefinitionNames()){
try{
Class<?> c = app.getBean(name).getClass();
for(Method m : c.getMethods()){
//只要是添加了Scheduled注解的都給他添加到調(diào)度工廠中
if(m.isAnnotationPresent(Scheduled.class)){
Task task = createTask(m);
//將任務(wù)加入隊列準備啟動
createTask(task);
}
}
}catch(Exception e){
continue;
}
}
}
public Task getTask(String taskId) {
return taskPool.get(taskId);
}
@Override
public List<Task> getAllTask() {
if(taskPool.size() == 0){
return new ArrayList<Task>();
}
List<Task> r = new ArrayList<Task>();
r.addAll(taskPool.values());
return r;
}
private Task createTask(Task task) throws Exception{
if(null == task.getGroup() || task.getGroup().trim().length() == 0){ return null; }
//還是拿到字節(jié)碼
Class<?> clazz = Class.forName(task.getGroup());
//先從容器中獲取
Object target = null;
try{
//從Spring容器中提取已經(jīng)創(chuàng)建好的對象引用
target = app.getBean(clazz);
}catch(Exception e){
}
//如果Spring容器沒有幫我們創(chuàng)建，那么就自己創(chuàng)建實例
if(target == null){
target = clazz.newInstance();
}
//把觸發(fā)器需要調(diào)用的方法找出來，還是用反射
Method m = clazz.getMethod(task.getTrigger().replaceAll(task.getGroup() + ".", ""));
//把任務(wù)ID取出來，時間戳
String taskId = task.getId();
//================ 事前準備 ====================
//拿到Quartz中的調(diào)度器
Scheduler sched = schedulerFactory.getScheduler();
//創(chuàng)建一個Detail
JobDetail taskDetail = new JobDetail(taskId, task.getGroup(), TriggerProxy.class);// 任務(wù)名，任務(wù)組，任務(wù)執(zhí)行類
// 觸發(fā)器
CronTrigger trigger = new CronTrigger(taskId, task.getTrigger());// 觸發(fā)器名,觸發(fā)器組
//在這里設(shè)置CronExpression表達式
trigger.setCronExpression(task.getCron());// 觸發(fā)器時間設(shè)定
//JobDataMap 用來存儲附加信息
//利用這么一個API，把自定義的信息添加到Map中
trigger.getJobDataMap().put(TriggerProxy.DATA_TARGET_KEY, target);
trigger.getJobDataMap().put(TriggerProxy.DATA_TRIGGER_KEY, m);
// m.getParameterTypes()
trigger.getJobDataMap().put(TriggerProxy.DATA_TRIGGER_PARAMS_KEY, new Object[]{});
trigger.getJobDataMap().put(TriggerProxy.DATA_TASK_KEY, task);
sched.scheduleJob(taskDetail, trigger);
// 如果這個任務(wù)沒有被主動關(guān)閉，我們就給他啟動
if (!sched.isShutdown()) {
sched.start();
}
//放入我們的任務(wù)池
if(!taskPool.containsKey(taskId)){
taskPool.put(taskId, task);
}
return task;
}
/**
* 添加一個定時任務(wù)，使用默認的任務(wù)組名，觸發(fā)器名，觸發(fā)器組名
*/
public Task createTask(String taskName,String taskClassName,String triggerName,String cron) throws Exception{
return createTask(taskName,null,taskClassName,null,triggerName,cron);
}
/**
* 添加一個定時任務(wù)
*/
private Task createTask(String taskName, String taskGroupName, String taskClassName,String triggerGroupName, String triggerName,String cron) throws Exception{
//根據(jù)類名，利用反射機制獲取到類的字節(jié)碼
//約定優(yōu)于配置
Class<?> clazz = Class.forName(taskClassName); //就是類名全程，包名.類名
Method m = clazz.getMethod(triggerName); //顯然就是方法名
Task task = createTask(m);
task.setName(taskName);
if(null != taskGroupName){
task.setGroup(taskGroupName);
}
task.setCron(cron);
return createTask(task);
}
/**
* 修改一個任務(wù)的觸發(fā)時間(使用默認的任務(wù)組名，觸發(fā)器名，觸發(fā)器組名)
*
*/
public Task modifyTaskCron(String taskId, String cron) {
Task task = taskPool.get(taskId);
try {
Scheduler sched = schedulerFactory.getScheduler();
CronTrigger trigger = (CronTrigger) sched.getTrigger(taskId,task.getTrigger());
String oldTime = trigger.getCronExpression();
if (!oldTime.equalsIgnoreCase(cron)) {
JobDetail taskDetail = sched.getJobDetail(taskId,task.getGroup());
Class objJobClass = taskDetail.getJobClass();
removeTask(taskId);
//重新生成ID
task.setId("" + System.currentTimeMillis());
task.setCron(cron);
createTask(task);
}
} catch (Exception e) {
throw new RuntimeException(e);
}
return task;
}
/**
* 移除一個任務(wù)(使用默認的任務(wù)組名，觸發(fā)器名，觸發(fā)器組名)
*
*/
public Task removeTask(String taskId) {
Task task = taskPool.get(taskId);
try {
Scheduler sched = schedulerFactory.getScheduler();
sched.pauseTrigger(taskId, task.getTrigger());// 停止觸發(fā)器
sched.unscheduleJob(taskId, task.getGroup());// 移除觸發(fā)器
sched.deleteJob(taskId, task.getGroup());// 刪除任務(wù)
taskPool.remove(taskId);
} catch (Exception e) {
throw new RuntimeException(e);
}
return task;
}
/**
* 暫停任務(wù)
* @param taskId
*/
public Task pauseTask(String taskId){
Task task = taskPool.get(taskId);
try {
Scheduler sched = schedulerFactory.getScheduler();
sched.pauseTrigger(task.getId(), task.getTrigger());// 停止觸發(fā)器
} catch (Exception e) {
throw new RuntimeException(e);
}
return task;
}
/**
*
*
*/
public Task restartTask(String taskId) {
Task task = taskPool.get(taskId);
try {
Scheduler sched = schedulerFactory.getScheduler();
// 重啟觸發(fā)器
sched.resumeTrigger(task.getId(),task.getTrigger());
} catch (Exception e) {
throw new RuntimeException(e);
}
return task;
}
/**
* 關(guān)閉任務(wù)
* @param taskId
*/
public Task shutdownTask(String taskId){
Task task = taskPool.get(taskId);
try {
Scheduler sched = schedulerFactory.getScheduler();
sched.pauseTrigger(taskId, task.getTrigger());// 停止觸發(fā)器
sched.unscheduleJob(taskId, task.getGroup());// 移除觸發(fā)器
sched.deleteJob(taskId, task.getGroup());// 刪除任務(wù)
} catch (Exception e) {
throw new RuntimeException(e);
}
return task;
}
/**
* 啟動所有定時任務(wù)
*
*/
public void startAllTask() {
try {
Scheduler sched = schedulerFactory.getScheduler();
sched.start();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
/**
* 關(guān)閉所有定時任務(wù)
*/
public void shutdownAllTask() {
try {
Scheduler sched = schedulerFactory.getScheduler();
if (!sched.isShutdown()) {
sched.shutdown();
}
} catch (Exception e) {
throw new RuntimeException(e);
}
}
}到此這篇關(guān)于Spring+Quartz實現(xiàn)動態(tài)任務(wù)調(diào)度詳解的文章就介紹到這了,更多相關(guān)Spring+Quartz動態(tài)任務(wù)內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
今天我們來討論另外一類容器：阻塞隊列,文中有非常詳細的代碼示例及介紹,對正在學(xué)習(xí)JAVA的小伙伴們很有幫助,需要的朋友可以參考下2021-06-06
這篇文章主要介紹了Spring Batch批處理框架使用解析,文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-12-12
Maven配置倉庫、阿里云鏡像、環(huán)境變量(史上最全)
本文主要介紹了Maven配置倉庫、阿里云鏡像、環(huán)境變量,文中通過圖文示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2024-07-07
什么是Maven及如何配置國內(nèi)源實現(xiàn)自動獲取jar包的操作
本文介紹了Maven的基本概念,包括項目構(gòu)建、依賴管理、倉庫管理以及如何設(shè)置國內(nèi)源,通過Maven,開發(fā)者可以自動化管理項目的依賴和構(gòu)建流程,提高開發(fā)效率,感興趣的朋友跟隨小編一起看看吧2024-11-11
在本篇文章里小編給大家整理的是一篇關(guān)于java中Hibernate面試知識點整理內(nèi)容，有興趣的朋友們可以學(xué)習(xí)參考下。2021-01-01
SpringBoot如何對LocalDateTime進行格式化并解析
這篇文章主要介紹了SpringBoot如何對LocalDateTime進行格式化方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-07-07
這篇文章主要介紹了Java如何實現(xiàn)調(diào)用外部Api問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-05-05
這篇文章主要介紹了java8中Stream的使用以及分割list案例，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-08-08
SpringBoot項目啟動打包報錯類文件具有錯誤的版本 61.0, 應(yīng)為 52.0的解決
這篇文章主要給大家介紹了關(guān)于SpringBoot項目啟動打包報錯類文件具有錯誤的版本 61.0, 應(yīng)為 52.0的解決方法,文中有詳細的排查過程和解決方法,通過代碼介紹的非常詳細,需要的朋友可以參考下2023-11-11
這篇文章主要介紹了java 值Document解析xml詳細介紹的相關(guān)資料,需要的朋友可以參考下2017-05-05