Spring Boot 整合 xxl-job

官方檔案：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. 添加配置資訊

幾個核心配置：服務地址、應用名稱、埠、日志路徑

# 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 專案后臺任務的日志列印情況，測驗驗證，

以上，整合完成，

都看到最后了，右下角來個贊鴨！-.- 歡迎評論留言~

標籤：Java

上一篇：SELECT COUNT(*) 會造成全表掃描？回去等通知吧

下一篇：JdkProxy的進階知識