Springboot实现动态定时任务流程详解
作者：CzRger 发布时间：2022-09-28 02:26:55
标签：Springboot,动态,定时任务
一、静态
静态的定时任务可以直接使用注解@Scheduled，并在启动类上配置@EnableScheduling即可
@PostMapping("/list/test1")
@Async
@Scheduled(cron = "0 * * * * ?")
public void test1() throws Exception {
Object obj = this.getClass().newInstance();
log.info("执行静态定时任务时间/test1：param:{}", new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()));
}
二、动态
动态的定时任务需要根据ScheduledTaskRegistrar的addTriggerTask方法进行实现，网上大多数资料是在Trigger中动态查询cron表达式来实现，但存在一个问题就是只有在下一次执行的时候才会刷新，比如一开始设置的每天12点执行一次，如果项目启动后，修改为每小时执行一次的话，需要等到下一次12点执行之后，才会刷新cron表达式，所以通过对ScheduledTaskRegistrar的源码分析，构建了以下解决方案，可以实现对定时任务的额单次额外执行、停止、启动三个基本功能。在此只列出关键代码，关于项目启动、数据库连接的代码等就不过多说明了。
1、基本代码
首先新建定时任务信息的库表及实体类
@Data
@EqualsAndHashCode(callSuper = false)
@TableName("cron")
public class Cron implements Serializable {
private static final long serialVersionUID = 1L;
@TableId(value = "id", type = IdType.ASSIGN_UUID)
private String id;
private String cronFlag;
private String cronExpression;
private String className;
private String methodName;
}
用于获取bean实例的工具类
@Component
public class BeansUtils implements ApplicationContextAware {
private static ApplicationContext context;
public static <T> T getBean(Class<T> bean) {
return context.getBean(bean);
}
public static <T> T getBean(String var1, @Nullable Class<T> var2){
return context.getBean(var1, var2);
}
public static ApplicationContext getContext() {
return context;
}
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
context = applicationContext;
}
}
实现定时任务类
@Configuration
@EnableScheduling
@EnableAsync
@Slf4j
public class RCScheduleTask implements SchedulingConfigurer {
@Autowired
private ICronService iCronService;
private static ScheduledTaskRegistrar scheduledTaskRegistrar;
public static Map<String, TriggerTask> triggerTaskMap;
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
scheduledTaskRegistrar = taskRegistrar;
Cron cron = new Cron();
cron.setCronFlag("1");
List<Cron> list = iCronService.getList(cron);
if (list != null) {
initTriggerTask(list);
}
}
public void initTriggerTask(List<Cron> list) {
triggerTaskMap = new HashMap<>();
for (Cron cron : list) {
TriggerTask triggerTask = new TriggerTask(getRunnable(cron), getTrigger(cron));
scheduledTaskRegistrar.addTriggerTask(triggerTask);
triggerTaskMap.put(cron.getId(), triggerTask);
}
}
private static Runnable getRunnable(Cron cron) {
return new Runnable() {
@Override
public void run() {
Class<?> clazz;
try {
clazz = Class.forName(cron.getClassName());
Object bean = BeansUtils.getBean(clazz);
Method method = ReflectionUtils.findMethod(bean.getClass(), cron.getMethodName());
ReflectionUtils.invokeMethod(method, bean);
} catch (Exception e) {
e.printStackTrace();
}
}
};
}
private static Trigger getTrigger(Cron cron) {
return new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
CronTrigger trigger = new CronTrigger(cron.getCronExpression());
Date nextExec = trigger.nextExecutionTime(triggerContext);
return nextExec;
}
};
}
public static boolean run(String id) {
TriggerTask tt = triggerTaskMap.get(id);
if (tt != null) {
tt.getRunnable().run();
return true;
}
return false;
}
public static boolean stop(String id) {
TriggerTask tt = triggerTaskMap.get(id);
if (tt != null) {
Set<ScheduledTask> scheduledTasks = scheduledTaskRegistrar.getScheduledTasks();
for (ScheduledTask st:scheduledTasks) {
boolean b = st.getTask().getRunnable() == tt.getRunnable();
if (b) {
st.cancel();
return true;
}
}
}
return false;
}
public static boolean start(Cron cron) throws Exception {
try {
triggerTaskMap.remove(cron.getId());
TriggerTask tt = new TriggerTask(getRunnable(cron), getTrigger(cron));
triggerTaskMap.put(cron.getId(), tt);
scheduledTaskRegistrar.scheduleTriggerTask(tt);
return true;
} catch (Exception e) {
e.printStackTrace();
}
return false;
}
}
控制调用类，RCResult为自定义封装的返回结果类，可自行定义
@RestController
@RequestMapping("/cron")
@Slf4j
public class CronController {
@Autowired
private ICronService iCronService;
@Autowired
private RCScheduleTask rcScheduleTask;
@GetMapping("/task/1")
@Async
public void task1() {
log.info("模拟任务1-执行时间:{}", new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()));
}
@GetMapping("/task/2")
@Async
public void task2() {
log.info("模拟任务2-执行时间:{}", new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()));
}
@GetMapping("/task/3")
@Async
public void task3() {
log.info("模拟任务3-执行时间:{}", new SimpleDateFormat("yyyy-MM-dd hh:mm:ss").format(new Date()));
}
@GetMapping("/run/{id}")
public RCResult run(@PathVariable("id") String id) {
Boolean b = RCScheduleTask.run(id);
if (b) {
return RCResult.ok("执行任务" + id + "成功");
}
return RCResult.error("执行任务" + id + "失败");
}
@GetMapping("/stop/{id}")
public RCResult stop(@PathVariable("id") String id) {
Boolean b = RCScheduleTask.stop(id);
if (b) {
return RCResult.ok("停止任务" + id + "成功");
}
return RCResult.error("停止任务" + id + "失败");
}
@GetMapping("/start/{id}")
public RCResult start(@PathVariable("id") String id) throws Exception {
Cron cron = iCronService.getById(id);
if (cron != null) {
Boolean b = RCScheduleTask.start(cron);
if (b) {
return RCResult.ok("开始任务" + id + "成功");
}
}
return RCResult.error("开始任务" + id + "失败");
}
}
2、方案详解
2.1 初始化
通过@EnableScheduling和@EnableAsync两个标签，开启定时任务和多线程
@Configuration
@EnableScheduling
@EnableAsync
@Slf4j
public class RCScheduleTask implements SchedulingConfigurer {
重写SchedulingConfigurer的configureTasks方法，可以在项目启动时自动加载状态为启用（cron_flag为1）定时任务列表
@Override
public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
scheduledTaskRegistrar = taskRegistrar;
Cron cron = new Cron();
cron.setCronFlag("1");
List<Cron> list = iCronService.getList(cron);
if (list != null) {
initTriggerTask(list);
}
}
TriggerTask创建的两个参数Runnable和Trigger可以理解为实现的操作和执行的周期，在Runnable中我们通过反射的方式，从库中取到调用方法的类名和方法名，来执行接口操作，在Trigger中我们根据库中的cron表达式来设置执行周期
public void initTriggerTask(List<Cron> list) {
triggerTaskMap = new HashMap<>();
for (Cron cron : list) {
TriggerTask triggerTask = new TriggerTask(getRunnable(cron), getTrigger(cron));
scheduledTaskRegistrar.addTriggerTask(triggerTask);
triggerTaskMap.put(cron.getId(), triggerTask);
}
}
private static Runnable getRunnable(Cron cron) {
return new Runnable() {
@Override
public void run() {
Class<?> clazz;
try {
clazz = Class.forName(cron.getClassName());
Object bean = BeansUtils.getBean(clazz);
Method method = ReflectionUtils.findMethod(bean.getClass(), cron.getMethodName());
ReflectionUtils.invokeMethod(method, bean);
} catch (Exception e) {
e.printStackTrace();
}
}
};
}
private static Trigger getTrigger(Cron cron) {
return new Trigger() {
@Override
public Date nextExecutionTime(TriggerContext triggerContext) {
CronTrigger trigger = new CronTrigger(cron.getCronExpression());
Date nextExec = trigger.nextExecutionTime(triggerContext);
return nextExec;
}
};
}
库表数据
从执行结果中可以看到状态为已启用的task1和task2执行了，而task3并没有执行
2.2 单次执行
我们可以通过获取TriggerTask的Runnable来执行run()方法，来单次执行定时任务
任务类中定义run方法
public static boolean run(String id) {
TriggerTask tt = triggerTaskMap.get(id);
if (tt != null) {
tt.getRunnable().run();
return true;
}
return false;
}
接口调用
@GetMapping("/run/{id}")
public RCResult run(@PathVariable("id") String id) {
Boolean b = RCScheduleTask.run(id);
if (b) {
return RCResult.ok("执行任务" + id + "成功");
}
return RCResult.error("执行任务" + id + "失败");
}
模拟接口调用
从调用结果中可以看到，task1在06秒的时候单独执行了一次，并且没有影响后续执行
2.3 停止任务
停止任务需要执行ScheduledTask类的cancel()方法，由于在初始化时通过addTriggerTask方法并不会立刻加入到ScheduledTask列表中，所以需要在调用时通过ScheduledTaskRegistrar获取ScheduledTask列表，然后与TriggerTask的Runnable进行比较判断是否一致
任务类中定义stop
public static boolean stop(String id) {
TriggerTask tt = triggerTaskMap.get(id);
if (tt != null) {
Set<ScheduledTask> scheduledTasks = scheduledTaskRegistrar.getScheduledTasks();
for (ScheduledTask st:scheduledTasks) {
boolean b = st.getTask().getRunnable() == tt.getRunnable();
if (b) {
st.cancel();
return true;
}
}
}
return false;
}
调用
@GetMapping("/stop/{id}")
public RCResult stop(@PathVariable("id") String id) {
Boolean b = RCScheduleTask.stop(id);
if (b) {
return RCResult.ok("停止任务" + id + "成功");
}
return RCResult.error("停止任务" + id + "失败");
}
在调用结果中可以看到，task1不再执行了
2.4 启用任务
启用任务需要通过ScheduledTaskRegistrar的scheduleTriggerTask()方法进行调用，由于源码中并未提供针对Runnable或Trigger的单独修改方法，所以在这里我们通过新建实例进行替换，在执行前先停止任务
public static boolean start(Cron cron) throws Exception {
try {
stop(cron.getId());
triggerTaskMap.remove(cron.getId());
TriggerTask tt = new TriggerTask(getRunnable(cron), getTrigger(cron));
triggerTaskMap.put(cron.getId(), tt);
scheduledTaskRegistrar.scheduleTriggerTask(tt);
return true;
} catch (Exception e) {
e.printStackTrace();
}
return false;
}
调用
@GetMapping("/start/{id}")
public RCResult start(@PathVariable("id") String id) throws Exception {
Cron cron = iCronService.getById(id);
if (cron != null) {
Boolean b = RCScheduleTask.start(cron);
if (b) {
return RCResult.ok("开始任务" + id + "成功");
}
}
return RCResult.error("开始任务" + id + "失败");
}
通过调用结果，可以看到在启用后，task1重新加入到定时任务队列中了
在修改task1的执行周期后再次调用start方法
从调用结果中可以看到，task1的周期已被更改
三、小结
昨天刚接触定时任务，一开始也是在网上搜索资料，后来发现案例都无法满足自身需求，或者只是讲解怎么使用，根本无法映射到实际业务上，所以通过对源码的分析，一层层的梳理，模拟了此篇关于定时任务的解决方案，由于时间原因，在此省略了前端界面的编写，但大多数实际需求无非也就是通过一个开关或按钮来对任务进行启用、停止操作，或者额外需要单次执行任务，在此对动态定时任务的方案进行记录，同时也希望能帮助到遇到同样问题的同学们
来源：https://blog.csdn.net/CzRger/article/details/126782706
0
投稿猜你喜欢
与链表、堆栈和队列不一样，二叉查找树不是线性数据结构，是二维数据结构。每个节点都包含一个LeftNode和RightNode，二叉查找树把比- 前言如今发短信功能已经成为互联网公司的标配，本篇文章将一步步实现java发送短信考察了许多提供短信服务的三方，几乎所有都需要企业认证才可以使
- 前言作为一个写java的使用最多的轻量级框架莫过于spring，不管是老项目用到的springmvc，还是现在流行的springboot，都
- 一、文件上传概述实现Web开发中的文件上传功能，需要两步操作：1、在Web页面中添加上传输入项 <form
- 学习时，接触使用到IDEA这个开发工具。在用IDEA开发的时候，需要创建工程。以下介绍各类型项目的新建。一、 springboot工程简介：
- 现在很多app的首页都有一个倒计时控件，比如说3秒或者5秒自动跳转界面，或者点击控件直接跳过首先，自定义控件CircleProgressba
- Shiro 是Shiro 是一个 Apache 下的一开源项目项目，旨在简化身份验证和授权。 1：shiro的配置，通过maven
- 1.说明如果你也在用Mybatis，建议尝试该分页插件，这个一定是最方便使用的分页插件。该插件目前支持Oracle,Mysql,MariaD
- 我们知道，spring boot自动配置功能可以根据不同情况来决定spring配置应该用哪个，不应该用哪个，举个例子：Spring的Jdbc
- 责任链模式责任链模式的定义：使多个对象都有机会处理请求，从而避免请求的发送者和接受者之间的耦合关系， 将这个对象连成一条链，并沿着这条链传递
- 本文实例为大家分享了Android自定义带圆点的半圆形进度条，供大家参考，具体内容如下仅限用于半圆形,如须要带圆点的圆形进度条,圆点会出现错
- Maven修改打包文件名称对Maven打出的jar包名称不满意：想通过修改配置给jar包改名，查询找到了方法：pom.xml的<bui
- 进入到Android-sdk中platform-tools目录在命令行中执行以下命令adb shell dumpsys activity&g
- 本文实例为大家介绍了Java九大内置对象，供大家参考，具体内容如下1、Request对象该对象封装了用户提交的信息，通过调用该对象相应的方法
- 废话不多说了，直接给大家贴代码了，具体代码如下所示：html代码如下：<body><input id="file
- 什么是代理代理就是给目标对象一个代理对象，并由代理对象控制目标的引用。为什么要使用代理模式1、通过引入代理对象的方式，可以间接的访问目标对象
- 前言《模式策略的角色扮演游戏》游戏是自制的角色扮演游戏。选择两个角色，然后进行PK，可用来学习JAVA的接口，继承和多态。主要设计1.事先设
- 自定义Starter命名规则注意artifactId的命名规则，Spring官方Starter通常命名为spring-boot-starte
- 下面是配置Android开发ADB环境变量的操作步骤。工具/原料win7系统电脑+Android SDK方法/步骤1.首先右击计算机——属性
- springboot集成swagger3swagger3的springboot启动器jar包<!-- https://mvnrepos
