当前位置: 开发笔记 > 运维 > 正文

SpringBoot如何实现定时任务的动态增删启停详解

作者：堵晴__晨1997_361 | 来源：互联网 | 2022-01-12 20:50

这篇文章主要给大家介绍了关于SpringBoot如何实现定时任务的动态增删启停的相关资料，文中通过示例代码以及图文介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧

我以为动态停启定时任务一般用quartz，没想到还可以通过ScheduledTaskRegistrar来拓展。但是分布式场景，建议还是用quartz吧！

在 spring boot 项目中，可以通过 @EnableScheduling 注解和 @Scheduled 注解实现定时任务，也可以通过 SchedulingConfigurer 接口来实现定时任务。但是这两种方式不能动态添加、删除、启动、停止任务。要实现动态增删启停定时任务功能，比较广泛的做法是集成 Quartz 框架。

但是本人的开发原则是：在满足项目需求的情况下，尽量少的依赖其它框架，避免项目过于臃肿和复杂。查看 spring-context 这个 jar 包中 org.springframework.scheduling.ScheduledTaskRegistrar 这个类的源代码，发现可以通过改造这个类就能实现动态增删启停定时任务功能。

定时任务列表页

定时任务执行日志

添加执行定时任务的线程池配置类

@Configuration
public class SchedulingConfig {
 @Bean
 public TaskScheduler taskScheduler() {
  ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
  
  taskScheduler.setPoolSize(4);
  taskScheduler.setRemoveOnCancelPolicy(true);
  taskScheduler.setThreadNamePrefix("TaskSchedulerThreadPool-");
  return taskScheduler;
 }
}

添加 ScheduledFuture 的包装类。ScheduledFuture 是 ScheduledExecutorService 定时任务线程池的执行结果。

public final class ScheduledTask {

 volatile ScheduledFuture<&＃63;> future;

 
 public void cancel() {
  ScheduledFuture<&＃63;> future = this.future;
  if (future != null) {
   future.cancel(true);
  }
 }
}

添加 Runnable 接口实现类，被定时任务线程池调用，用来执行指定 bean 里面的方法。

public class SchedulingRunnable implements Runnable {

 private static final Logger logger = LoggerFactory.getLogger(SchedulingRunnable.class);

 private String beanName;

 private String methodName;

 private String params;

 public SchedulingRunnable(String beanName, String methodName) {
  this(beanName, methodName, null);
 }

 public SchedulingRunnable(String beanName, String methodName, String params) {
  this.beanName = beanName;
  this.methodName = methodName;
  this.params = params;
 }

 @Override
 public void run() {
  logger.info("定时任务开始执行 - bean：{}，方法：{}，参数：{}", beanName, methodName, params);
  long startTime = System.currentTimeMillis();

  try {
   Object target = SpringContextUtils.getBean(beanName);

   Method method = null;
   if (StringUtils.isNotEmpty(params)) {
    method = target.getClass().getDeclaredMethod(methodName, String.class);
   } else {
    method = target.getClass().getDeclaredMethod(methodName);
   }

   ReflectionUtils.makeAccessible(method);
   if (StringUtils.isNotEmpty(params)) {
    method.invoke(target, params);
   } else {
    method.invoke(target);
   }
  } catch (Exception ex) {
   logger.error(String.format("定时任务执行异常 - bean：%s，方法：%s，参数：%s ", beanName, methodName, params), ex);
  }

  long times = System.currentTimeMillis() - startTime;
  logger.info("定时任务执行结束 - bean：{}，方法：{}，参数：{}，耗时：{} 毫秒", beanName, methodName, params, times);
 }

 @Override
 public boolean equals(Object o) {
  if (this == o) return true;
  if (o == null || getClass() != o.getClass()) return false;
  SchedulingRunnable that = (SchedulingRunnable) o;
  if (params == null) {
   return beanName.equals(that.beanName) &&
     methodName.equals(that.methodName) &&
     that.params == null;
  }

  return beanName.equals(that.beanName) &&
    methodName.equals(that.methodName) &&
    params.equals(that.params);
 }

 @Override
 public int hashCode() {
  if (params == null) {
   return Objects.hash(beanName, methodName);
  }

  return Objects.hash(beanName, methodName, params);
 }
}

添加定时任务注册类，用来增加、删除定时任务。

@Component
public class CronTaskRegistrar implements DisposableBean {

 private final Map scheduledTasks = new ConcurrentHashMap<>(16);

 @Autowired
 private TaskScheduler taskScheduler;

 public TaskScheduler getScheduler() {
  return this.taskScheduler;
 }

 public void addCronTask(Runnable task, String cronExpression) {
  addCronTask(new CronTask(task, cronExpression));
 }

 public void addCronTask(CronTask cronTask) {
  if (cronTask != null) {
   Runnable task = cronTask.getRunnable();
   if (this.scheduledTasks.containsKey(task)) {
    removeCronTask(task);
   }

   this.scheduledTasks.put(task, scheduleCronTask(cronTask));
  }
 }

 public void removeCronTask(Runnable task) {
  ScheduledTask scheduledTask = this.scheduledTasks.remove(task);
  if (scheduledTask != null)
   scheduledTask.cancel();
 }

 public ScheduledTask scheduleCronTask(CronTask cronTask) {
  ScheduledTask scheduledTask = new ScheduledTask();
  scheduledTask.future = this.taskScheduler.schedule(cronTask.getRunnable(), cronTask.getTrigger());

  return scheduledTask;
 }


 @Override
 public void destroy() {
  for (ScheduledTask task : this.scheduledTasks.values()) {
   task.cancel();
  }

  this.scheduledTasks.clear();
 }
}

添加定时任务示例类

@Component("demoTask")
public class DemoTask {
 public void taskWithParams(String params) {
  System.out.println("执行有参示例任务：" + params);
 }

 public void taskNoParams() {
  System.out.println("执行无参示例任务");
 }
}

定时任务数据库表设计

添加定时任务实体类

public class SysJobPO {
 
 private Integer jobId;
 
 private String beanName;
 
 private String methodName;
 
 private String methodParams;
 
 private String cronExpression;
 
 private Integer jobStatus;
 
 private String remark;
 
 private Date createTime;
 
 private Date updateTime;

 public Integer getJobId() {
  return jobId;
 }

 public void setJobId(Integer jobId) {
  this.jobId = jobId;
 }

 public String getBeanName() {
  return beanName;
 }

 public void setBeanName(String beanName) {
  this.beanName = beanName;
 }

 public String getMethodName() {
  return methodName;
 }

 public void setMethodName(String methodName) {
  this.methodName = methodName;
 }

 public String getMethodParams() {
  return methodParams;
 }

 public void setMethodParams(String methodParams) {
  this.methodParams = methodParams;
 }

 public String getCronExpression() {
  return cronExpression;
 }

 public void setCronExpression(String cronExpression) {
  this.crOnExpression= cronExpression;
 }

 public Integer getJobStatus() {
  return jobStatus;
 }

 public void setJobStatus(Integer jobStatus) {
  this.jobStatus = jobStatus;
 }

 public String getRemark() {
  return remark;
 }

 public void setRemark(String remark) {
  this.remark = remark;
 }

 public Date getCreateTime() {
  return createTime;
 }

 public void setCreateTime(Date createTime) {
  this.createTime = createTime;
 }

 public Date getUpdateTime() {
  return updateTime;
 }

 public void setUpdateTime(Date updateTime) {
  this.updateTime = updateTime;
 }
}

新增定时任务

boolean success = sysJobRepository.addSysJob(sysJob);
if (!success)
 return OperationResUtils.fail("新增失败");
else {
 if (sysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {
  SchedulingRunnable task = new SchedulingRunnable(sysJob.getBeanName(), sysJob.getMethodName(), sysJob.getMethodParams());
  cronTaskRegistrar.addCronTask(task, sysJob.getCronExpression());
 }
}

return OperationResUtils.success();

修改定时任务，先移除原来的任务，再启动新任务

boolean success = sysJobRepository.editSysJob(sysJob);
if (!success)
 return OperationResUtils.fail("编辑失败");
else {
 
 if (existedSysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {
  SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
  cronTaskRegistrar.removeCronTask(task);
 }

 if (sysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {
  SchedulingRunnable task = new SchedulingRunnable(sysJob.getBeanName(), sysJob.getMethodName(), sysJob.getMethodParams());
  cronTaskRegistrar.addCronTask(task, sysJob.getCronExpression());
 }
}

return OperationResUtils.success();

删除定时任务

boolean success = sysJobRepository.deleteSysJobById(req.getJobId());
if (!success)
 return OperationResUtils.fail("删除失败");
else{
 if (existedSysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {
  SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
  cronTaskRegistrar.removeCronTask(task);
 }
}

return OperationResUtils.success();

定时任务启动 / 停止状态切换

if (existedSysJob.getJobStatus().equals(SysJobStatus.NORMAL.ordinal())) {
 SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
 cronTaskRegistrar.addCronTask(task, existedSysJob.getCronExpression());
} else {
 SchedulingRunnable task = new SchedulingRunnable(existedSysJob.getBeanName(), existedSysJob.getMethodName(), existedSysJob.getMethodParams());
 cronTaskRegistrar.removeCronTask(task);
}

添加实现了 CommandLineRunner 接口的 SysJobRunner 类，当 spring boot 项目启动完成后，加载数据库里状态为正常的定时任务。

@Service
public class SysJobRunner implements CommandLineRunner {

 private static final Logger logger = LoggerFactory.getLogger(SysJobRunner.class);

 @Autowired
 private ISysJobRepository sysJobRepository;

 @Autowired
 private CronTaskRegistrar cronTaskRegistrar;

 @Override
 public void run(String... args) {
  
  List jobList = sysJobRepository.getSysJobListByStatus(SysJobStatus.NORMAL.ordinal());
  if (CollectionUtils.isNotEmpty(jobList)) {
   for (SysJobPO job : jobList) {
    SchedulingRunnable task = new SchedulingRunnable(job.getBeanName(), job.getMethodName(), job.getMethodParams());
    cronTaskRegistrar.addCronTask(task, job.getCronExpression());
   }

   logger.info("定时任务已加载完毕...");
  }
 }
}

工具类 SpringContextUtils，用来从 spring 容器里获取 bean

@Component
public class SpringContextUtils implements ApplicationContextAware {

 private static ApplicationContext applicationContext;

 @Override
 public void setApplicationContext(ApplicationContext applicationContext)
   throws BeansException {
  SpringContextUtils.applicatiOnContext= applicationContext;
 }

 public static Object getBean(String name) {
  return applicationContext.getBean(name);
 }

 public static  T getBean(Class requiredType) {
  return applicationContext.getBean(requiredType);
 }

 public static  T getBean(String name, Class requiredType) {
  return applicationContext.getBean(name, requiredType);
 }

 public static boolean containsBean(String name) {
  return applicationContext.containsBean(name);
 }

 public static boolean isSingleton(String name) {
  return applicationContext.isSingleton(name);
 }

 public static Class<&＃63; extends Object> getType(String name) {
  return applicationContext.getType(name);
 }
}

总结

到此这篇关于Spring Boot如何实现定时任务的动态增删启停的文章就介绍到这了,更多相关SpringBoot定时任务的动态增删启停内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！

推荐阅读

service
酷家乐 Serverless FaaS 产品实践探索

本文探讨了酷家乐在 Serverless FaaS 领域的实践与经验，重点介绍了 FaaS 平台的构建、业务收益及未来发展方向。 ... [详细]

蜡笔小新 2024-11-27 10:22:39
dns
J2EE平台的13项核心技术规范

J2EE平台集成了多种服务、API和协议，旨在支持基于Web的多层应用开发。本文将详细介绍J2EE平台中的13项关键技术规范，涵盖从数据库连接到事务处理等多个方面。 ... [详细]

蜡笔小新 2024-11-27 16:27:50
port
Apollo入门指南

Apollo是一个分布式配置中心，由服务端和客户端组成，支持配置的集中管理和动态更新。 ... [详细]

蜡笔小新 2024-11-28 19:02:31
port
深入解析Android UI布局：LinearLayout与AbsoluteLayout

本文探讨了Android开发中常用的两种布局方式——LinearLayout和AbsoluteLayout，通过实例分析它们的特点及应用场景。 ... [详细]

蜡笔小新 2024-11-28 17:39:36
k8s
匠心|传统_2021年度总结 | 葡萄城软件开发技术回顾（上）

匠心|传统_2021年度总结 | 葡萄城软件开发技术回顾（上） ... [详细]

蜡笔小新 2024-11-28 16:47:46
k8s
深入解析Spring Boot项目的启动机制

在Java后端开发中，Spring Boot框架以其简洁性和强大的功能受到了广泛欢迎。本文将探讨Spring Boot项目启动的核心——SpringApplication类及其run()方法的工作原理。 ... [详细]

蜡笔小新 2024-11-28 15:54:47
k8s
Java实现AC自动机进行高效多模式匹配

本文介绍如何使用Java实现AC自动机（Aho-Corasick算法），以实现高效的多模式字符串匹配。文章涵盖了Trie树和KMP算法的基础知识，并提供了一个详细的代码示例，包括构建Trie树、设置失败指针以及执行搜索的过程。 ... [详细]

蜡笔小新 2024-11-28 14:52:17
k8s
ECharts图表绘制函数集

本文档提供了使用ECharts库创建柱状图、饼图和双折线图的JavaScript函数。每个函数都详细列出了参数说明，并通过示例展示了如何调用这些函数以生成不同类型的图表。 ... [详细]

蜡笔小新 2024-11-27 20:24:40
k8s
python 类class学习总结（程序验证，超详细，包括多继承、循环、super（）.xxx等）

python 类class学习总结（程序验证，超详细，包括多继承、循环、super（）.xxx等） ... [详细]

蜡笔小新 2024-11-27 17:34:00
port
美国网络安全：MITRE Shield 积极防御知识库解析

本文深入解析了MITRE Shield积极防御知识库，探讨其在网络安全领域的应用及意义。 ... [详细]

蜡笔小新 2024-11-27 17:06:27
port
STL 容器中插入对象与指针时的构造及析构函数调用分析

本文探讨了在使用 STL 容器（如 map、vector 和 list）插入自定义类对象或指针时，构造函数和析构函数的调用情况，以及可能引发的问题。 ... [详细]

蜡笔小新 2024-11-27 16:26:14
port
使用 Docker 部署 MongoDB 并通过 IntelliJ IDEA 远程访问

本文详细介绍了如何使用 Docker 部署 MongoDB，并通过 IntelliJ IDEA 实现远程连接的方法。包括 MongoDB 的基本配置、用户管理以及如何在 IDE 中配置连接。 ... [详细]

蜡笔小新 2024-11-27 14:32:36
service
Spring Boot 初学者指南（第一部分）

本文介绍了Spring Boot框架的基础知识，包括其设计理念、主要优势以及如何简化传统的J2EE开发流程。 ... [详细]

蜡笔小新 2024-11-27 10:39:14
service
深入掌握 Python：Pandas 数据处理与分析

本课程为 Python 进阶系列的第四部分，专注于 Pandas 库的高级应用。课程将涵盖数据分析、数据可视化及数据预处理等多个方面，旨在帮助学员全面掌握 Pandas 在数据科学中的应用。 ... [详细]

蜡笔小新 2024-11-27 08:17:21
service
ODB 2.1.0 版本发布，增强型C++ ORM框架

ODB 2.1.0 版本现已推出，此更新引入了多项新功能，如通过访问器、修饰符、函数及表达式访问数据成员，支持虚拟数据成员，并允许在数据成员上直接定义数据库索引等。 ... [详细]

蜡笔小新 2024-11-27 01:34:26

堵晴__晨1997_361

这个家伙很懒，什么也没留下！

Tags | 热门标签

RankList | 热门文章