1. 程式人生 > 其它 >又被問了: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技術棧" 原創,轉載、引用本文內容請註明出處,抄襲、洗稿一律投訴侵權,後果自負,並保留追究其法律責任的權利。

近期熱文推薦:

1.1,000+ 道 Java面試題及答案整理(2022最新版)

2.勁爆!Java 協程要來了。。。

3.Spring Boot 2.x 教程,太全了!

4.別再寫滿屏的爆爆爆炸類了,試試裝飾器模式,這才是優雅的方式!!

5.《Java開發手冊(嵩山版)》最新發布,速速下載!

覺得不錯,別忘了隨手點贊+轉發哦!