SpringBoot項目集成xxljob實現全紀錄

Posted on by

xxljob介紹

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

 被稱為任務調度中心，可做定時任務。

優點特性如下：

1、簡單：支持通過Web頁面對任務進行CRUD操作，操作簡單，一分鐘上手；
2、動態：支持動態修改任務狀態、啟動/停止任務，以及終止運行中任務，即時生效；
3、調度中心HA（中心式）：調度采用中心式設計，“調度中心”自研調度組件並支持集群部署，可保證調度中心HA；
4、執行器HA（分佈式）：任務分佈式執行，任務”執行器”支持集群部署，可保證任務執行HA；
5、註冊中心: 執行器會周期性自動註冊任務, 調度中心將會自動發現註冊的任務並觸發執行。同時，也支持手動錄入執行器地址；
6、阻塞處理策略：調度過於密集執行器來不及處理時的處理策略，策略包括：單機串行（默認）、丟棄後續調度、覆蓋之前調度；
7、任務超時控制：支持自定義任務超時時間，任務運行超時將會主動中斷任務；
8、任務失敗重試：支持自定義任務失敗重試次數，當任務失敗時將會按照預設的失敗重試次數主動進行重試；其中分片任務支持分片粒度的失敗重試；
9、任務失敗告警；默認提供郵件方式失敗告警，同時預留擴展接口，可方便的擴展短信、釘釘等告警方式；
10、任務進度監控：支持實時監控任務進度；
11、Rolling實時日志：支持在線查看調度結果，並且支持以Rolling方式實時查看執行器輸出的完整的執行日志；
12、自定義任務參數：支持在線配置調度任務入參，即時生效；
13、數據加密：調度中心和執行器之間的通訊進行數據加密，提升調度信息安全性；
14、郵件報警：任務失敗時支持郵件報警，支持配置多郵件地址群發報警郵件；

官網地址：XXL開源社區 | 項目

代碼配置過程

1.引入xxl-job的依賴

<dependency>
     <groupId>com.xuxueli</groupId>
     <artifactId>xxl-job-core</artifactId>
     <version>2.0.1</version>
</dependency>

2.編寫配置文件

xxl:
  job:
    admin:
      addresses: http://d-xxljob.dmsd.tech:8081/job-admin-dev  #xxljob調度中心部署  例如：http://127.0.0.1:8080/xxl-job-admin
    executor:
      appname: testJob #xxljob配置的執行器名稱，
      ip:             #執行器IP，默認為空表示自動獲取IP
      port: 9999 #xxljob配置的端口號，默認為9999
      logpath: /data/xxl-job/jobhandler  #執行器運行日志文件存儲磁盤路徑
      logretentiondays: -1  #調度中心日志表數據保存天數，過期日志自動清理；限制大於等於7時生效，否則, 如-1，關閉自動清理功能
    accessToken: #調度中心通訊TOKEN [選填]：非空時啟用

3. 編寫配置類

/**
 * xxl-job 定時器配置，讀取配置文件中的內容
 *
 * @author 張有博
 * @version 0.0.1
 * @since 2021年11月14日
 */
@Configuration
@ComponentScan(basePackages = "com.dmsdbj.integral.zentao.provider.job")//配置需要掃描的job類
@Slf4j
public class XxlJobConfig {
 
    @Value("${xxl.job.admin.addresses}")
    private String adminAddresses;
 
    @Value("${xxl.job.executor.appname}")
    private String appName;
 
    @Value("${xxl.job.executor.ip}")
    private String ip;
 
    @Value("${xxl.job.executor.port}")
    private int port;
 
    @Value("${xxl.job.accessToken}")
    private String accessToken;
 
    @Value("${xxl.job.executor.logpath}")
    private String logPath;
 
    @Value("${xxl.job.executor.logretentiondays}")
    private int logRetentionDays;
 
 
 
    @Bean(initMethod = "start", destroyMethod = "destroy")
    public XxlJobSpringExecutor xxlJobExecutor() {
        log.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
        xxlJobSpringExecutor.setAppName(appName);
        xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
 
        return xxlJobSpringExecutor;
    }
 
}

4.新建Job文件夾，將自己寫的類放到此文件夾下

與XxlJobConfig類，要掃描的包做對應

5. 編寫業務代碼

package com.dmsdbj.integral.zentao.provider.job;
 
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.JobHandler;
import com.xxl.job.core.log.XxlJobLogger;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
 
/**
 * XXLJob的測試類，需要繼承IJobHandler類
 *
 * @author Promsing(張有博)
 * @version 1.0.0
 * @since 2021/11/14 - 19:51
 */
@Slf4j
@Component
@JobHandler(value = "TestJob") //與xxl-job上的jobHandler做對應
public class TestJob extends IJobHandler {
    /**
     * execute handler, invoked when executor receives a scheduling request
     *
     * @param param
     * @return
     * @throws Exception
     */
    @Override
    public ReturnT<String> execute(String param)  {
        XxlJobLogger.log(this.getClass().getSimpleName() + "--start");
        try {
            System.out.println("業務代碼1");
            System.out.println("業務代碼2");
            System.out.println("業務代碼3");
            System.out.println("業務代碼4");
            System.out.println("業務代碼5");
        } catch (Exception e) {
            log.error(e.getMessage(), e);
            throw e;
        }
        XxlJobLogger.log(this.getClass().getSimpleName() + "--end");
        return ReturnT.SUCCESS;
    }
}

登錄xxl-Job並配置

1.執行器管理–新增執行器

 2.任務管理–新增任務

 配置的參數如下：

 這裡推薦一個解析Cron的網站：在線Cron表達式生成器

測試：

斷點調試

 查看調度日志：

 xxlJob的配置過程不是很復雜，但是需要細心。多看官網，多看幫助，少走彎路。

到此這篇關於SpringBoot項目集成xxljob實現全紀錄的文章就介紹到這瞭,更多相關SpringBoot集成xxljob內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：