添加 动态定时任务 工具类

This commit is contained in:
jcsun 2022-03-13 18:30:34 +08:00
parent 55c9b0c37a
commit c73ea53f8f
2 changed files with 159 additions and 1 deletions

View File

@ -0,0 +1,157 @@
package cn.hutool.extra.spring;
import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.map.MapUtil;
import cn.hutool.core.util.IdUtil;
import org.springframework.scheduling.TaskScheduler;
import org.springframework.scheduling.support.CronTrigger;
import org.springframework.stereotype.Component;
import javax.annotation.Resource;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ScheduledFuture;
/**
* Spring 动态定时任务封装
* <ol>
* <li>创建定时任务</li>
* <li>修改定时任务</li>
* <li>取消定时任务</li>
* <li>高级操作</li>
* </ol>
*
* @author JC
* @date 03/13
*/
@Component
public class SpringCronUtil {
/**
* 任务调度器
*/
private static TaskScheduler taskScheduler;
/**
* ID Future 绑定
*/
private static final Map<Serializable, ScheduledFuture<?>> TASK_FUTURE = MapUtil.newConcurrentHashMap();
/**
* ID Runnable 绑定
*/
private static final Map<Serializable, Runnable> TASK_RUNNABLE = MapUtil.newConcurrentHashMap();
/**
* 加入定时任务
*
* @param task 任务
* @param expression 定时任务执行时间的cron表达式
* @return 定时任务ID
*/
public static String schedule(Runnable task, String expression) {
String id = IdUtil.fastUUID();
return schedule(id, task, expression);
}
/**
* 加入定时任务
*
* @param id 定时任务ID
* @param expression 定时任务执行时间的cron表达式
* @param task 任务
* @return 定时任务ID
*/
public static String schedule(Serializable id, Runnable task, String expression) {
ScheduledFuture<?> schedule = taskScheduler.schedule(task, new CronTrigger(expression));
TASK_FUTURE.put(id, schedule);
TASK_RUNNABLE.put(id, task);
return id.toString();
}
/**
* 修改定时任务
*
* @param id 定时任务ID
* @param expression 定时任务执行时间的cron表达式
* @return 是否修改成功{@code false}表示未找到对应ID的任务
*/
public static boolean update(Serializable id, String expression) {
if (!TASK_FUTURE.containsKey(id)) {
return false;
}
ScheduledFuture<?> future = TASK_FUTURE.get(id);
if (future == null) {
return false;
}
future.cancel(true);
schedule(id, TASK_RUNNABLE.get(id), expression);
return true;
}
/**
* 移除任务
*
* @param schedulerId 任务ID
* @return 是否移除成功{@code false}表示未找到对应ID的任务
*/
public static boolean cancel(Serializable schedulerId) {
ScheduledFuture<?> future = getScheduledFuture(schedulerId);
if (future == null) {
return false;
}
boolean cancel = future.cancel(false);
if (cancel) {
TASK_FUTURE.remove(schedulerId);
TASK_RUNNABLE.remove(schedulerId);
}
return cancel;
}
@Resource
public void setTaskScheduler(TaskScheduler taskScheduler) {
SpringCronUtil.taskScheduler = taskScheduler;
}
/**
* @return 获得Scheduler对象
*/
public static TaskScheduler getScheduler() {
return taskScheduler;
}
/**
* 可在项目中 进行细粒度控制
*
* @return 获得ScheduledFuture对象
*/
private static ScheduledFuture<?> getScheduledFuture(Serializable id) {
return TASK_FUTURE.get(id);
}
/**
* 获得当前运行的所有任务
*
* @return 所有任务
*/
public static List<Serializable> getAllTask() {
if (CollUtil.isNotEmpty(TASK_FUTURE.keySet())) {
return new ArrayList<>(TASK_FUTURE.keySet());
}
return new ArrayList<>();
}
/**
* 取消所有的任务
*/
public static void destroy() {
for (ScheduledFuture<?> future : TASK_FUTURE.values()) {
if (future != null) {
future.cancel(true);
}
}
TASK_FUTURE.clear();
TASK_RUNNABLE.clear();
}
}

View File

@ -1,4 +1,5 @@
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
cn.hutool.extra.spring.SpringUtil,\
cn.hutool.extra.spring.config.SpringCronConfig
cn.hutool.extra.spring.config.SpringCronConfig,\
cn.hutool.extra.spring.SpringCronUtil