经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » Java相关 » Spring » 查看文章
SpringBoot项目动态定时任务之 ScheduledTaskRegistrar(解决方案一)
来源:cnblogs  作者:Apluemxa  时间:2023/2/1 9:37:10  对本文有异议

前言

? 在做SpringBoot项目的过程中,有时客户会提出按照指定时间执行一次业务的需求。

? 如果客户需要改动业务的执行时间,即动态地调整定时任务的执行时间,那么可以采用SpringBoot自带的ScheduledTaskRegistrar类作为解决方案来实现。

? 在单一使用ScheduledTaskRegistrar类解决定时任务问题的时候,可能会达不到预期的动态调整定时任务的效果。

? 如果灵活配合使用对应的工具类(ThreadPoolTaskScheduler类),则可以方便地对动态调整定时任务进行管理。

? 本文会从问题出发,详细介绍ScheduledTaskRegistrar类是如何解决动态调整定时任务的思路,并给出关键的代码示例,帮助大家快速地上手学习。

目录

一、问题背景

  • 在指定的某一时刻执行业务;

  • 可以手动地更改执行时间。

    ? 在实际项目中,很少会有傻瓜式地去指定某一时间就触发某个业务的场景,执行业务的时间不是一成不变的,而是动态地随着客户所指定的时间进行调整的。

二、痛点所在

如果单一地使用SpringBoot自带的ScheduledTaskRegistrar去实现,那么可能会有以下问题:

  1. 只能按照指定的时间去执行,更改执行时间需要重启服务;
  2. 无法删除该定时任务,或者删除后无法再启动新的定时任务。
  3. 业务逻辑与触发器的代码耦合度太高,无法将业务代码从ScheduledTaskRegistrar类中抽离出去。
  1. /**
  2. * @author Created by zhuzqc on 2023/1/30 15:28
  3. */
  4. @Slf4j
  5. @Component
  6. @EnableScheduling
  7. public class ScheduleTaskDemo implements SchedulingConfigurer {
  8. private Logger logger = LoggerFactory.getLogger(this.getClass());
  9. @Override
  10. public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
  11. //Runnable线程注册任务
  12. Runnable taskOne = () -> {
  13. //需要执行的业务逻辑,一般会在这里封装好
  14. logger.info("----------业务执行结束----------");
  15. };
  16. //任务的触发时间,一般使用 cron 表达式
  17. Trigger triggerOne = triggerContext -> {
  18. Date nextExecTime = null;
  19. try {
  20. // 此处指定 cron 表达式
  21. String cron = "0 00 12 ? * *";
  22. if (StringUtils.isBlank(cron)) {
  23. // 提示参数为空
  24. logger.info("trigger定时器的 cron 参数为空!");
  25. // 如果为空则赋默认值,每天中午12点
  26. cron = "0 00 12 ? * *";
  27. }
  28. logger.info("---------->定时任务执行中<---------");
  29. CronTrigger cronTrigger = new CronTrigger(cron);
  30. nextExecTime = cronTrigger.nextExecutionTime(triggerContext);
  31. } catch (Exception e) {
  32. e.printStackTrace();
  33. log.info(e.getMessage());
  34. }
  35. return nextExecTime;
  36. };
  37. taskRegistrar.addTriggerTask(taskOne, triggerOne);
  38. }
  39. }

? 上述代码只能实现在指定的时间去触发定时任务,无法对 cron 表达式进行更改,如果更改则需要重新启动服务,非常地“傻瓜”。

? 而在实际的编码过程中,业务逻辑代码需要单独地剥离开(解耦),如何做到业务逻辑代码和触发器代码都能访问到外部业务数据,是设计过程中需要考虑到的关键。

三、解决思路

  1. //TODO:如果要在此处将业务逻辑和时间触发器进行捆绑,那么在这个实现类中无法获取到来自该类外部的业务数据;
  2. //TODO:要解决这样的问题,就要找到一个办法:既能将两者抽离,又能实现灵活触发定时任务。

? 在这里介绍一个名为ThreadPoolTaskScheduler类,通过源码得知,该类实现了SchedulingTaskExecutor和TaskScheduler接口。

? 该类中schedule(Runnable task, Trigger trigger)方法,通过分别传入线程任务(业务逻辑)Trigger触发器对象作为参数,支持动态创建指定 cron 表达式的定时任务

? 该方法源码如下:

  1. @Override
  2. @Nullable
  3. public ScheduledFuture<?> schedule(Runnable task, Trigger trigger) {
  4. ScheduledExecutorService executor = getScheduledExecutor();
  5. try {
  6. ErrorHandler errorHandler = this.errorHandler;
  7. if (errorHandler == null) {
  8. errorHandler = TaskUtils.getDefaultErrorHandler(true);
  9. }
  10. return new ReschedulingRunnable(task, trigger, this.clock, executor, errorHandler).schedule();
  11. }
  12. catch (RejectedExecutionException ex) {
  13. throw new TaskRejectedException("Executor [" + executor + "] did not accept task: " + task, ex);
  14. }
  15. }

以下部分是对该方法的具体使用,核心思路如下 :

  1. 实例化ThreadPoolTaskScheduler类对象;
  2. 实例化ScheduledFuture类对象,用于初始化调用schedule()后的值。
  3. 将携带有Runnable和Trigger的ScheduledFuture类对象作为Map的value进行装配。
  4. 根据Map的key对定时任务进行管理,达到添加和删除的目的。

四、代码示例

代码示例分为两部分:

第一部分是关于ThreadPoolTaskScheduler类和schedule()方法的使用;

  1. /**
  2. * @author @author Created by zhuzqc on 2023/1/30 15:39
  3. * 任务线程池管理工具
  4. */
  5. public class TaskSchedulerUtil {
  6. private static final Logger logger = LoggerFactory.getLogger(TaskSchedulerUtil.class);
  7. /**
  8. * 线程调度工具对象,作为该类的成员变量
  9. */
  10. private static ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();
  11. /**
  12. *初始化 map 对象,装配 schedule 方法的返回对象为 value 值
  13. */
  14. private static Map<String, ScheduledFuture<?>> scheduledFutureMap = new HashMap<String, ScheduledFuture<?>>();
  15. static {
  16. threadPoolTaskScheduler.initialize();
  17. }
  18. /**
  19. * 将Runnable对象和Trigger对象作为参数传入该静态方法
  20. * @param runnable
  21. * @param trigger
  22. * @param 定时任务id
  23. */
  24. public static void put(Runnable runnable, Trigger trigger, String id) {
  25. // 将携带有Runnable和Trigger的ScheduledFuture类对象作为 Map 的 value 进行装配
  26. ScheduledFuture<?> scheduledFuture = threadPoolTaskScheduler.schedule(runnable, trigger);
  27. // 放入 Map 中作为 value
  28. scheduledFutureMap.put(id, scheduledFuture);
  29. logger.info("---添加定时任务--->" + id);
  30. }
  31. /**
  32. * 通过上述 put 方法的参数id(定时任务id)标识,将定时任务移除出 map
  33. * @param id
  34. */
  35. public static void delete(String id) {
  36. ScheduledFuture<?> scheduledFuture = scheduledFutureMap.get(id);
  37. // 条件判断
  38. if (scheduledFuture != null && scheduledFuture.isCancelled()) {
  39. scheduledFuture.cancel(true);
  40. }
  41. scheduledFutureMap.remove(id);
  42. logger.info("---取消定时任务--->" + id);
  43. }
  44. }

第二部分是关于结合实际业务,引入实际业务数据的代码demo。

  1. /**
  2. * @author Created by zhuzqc on 2023/1/30 15:58
  3. */
  4. @Slf4j
  5. @Component
  6. @EnableScheduling
  7. public class TaskScheduleDemo{
  8. @Resource
  9. private AAAMapper aaaMapper;
  10. @Resource
  11. private BBBService bbbService;
  12. private Logger logger = LoggerFactory.getLogger(this.getClass());
  13. // 引入外部的业务数据对象
  14. public void putHiredTask(CCCEntity cccEntity){
  15. //TODO: 将业务线程和定时触发器交由线程池工具管理:创建业务线程对象,并对属性赋初始化值(有参构造)
  16. TaskSchedulerUtil.put(new TaskThreadDemo(cccEntity,aaaMapper,bbbService), new Trigger() {
  17. @Override
  18. public Date nextExecutionTime(TriggerContext triggerContext) {
  19. //获取定时触发器,这里可以获取页面的更新记录,实现定时间隔的动态调整
  20. Date nextExecTime = TaskTransUtils.StringToDateTime(cccEntity.getSendTime());
  21. //cron 表达式转换工具类
  22. String cron = TaskTransUtils.getDateCronTime(nextExecTime);
  23. try {
  24. if (StringUtils.isBlank(cron)) {
  25. // 提示参数为空
  26. logger.info("trackScheduler定时器的 cron 参数为空!");
  27. // 如果为空则赋默认值,每天早上9:00
  28. cron = "0 00 09 ? * *";
  29. }
  30. logger.info("-------定时任务执行中:" + cron + "--------");
  31. CronTrigger cronTrigger = new CronTrigger(cron);
  32. nextExecTime = cronTrigger.nextExecutionTime(triggerContext);
  33. } catch (Exception e) {
  34. e.printStackTrace();
  35. log.info(e.getMessage());
  36. }
  37. return nextExecTime;
  38. }
  39. },"该定时任务的id");
  40. }
  41. }

五、文章小结

动态定时任务的总结如下:

  1. 单一使用ScheduledTaskRegistrar类,无法达到预期动态调整定时任务的效果;
  2. 实际的开发场景中,需要业务逻辑代码和触发器代码都能访问到外部业务数据;
  3. 配合ThreadPoolTaskScheduler类和该类中的schedule()方法可以达到动态调整定时任务的效果。

如果大家有遇到这样类似的问题,并且为此感到困惑时,希望以上文章的介绍可以帮助到大家。

最后,欢迎大家的指正和交流!

原文链接:https://www.cnblogs.com/Apluemxa/p/17079955.html

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号