SpringBoot項目動態定時任務之 ScheduledTaskRegistrar(解決方案一)

来源:https://www.cnblogs.com/Apluemxa/archive/2023/01/31/17079955.html
-Advertisement-
Play Games

在做SpringBoot項目的過程中,有時客戶會提出按照指定時間執行一次業務的需求。 在單一使用ScheduledTaskRegistrar類解決定時任務問題的時候,可能會達不到預期的動態調整定時任務的效果。 ...


前言

​ 在做SpringBoot項目的過程中,有時客戶會提出按照指定時間執行一次業務的需求。

​ 如果客戶需要改動業務的執行時間,即動態地調整定時任務的執行時間,那麼可以採用SpringBoot自帶的ScheduledTaskRegistrar類作為解決方案來實現。

​ 在單一使用ScheduledTaskRegistrar類解決定時任務問題的時候,可能會達不到預期的動態調整定時任務的效果。

​ 如果靈活配合使用對應的工具類(ThreadPoolTaskScheduler類),則可以方便地對動態調整定時任務進行管理。

​ 本文會從問題出發,詳細介紹ScheduledTaskRegistrar類是如何解決動態調整定時任務的思路,並給出關鍵的代碼示例,幫助大家快速地上手學習。

目錄

目錄

一、問題背景

  • 在指定的某一時刻執行業務;

  • 可以手動地更改執行時間。

    ​ 在實際項目中,很少會有傻瓜式地去指定某一時間就觸發某個業務的場景,執行業務的時間不是一成不變的,而是動態地隨著客戶所指定的時間進行調整的。

二、痛點所在

如果單一地使用SpringBoot自帶的ScheduledTaskRegistrar去實現,那麼可能會有以下問題:

  1. 只能按照指定的時間去執行,更改執行時間需要重啟服務;
  2. 無法刪除該定時任務,或者刪除後無法再啟動新的定時任務。
  3. 業務邏輯與觸發器的代碼耦合度太高,無法將業務代碼從ScheduledTaskRegistrar類中抽離出去。
/**
 * @author Created by zhuzqc on 2023/1/30 15:28
 */
@Slf4j
@Component
@EnableScheduling
public class ScheduleTaskDemo implements SchedulingConfigurer {

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    @Override
    public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {

        //Runnable線程註冊任務
        Runnable taskOne = () -> {
            //需要執行的業務邏輯,一般會在這裡封裝好
            logger.info("----------業務執行結束----------");
        };
        //任務的觸發時間,一般使用 cron 表達式
        Trigger triggerOne = triggerContext -> {
            Date nextExecTime = null;
            try {
                // 此處指定 cron 表達式
                String cron = "0 00 12 ? * *";
                if (StringUtils.isBlank(cron)) {
                    // 提示參數為空
                    logger.info("trigger定時器的 cron 參數為空!");
                    // 如果為空則賦預設值,每天中午12點
                    cron = "0 00 12 ? * *";
                }
                logger.info("---------->定時任務執行中<---------");
                CronTrigger cronTrigger = new CronTrigger(cron);
                nextExecTime = cronTrigger.nextExecutionTime(triggerContext);
            } catch (Exception e) {
                e.printStackTrace();
                log.info(e.getMessage());
            }
            return nextExecTime;
        };
        taskRegistrar.addTriggerTask(taskOne, triggerOne);
    }
}

​ 上述代碼只能實現在指定的時間去觸發定時任務,無法對 cron 表達式進行更改,如果更改則需要重新啟動服務,非常地“傻瓜”。

​ 而在實際的編碼過程中,業務邏輯代碼需要單獨地剝離開(解耦),如何做到業務邏輯代碼和觸發器代碼都能訪問到外部業務數據,是設計過程中需要考慮到的關鍵。

三、解決思路

//TODO:如果要在此處將業務邏輯和時間觸發器進行捆綁,那麼在這個實現類中無法獲取到來自該類外部的業務數據;
//TODO:要解決這樣的問題,就要找到一個辦法:既能將兩者抽離,又能實現靈活觸發定時任務。

​ 在這裡介紹一個名為ThreadPoolTaskScheduler類,通過源碼得知,該類實現了SchedulingTaskExecutor和TaskScheduler介面。

​ 該類中schedule(Runnable task, Trigger trigger)方法,通過分別傳入線程任務(業務邏輯)Trigger觸發器對象作為參數,支持動態創建指定 cron 表達式的定時任務

​ 該方法源碼如下:

 	@Override
	@Nullable
	public ScheduledFuture<?> schedule(Runnable task, Trigger trigger) {
		ScheduledExecutorService executor = getScheduledExecutor();
		try {
			ErrorHandler errorHandler = this.errorHandler;
			if (errorHandler == null) {
				errorHandler = TaskUtils.getDefaultErrorHandler(true);
			}
			return new ReschedulingRunnable(task, trigger, this.clock, executor, errorHandler).schedule();
		}
		catch (RejectedExecutionException ex) {
			throw new TaskRejectedException("Executor [" + executor + "] did not accept task: " + task, ex);
		}
	}

以下部分是對該方法的具體使用,核心思路如下 :

  1. 實例化ThreadPoolTaskScheduler類對象;
  2. 實例化ScheduledFuture類對象,用於初始化調用schedule()後的值。
  3. 將攜帶有Runnable和Trigger的ScheduledFuture類對象作為Map的value進行裝配。
  4. 根據Map的key對定時任務進行管理,達到添加和刪除的目的。

四、代碼示例

代碼示例分為兩部分:

第一部分是關於ThreadPoolTaskScheduler類和schedule()方法的使用;

/**
 * @author @author Created by zhuzqc on 2023/1/30 15:39
 * 任務線程池管理工具
 */
public class TaskSchedulerUtil {

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

    /**
     * 線程調度工具對象,作為該類的成員變數
     */
    private static ThreadPoolTaskScheduler threadPoolTaskScheduler = new ThreadPoolTaskScheduler();

    /**
     *初始化 map 對象,裝配 schedule 方法的返回對象為 value 值
     */
    private static Map<String, ScheduledFuture<?>> scheduledFutureMap = new HashMap<String, ScheduledFuture<?>>();

    static {
        threadPoolTaskScheduler.initialize();
    }

    /**
     * 將Runnable對象和Trigger對象作為參數傳入該靜態方法
     * @param runnable
     * @param trigger
     * @param 定時任務id
     */
    public static void put(Runnable runnable, Trigger trigger, String id) {
        // 將攜帶有Runnable和Trigger的ScheduledFuture類對象作為 Map 的 value 進行裝配
        ScheduledFuture<?> scheduledFuture = threadPoolTaskScheduler.schedule(runnable, trigger);
        // 放入 Map 中作為 value
        scheduledFutureMap.put(id, scheduledFuture);
        logger.info("---添加定時任務--->" + id);
    }

    /**
     * 通過上述 put 方法的參數id(定時任務id)標識,將定時任務移除出 map
     * @param id
     */
    public static void delete(String id) {
        ScheduledFuture<?> scheduledFuture = scheduledFutureMap.get(id);
        // 條件判斷
        if (scheduledFuture != null && scheduledFuture.isCancelled()) {
            scheduledFuture.cancel(true);
        }
        scheduledFutureMap.remove(id);
        logger.info("---取消定時任務--->" + id);
    }
}

第二部分是關於結合實際業務,引入實際業務數據的代碼demo。

/**
 * @author Created by zhuzqc on 2023/1/30 15:58
 */
@Slf4j
@Component
@EnableScheduling
public class TaskScheduleDemo{

    @Resource
    private AAAMapper aaaMapper;
    @Resource
    private BBBService bbbService;

    private Logger logger = LoggerFactory.getLogger(this.getClass());

    // 引入外部的業務數據對象
    public void putHiredTask(CCCEntity cccEntity){
        //TODO: 將業務線程和定時觸發器交由線程池工具管理:創建業務線程對象,並對屬性賦初始化值(有參構造)
        TaskSchedulerUtil.put(new TaskThreadDemo(cccEntity,aaaMapper,bbbService), new Trigger() {
            @Override
            public Date nextExecutionTime(TriggerContext triggerContext) {
                //獲取定時觸發器,這裡可以獲取頁面的更新記錄,實現定時間隔的動態調整
                Date nextExecTime = TaskTransUtils.StringToDateTime(cccEntity.getSendTime());
                //cron 表達式轉換工具類
                String cron = TaskTransUtils.getDateCronTime(nextExecTime);
                try {
                    if (StringUtils.isBlank(cron)) {
                        // 提示參數為空
                        logger.info("trackScheduler定時器的 cron 參數為空!");
                        // 如果為空則賦預設值,每天早上9:00
                        cron = "0 00 09 ? * *";
                    }
                    logger.info("-------定時任務執行中:" + cron + "--------");
                    CronTrigger cronTrigger = new CronTrigger(cron);
                    nextExecTime = cronTrigger.nextExecutionTime(triggerContext);
                } catch (Exception e) {
                    e.printStackTrace();
                    log.info(e.getMessage());
                }
                return nextExecTime;
            }
        },"該定時任務的id");
    }
}

五、文章小結

動態定時任務的總結如下:

  1. 單一使用ScheduledTaskRegistrar類,無法達到預期動態調整定時任務的效果;
  2. 實際的開發場景中,需要業務邏輯代碼和觸發器代碼都能訪問到外部業務數據;
  3. 配合ThreadPoolTaskScheduler類和該類中的schedule()方法可以達到動態調整定時任務的效果。

如果大家有遇到這樣類似的問題,並且為此感到困惑時,希望以上文章的介紹可以幫助到大家。

最後,歡迎大家的指正和交流!


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 初識Flask Flask簡介 Flask是一個基於Python的web框架,由奧地利開發商Armin Ronacher於2010年4月1日發佈。它以靈活、“微”框架著稱,其本身並不具備太多的功能,但通過豐富的第三方插件,使其在保持重量輕和簡單的同時仍然可以進行高度擴展,讓開發者能輕鬆應對現實開發中 ...
  • 簡單介紹一下Go中Gin使用get和post方法獲取前端數據 1.使用get方法獲取url中的參數 因為我使用的網頁只需要在url上傳一個參數,簡單介紹一下,get方法的傳參吧,可能不全,後續補充~ 在主函數使用get/post方式載入需要從網頁中使用get/post方法獲取數據如下(預設使用get ...
  • 聲明:文章僅用於學習交流,切勿用於非法用途。 一、autojs版本 使用autojs版本4.1,其餘版本對微信、qq、抖音有限制。 下載地址:關註【產品經理不是經理】gzh,回覆【autojs】即可下載。 官方文檔:https://pro.autojs.org/docs/zh/v8/ 學習要點:熟悉 ...
  • 一、 為什麼要多線程 CPU和IO設備之間的速度存在很大的差異,提高CPU利用率 提高服務端併發量 線程安全問題: 有共用數據的情況下使用多線程可能會導致線程安全問題 原子性:時間片輪轉導致 可見性:CPU和記憶體之間有緩存/工作記憶體和主記憶體 有序性:指令重排序 實現線程安全的方法: 互斥同步:悲觀 ...
  • 程式設計基礎 基礎知識 什麼是程式? 為進行某項活動的步驟,電腦的程式,為得到某種結果,通過電腦語言表達的指令序列。 什麼是程式設計? 計算思維,是運用電腦科學的基礎概念進行問題求解,系統設計,以及人類行為理解等涵蓋電腦科學之廣度的一系列思維活動。 計算思維的特點: 1.滿足電腦程式執行的 ...
  • Gin框架實戰——HTML渲染 最近使用Go的Gin框架做了個簡單的前端網頁,記錄一下細節~ 1.載入靜態文件 由於網頁需要使用css、圖片等渲染,而靜態文件必須先聲明:否則模板中調用載入不出來,這個很重要,即使你把文件放到對應路徑下,html中也寫了相應的路徑,但是開啟go服務端的網頁,會顯示不出 ...
  • 1、shutil高級文件操作模塊 shutil模塊提供了大量的文件的高級操作。特別針對文件拷貝和刪除,主要功能為目錄和文件操作以及壓縮操作。對單個文件的操作也可參見os模塊。 2、shutil模塊的拷貝方法 >>> import shutil >>> shutil.chown('test.txt', ...
  • 一、DDS工作原理 以正弦信號為例,DDS大概就是將M個點的一個周期的正弦序列存入ROM中,序列數據的地址就是正弦信號的相位; 通過修改頻率控制字(Fword)來改變每隔多少個地址取ROM里的數據進行輸出。頻率控制字越大,從ROM取出的數據點就越少,點數越少,輸出一個周期信號的時間就越短,從而改變了 ...
一周排行
    -Advertisement-
    Play Games
  • 通過WPF的按鈕、文本輸入框實現了一個簡單的SpinBox數字輸入用戶組件並可以通過數據綁定數值和步長。本文中介紹了通過Xaml代碼實現自定義組件的佈局,依賴屬性的定義和使用等知識點。 ...
  • 以前,我看到一個朋友在對一個系統做初始化的時候,通過一組魔幻般的按鍵,調出來一個隱藏的系統設置界面,這個界面在常規的菜單或者工具欄是看不到的,因為它是一個後臺設置的關鍵界面,不公開,同時避免常規用戶的誤操作,它是作為一個超級管理員的入口功能,這個是很不錯的思路。其實Winform做這樣的處理也是很容... ...
  • 一:背景 1. 講故事 前些天有位朋友找到我,說他的程式每次關閉時就會自動崩潰,一直找不到原因讓我幫忙看一下怎麼回事,這位朋友應該是第二次找我了,分析了下 dump 還是挺經典的,拿出來給大家分享一下吧。 二:WinDbg 分析 1. 為什麼會崩潰 找崩潰原因比較簡單,用 !analyze -v 命 ...
  • 在一些報表模塊中,需要我們根據用戶操作的名稱,來動態根據人員姓名,更新報表的簽名圖片,也就是電子手寫簽名效果,本篇隨筆介紹一下使用FastReport報表動態更新人員簽名圖片。 ...
  • 最新內容優先發佈於個人博客:小虎技術分享站,隨後逐步搬運到博客園。 創作不易,如果覺得有用請在Github上為博主點亮一顆小星星吧! 博主開始學習編程於11年前,年少時還只會使用cin 和cout ,給單片機點點燈。那時候,類似async/await 和future/promise 模型的認知還不是 ...
  • 之前在阿裡雲ECS 99元/年的活動實例上搭建了一個測試用的MINIO服務,以前都是直接當基礎設施來使用的,這次準備自己學一下S3相容API相關的對象存儲開發,因此有了這個小工具。目前僅包含上傳功能,後續計劃開發一個類似圖床的對象存儲應用。 ...
  • 目錄簡介快速入門安裝 NuGet 包實體類User資料庫類DbFactory增刪改查InsertSelectUpdateDelete總結 簡介 NPoco 是 PetaPoco 的一個分支,具有一些額外的功能,截至現在 github 星數 839。NPoco 中文資料沒多少,我是被博客園群友推薦的, ...
  • 前言 前面使用 Admin.Core 的代碼生成器生成了通用代碼生成器的基礎模塊 分組,模板,項目,項目模型,項目欄位的基礎功能,本篇繼續完善,實現最核心的模板生成功能,並提供生成預覽及代碼文件壓縮下載 準備 首先清楚幾個模塊的關係,如何使用,簡單畫一個流程圖 前面完成了基礎的模板組,模板管理,項目 ...
  • 假設需要實現一個圖標和文本結合的按鈕 ,普通做法是 直接重寫該按鈕的模板; 如果想作為通用的呢? 兩種做法: 附加屬性 自定義控制項 推薦使用附加屬性的形式 第一種:附加屬性 創建Button的附加屬性 ButtonExtensions 1 public static class ButtonExte ...
  • 在C#中,委托是一種引用類型的數據類型,允許我們封裝方法的引用。通過使用委托,我們可以將方法作為參數傳遞給其他方法,或者將多個方法組合在一起,從而實現更靈活的編程模式。委托類似於函數指針,但提供了類型安全和垃圾回收等現代語言特性。 基本概念 定義委托 定義委托需要指定它所代表的方法的原型,包括返回類 ...