又被问了:Spring Boot 定时任务开启后,怎么符合条件自动停止?


分享一份《Spring Boot 学习笔记,太全了!》

背景

昨天,咱们的《知识星球:Java技术栈》里面有粉丝向我提问:

问题大概就是:

Spring Boot 定时任务开启后,怎么符合条件自动停止?

当时我有空,虽然已经给出了参考答案,但可能还有一些细节地方要注意的,另外,我也觉得这个问题特别有意思,现在特别拿出来整理下,分享下给大家。

1、自定义任务调度

首先覆盖 TaskSchedulingAutoConfiguration 自动配置类里面的 ThreadPoolTaskScheduler Bean:

/**
* 自定义任务调度
* 公众号:Java技术栈
*/
@Data
@Component
class CustomTaskScheduler extends ThreadPoolTaskScheduler {

private Map<Object, ScheduledFuture<?>> scheduledTasks = new IdentityHashMap<>();

@Override
public ScheduledFuture<?> schedule(Runnable task, Trigger trigger) {
ScheduledFuture<?> future = super.schedule(task, trigger);
this.putScheduledTasks(task, future);
return future;
}

@Override
public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, long period) {
ScheduledFuture<?> future = super.scheduleAtFixedRate(task, period);
this.putScheduledTasks(task, future);
return future;
}

@Override
public ScheduledFuture<?> scheduleAtFixedRate(Runnable task, Date startTime, long period) {
ScheduledFuture<?> future = super.scheduleAtFixedRate(task, startTime, period);
this.putScheduledTasks(task, future);
return future;
}

private void putScheduledTasks(Runnable task, ScheduledFuture<?> future) {
ScheduledMethodRunnable runnable = (ScheduledMethodRunnable) task;
scheduledTasks.put(runnable.getTarget(), future);
}

// 重写所有 schedule* 方法...

}

Spring Boot 基础就不介绍了,推荐下这个实战教程:

https://github.com/javastacks/spring-boot-best-practice

重写所有 schedule* 方法…

因为要停止一个任务,就必须调用 ScheduledFuture -> Future 接口中的 cancel 方法。

所以,思路就是在任务执行的时候,把任务所在的实例 Bean 和任务启动后的 ScheduledFuture 维护到一个 Map 里面,然后需要停止的时候,从 Map 里面取出来,再进行 cancel 停止即可。

2、按条件自动停止任务

新建一个每 3 秒执行一次的任务:

/**
* 按条件自动停止任务
* 公众号:Java技术栈
*/
@Slf4j
@Component
public class AutoStopTask {

@Autowired
private CustomTaskScheduler customTaskScheduler;

private int count;

@Scheduled(cron = "*/3 * * * * *")
public void printTask() {
log.info("公众号Java技术栈,任务执行次数:{}", count + 1);

count++;

// 执行3次后自动停止
if (count >= 3) {
log.info("任务已执行指定次数,现在自动停止");
boolean cancelled = customTaskScheduler.getScheduledTasks().get(this).cancel(true);

// 停止后再次启动
if (cancelled) {
count = 0;
ScheduledMethodRunnable runnable = new ScheduledMethodRunnable(this, ReflectionUtils.findMethod(this.getClass(), "printTask"));
customTaskScheduler.schedule(runnable, new CronTrigger("*/3 * * * * *"));
}
}
}

}

这里是统计执行,当执行次数超过 3 次时就自动停止。如果需要再次启动,上面也提供了参数代码。

需要注意的是,自定义调度里面绑定的是实例 Bean 和 Future 的关系,所以仅限 Bean 中的单个任务,如果一个 Bean 维护了多个任务,最后一个任务的启动就会覆盖之前的。

如果要维护 Bean 中的多个任务,自动停止该怎么做呢?

答案就是把任务的方法名和 Future 关联起来:

/scheduledMethodTasks.put(runnable.getMethod(), future);

取的的根据当前的方法名取就行了,这里是方法名,也可是类名+方法名+参数,防止重复。

关于这个问题,你还有哪些实现方案呢?欢迎留言分享!

总结

本文完整示例代码已经上传到 Github:

https://github.com/javastacks/spring-boot-best-practice

如果你感兴趣的话,可以 Star 学习,后续会持续更新。

最后打一波咱们星球的广告:

  • 如果你也有许多疑难问题、疑惑无从解答,可以加入我们的《知识星球:Java技术栈》,只要栈长我知道的我都会解答,还有 2500+ 球友也在;
  • 如果你学习没有方向、工作没有提升,《知识星球:Java技术栈》里面也沉淀了大量技术知识、学习资料、面试题、简历模板等,加入就值回门票;

星球原价是 199 的,现在是活动优惠价 159 元,正是加入的好时候,过段时间肯定会恢复原价的。

公众号、微信上面好友太多,不可能一一回答每个人的问题,时间精力不允许啊(回答是情分,不回答是义务),所以我就创建了《知识星球:Java技术栈》,知识付费,现在就变成了一种责任了,栈长是实打实的纯技术人,不玩套路,也从不玩虚的,咱们的星球绝对物超所值,欢迎加入一起学习吧。

最后,如果你想关注和学习最新、最主流的 Java 技术,可以持续关注公众号Java技术栈,公众号第一时间推送。

版权声明: 本文系公众号 “Java技术栈” 原创,转载、引用本文内容请注明出处,抄袭、洗稿一律投诉侵权,后果自负,并保留追究其法律责任的权利。


分享一份《Spring Boot 学习笔记,太全了!》