Spring Boot 整合 xxl-job

luis林發表於2023-04-13

官方文件:https://www.xuxueli.com/xxl-job/

XXL-JOB 是一個分散式任務排程平臺,其核心設計目標是開發迅速、學習簡單、輕量級、易擴充套件。現已開放原始碼並接入多家公司線上產品線,開箱即用。

說明:官方文件很重要,而且非常詳細,要慢慢適應看官方文件進行學習!

PS:下面搭建和整合流程是基於專案需求進行整理的,和普通學習流程一致,就是有一些命名沒那麼測試化,自行體會。

xxl-job 環境搭建

1. 下載

下載地址:https://github.com/xuxueli/xxl-job/releases

建議:直接下載最新版,如目前我下的是 2.4.0,之前的 2.3.0 用的有問題。

說明:下載解壓後,使用 IDEA 開啟。

2. 資料庫表匯入

SQL 位置:doc/db/tables_xxl_job.sql

說明:匯入到自己的資料庫中。

3. 修改配置資料

說明:以下兩個配置必須修改,否則啟動報錯!

3.1 修改 application.properties

配置檔案位置:xxl-job-admin 下的 src/main/resources/application.properties

server.port=7397 #【自選】,修改後,後面自己執行器專案配置中需要對應換改的這個埠

# 資料來源配置資訊,對應改成自己的。
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=luis
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# 【重要!說明:此 accessToken xxl-job 配置了預設的,你自己的執行器專案中 accessToken 必須保持一致】
xxl.job.accessToken=default_token
3.2 修改 logback.xml

日誌配置檔案位置:xxl-job-admin 下的 src/main/resources/logback.xml

<!-- 日誌檔案儲存位置改成自己的,可按如下示例放到專案根目錄下 -->
<property name="log.path" value="D:/1a-Projects/lw-projects/tool-projects/xxl-job-2.3.0/data/applogs/xxl-job/xxl-job-admin.log"/>

4. 執行訪問

執行 xxl-job-admin 下的主啟動類啟動專案,瀏覽器輸入地址訪問:http://localhost:7397/xxl-job-admin/toLogin

PS:若是免登陸的,則忽略下面賬號密碼。

預設登陸賬號:admin

預設登陸密碼:123456

5. 其他

這裡簡單說明下,xxl-job-executor-samples 下有兩個示例執行器模板專案,有多種任務使用方式,後續可自行參考模板專案以及官方文件,進行學習使用,下面直接介紹 Spring Boot 中簡單使用 XXL-JOB。

Spring Boot 整合 XXL-JOB

新建 Spring Boot 專案,準備進行整合。

1. 新增 pom

<!-- xxl-job-core(建議根據下載的 xxl-job 自行適配版本)-->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.4.0</version>
</dependency>

2. 新增配置資訊

幾個核心配置:排程中心地址、執行器名稱、執行器埠、執行器日誌路徑、執行器通訊 token

# xxl-job
# 官網:https://github.com/xuxueli/xxl-job/
# 地址:http://localhost:7397/xxl-job-admin 【需要先啟動 xxl-job】
# 賬號:admin
# 密碼:123456
xxl:
  job:
    admin:
      ### 排程中心部署根地址 [選填]:如排程中心叢集部署存在多個地址則用逗號分隔。執行器將會使用該地址進行"執行器心跳註冊"和"任務結果回撥";為空則關閉自動註冊;
      addresses: http://127.0.0.1:7397/xxl-job-admin
    executor:
      ### 執行器註冊 [選填]:優先使用該配置作為註冊地址,為空時使用內嵌服務 ”IP:PORT“ 作為註冊地址。從而更靈活的支援容器型別執行器動態IP和動態對映埠問題。
      address:
      ### 執行器AppName [選填]:執行器心跳註冊分組依據;為空則關閉自動註冊
      appname: lottery-job
      ### 執行器IP [選填]:預設為空表示自動獲取IP,多網路卡時可手動設定指定IP,該IP不會繫結Host僅作為通訊實用;地址資訊用於 "執行器註冊" 和 "排程中心請求並觸發任務";
      ip:
      ### 執行器埠號 [選填]:小於等於0則自動獲取;預設埠為9999,單機部署多個執行器時,注意要配置不同執行器埠;
      port: 9998
      ### 執行器執行日誌檔案儲存磁碟路徑 [選填] :需要對該路徑擁有讀寫許可權;為空則使用預設路徑;
      logpath: D:/1a-Projects/lw-projects/tool-projects/xxl-job-2.3.0/data/applogs/xxl-job/jobhandler
      ### 執行器日誌檔案儲存天數 [選填] : 過期日誌自動清理, 限制值大於等於3時生效; 否則, 如-1, 關閉自動清理功能;
      logretentiondays: 50
    ### 執行器通訊TOKEN [選填]:非空時啟用;
    accessToken: default_token

3. 新增配置類

@Configuration
public class LotteryXxlJobConfig {

    private Logger logger = LoggerFactory.getLogger(LotteryXxlJobConfig.class);

    @Value("${xxl.job.admin.addresses}")
    private String adminAddresses;

    @Value("${xxl.job.accessToken}")
    private String accessToken;

    @Value("${xxl.job.executor.appname}")
    private String appname;

    @Value("${xxl.job.executor.address}")
    private String address;

    @Value("${xxl.job.executor.ip}")
    private String ip;

    @Value("${xxl.job.executor.port}")
    private int port;

    @Value("${xxl.job.executor.logpath}")
    private String logPath;

    @Value("${xxl.job.executor.logretentiondays}")
    private int logRetentionDays;

    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");

        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
        xxlJobSpringExecutor.setAppname(appname);
        xxlJobSpringExecutor.setAddress(address);
        xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);

        return xxlJobSpringExecutor;
    }

    /**********************************************************************************************
     * 針對多網路卡、容器內部署等情況,可藉助 "spring-cloud-commons" 提供的 "InetUtils" 元件靈活定製註冊IP;
     *
     *      1、引入依賴:
     *          <dependency>
     *             <groupId>org.springframework.cloud</groupId>
     *             <artifactId>spring-cloud-commons</artifactId>
     *             <version>${version}</version>
     *         </dependency>
     *
     *      2、配置檔案,或者容器啟動變數
     *          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
     *
     *      3、獲取IP
     *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
     **********************************************************************************************/
    
}

4. 新增任務類

@Component
public class LotteryXxlJob {

    private Logger logger = LoggerFactory.getLogger(LotteryXxlJob.class);
	
    // 簡單任務
    @XxlJob("lotteryActivityStateJobHandler")
    public void lotteryActivityStateJobHandler() throws Exception {

        logger.info("我是被 xxl-job 自動呼叫執行的任務!");

    }

}

5. 啟動專案

PS:必須保證 xxl-job 專案先正常啟動,並且任務排程中心可訪問。此專案必須後啟動!

6. 任務排程中心配置任務

說明:必須先建立執行器,再建立任務!

6.1 新增執行器

訪問任務排程中心:http://localhost:7397/xxl-job-admin/

進入執行器管理,新增執行器,填寫資訊:

  • AppName :填自己 Spring Boot 專案中配置的 appname,如上面專案的 lottery-job
  • 名稱:隨便寫,即執行器名
  • 註冊方式:選自動注入

然後儲存即可!

6.2 新增任務

進入任務管理,新增任務,填寫資訊:

  • 執行器:選擇上步中填寫的執行器名稱
  • 任務描述:自行描述
  • 負責人:xxx
  • 排程型別:CRON
  • CRON 表示式:自行定製,如 0/1 * * * * ?,表示每秒執行一次
  • 執行模式:BEAN
  • JobHandler:填上面 Spring Boot 專案任務類方法上 @XxlJob 註解中的名稱,如:lotteryActivityStateJobHandler

然後儲存即可!(其中有些配置可自行設定)

7. 任務操作

在任務管理下,可對新增的任務進行操作,如啟動、執行一次等

點選啟動或執行一次後,可觀察 Spring Boot 專案後臺任務的日誌列印情況,測試驗證。

以上,整合完成。

相關文章