SpringBoot整合xxl-Job分布式定時任務

作者：小王 2023-01-04 09:23:58

開發架構

XXL-JOB是一個分布式任務調度平臺，其核心設計目標是開發迅速、學習簡單、輕量級、易擴展。現已開放源代碼并接入多家公司線上產品線，開箱即用。

一、前言

定時任務有很多種，有一些大的框架也有一些簡單的實現。
比如常見的：

JDK的Timer和TimerTask
Quartz異步任務調度框架
分布式定時任務XXL-JOB
Spring Task注解@Scheduled

小編也就知道這些，歡迎大佬補充哈！！

今天小編就以現在比較火的分布式定時任務xxl-job，優點比較輕量級，但是從21年到現在沒有比較大的更新！現在最新的好像是2.4.0。

二、xxl-job介紹

XXL-JOB是一個分布式任務調度平臺，其核心設計目標是開發迅速、學習簡單、輕量級、易擴展。現已開放源代碼并接入多家公司線上產品線，開箱即用。

它是美團大佬：許雪里開發出來的！

本篇以實踐教學為主，介紹大家感興趣可以去官方文檔去看看！

xxl-job文檔。

總體架構圖：

==大家自行拉去最新代碼即可==：

項目地址：

三、修改配置

1、運行sql文件

導出到本地數據庫：

XXL-JOB調度模塊基于自研調度組件并支持集群部署，調度數據庫表說明如下：

xxl_job_lock：任務調度鎖表。
xxl_job_group：執行器信息表，維護任務執行器信息。
xxl_job_info：調度擴展信息表：用于保存XXL-JOB調度任務的擴展信息，如任務分組、任務名、機器地址、執行器、執行入參和報警郵件等等。
xxl_job_log：調度日志表：用于保存XXL-JOB任務調度的歷史信息，如調度結果、執行結果、調度入參、調度機器和執行器等等。
xxl_job_log_report：調度日志報表：用戶存儲XXL-JOB任務調度日志的報表，調度中心報表功能頁面會用到。
xxl_job_logglue：任務GLUE日志：用于保存GLUE更新歷史，用于支持GLUE的版本回溯功能。
xxl_job_registry：執行器注冊表，維護在線的執行器和調度中心機器地址信息。
xxl_job_user：系統用戶表；

2、修改xxl-job-admin配置

小編修改了一下端口號：

server.port=8087

記得調整成自己的數據庫密碼：

spring.datasource.password=root

由于sql文件導入的直接是個數據庫，不需要我們在調整數據庫的名稱！

3、需修改xxl-job-executor-sample-springboot配置

小編這里修改了端口號：

server.port=8086

第11行：修改為admin的端口。

xxl.job.admin.addresses=http://127.0.0.1:8087/xxl-job-admin

第22行：小編9999端口被占用，修改了一下端口。

xxl.job.executor.port=9998

4、添加自己的定時任務

@XxlJob("testJobHandler")
public void testJobHandler() throws Exception {
    for (int i = 0; i < 5; i++) {
        XxlJobHelper.log("這是第" + i + 1 + "條日志！");
        System.out.println("這是第" + i + 1 + "次看到我了！");
    }
    System.out.println("定時任務結束！！");
}

四、運行項目

1、啟動項目

2、登錄

根據上一步的配置，我們直接端口號加服務名字進行訪問：

??http://localhost:8087/xxl-job-admin/。??

賬號：admin密碼：123456。

3、xxl-job的好處

自己寫完的定時任務，可以交給這個管理，這樣什么時候運行，定時任務的執行規則，都可以在可視化的界面進行管理和操作，更加的人性化！可以動態的修改cron表達式，還有日志執行情況，這是真的香啊！！

4、查看執行器獲取網址

默認已經把springboot整合上來了，如果大家是自己新建的模塊可以新增一條，讓管理器管理咱們自己項目的定時任務，也就是使用@XxlJob的任務！

5、新增任務管理

這里比較智能，一些基本的cron表達式都可以幫你寫，非常的人性！！==JobHandler==：填@XxlJob里面的名字即可，小編這里是：@XxlJob("testJobHandler")，所以是testJobHandler。

6、執行任務

我們這次執行一次，看看控制臺是否打印記錄，看看我們寫的任務是否執行了！

任務參數隨便輸入，機器地址為：http://192.168.1.207:9998/，第4步查看的，也就是管理端的地址加端口！

7. 執行成功

我們看到方法成功被執行了！！

8、查看日志

五、總結

大家看到我的日志還是有執行失敗的，原因是開始端口被占用，沒有注意，一直在測試，一直失敗！大家運行后一定看看控制臺有沒有報錯，如果是java.net.BindException: Address already in use: bind那就是端口號被占用，換一個就行了！也可以看看小編這篇文章，詳細解決了這個問題！

責任編輯：姜華來源：小王博客基地

springboot 分布式