SpringBoot項目集成xxljob的示例分析

小編給大家分享一下SpringBoot項目集成xxljob的示例分析，相信大部分人都還不怎么了解，因此分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后大有收獲，下面讓我們一起去了解一下吧！

xxljob介紹

XXL-JOB是一個分布式任務(wù)調(diào)度平臺，其核心設(shè)計目標(biāo)是開發(fā)迅速、學(xué)習(xí)簡單、輕量級、易擴(kuò)展?，F(xiàn)已開放源代碼并接入多家公司線上產(chǎn)品線，開箱即用。

 被稱為任務(wù)調(diào)度中心，可做定時任務(wù)。

優(yōu)點(diǎn)特性如下：

1、簡單：支持通過Web頁面對任務(wù)進(jìn)行CRUD操作，操作簡單，一分鐘上手；
2、動態(tài)：支持動態(tài)修改任務(wù)狀態(tài)、啟動/停止任務(wù)，以及終止運(yùn)行中任務(wù)，即時生效；
3、調(diào)度中心HA（中心式）：調(diào)度采用中心式設(shè)計，“調(diào)度中心”自研調(diào)度組件并支持集群部署，可保證調(diào)度中心HA；
4、執(zhí)行器HA（分布式）：任務(wù)分布式執(zhí)行，任務(wù)”執(zhí)行器”支持集群部署，可保證任務(wù)執(zhí)行HA；
5、注冊中心: 執(zhí)行器會周期性自動注冊任務(wù), 調(diào)度中心將會自動發(fā)現(xiàn)注冊的任務(wù)并觸發(fā)執(zhí)行。同時，也支持手動錄入執(zhí)行器地址；
6、阻塞處理策略：調(diào)度過于密集執(zhí)行器來不及處理時的處理策略，策略包括：單機(jī)串行（默認(rèn)）、丟棄后續(xù)調(diào)度、覆蓋之前調(diào)度；
7、任務(wù)超時控制：支持自定義任務(wù)超時時間，任務(wù)運(yùn)行超時將會主動中斷任務(wù)；
8、任務(wù)失敗重試：支持自定義任務(wù)失敗重試次數(shù)，當(dāng)任務(wù)失敗時將會按照預(yù)設(shè)的失敗重試次數(shù)主動進(jìn)行重試；其中分片任務(wù)支持分片粒度的失敗重試；
9、任務(wù)失敗告警；默認(rèn)提供郵件方式失敗告警，同時預(yù)留擴(kuò)展接口，可方便的擴(kuò)展短信、釘釘?shù)雀婢绞剑?br/>10、任務(wù)進(jìn)度監(jiān)控：支持實時監(jiān)控任務(wù)進(jìn)度；
11、Rolling實時日志：支持在線查看調(diào)度結(jié)果，并且支持以Rolling方式實時查看執(zhí)行器輸出的完整的執(zhí)行日志；
12、自定義任務(wù)參數(shù)：支持在線配置調(diào)度任務(wù)入?yún)?，即時生效；
13、數(shù)據(jù)加密：調(diào)度中心和執(zhí)行器之間的通訊進(jìn)行數(shù)據(jù)加密，提升調(diào)度信息安全性；
14、郵件報警：任務(wù)失敗時支持郵件報警，支持配置多郵件地址群發(fā)報警郵件；

官網(wǎng)地址：XXL開源社區(qū) | 項目

代碼配置過程

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調(diào)度中心部署  例如：http://127.0.0.1:8080/xxl-job-admin
    executor:
      appname: testJob #xxljob配置的執(zhí)行器名稱，
      ip:             #執(zhí)行器IP，默認(rèn)為空表示自動獲取IP
      port: 9999 #xxljob配置的端口號，默認(rèn)為9999
      logpath: /data/xxl-job/jobhandler  #執(zhí)行器運(yùn)行日志文件存儲磁盤路徑
      logretentiondays: -1  #調(diào)度中心日志表數(shù)據(jù)保存天數(shù)，過期日志自動清理；限制大于等于7時生效，否則, 如-1，關(guān)閉自動清理功能
    accessToken: #調(diào)度中心通訊TOKEN [選填]：非空時啟用

3. 編寫配置類

/**
 * xxl-job 定時器配置，讀取配置文件中的內(nèi)容
 *
 * @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類，要掃描的包做對應(yīng)

5. 編寫業(yè)務(wù)代碼

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做對應(yīng)
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("業(yè)務(wù)代碼1");
            System.out.println("業(yè)務(wù)代碼2");
            System.out.println("業(yè)務(wù)代碼3");
            System.out.println("業(yè)務(wù)代碼4");
            System.out.println("業(yè)務(wù)代碼5");
        } catch (Exception e) {
            log.error(e.getMessage(), e);
            throw e;
        }
        XxlJobLogger.log(this.getClass().getSimpleName() + "--end");
        return ReturnT.SUCCESS;
    }
}

登錄xxl-Job并配置

1.執(zhí)行器管理--新增執(zhí)行器

 2.任務(wù)管理--新增任務(wù)

 配置的參數(shù)如下：

 這里推薦一個解析Cron的網(wǎng)站：在線Cron表達(dá)式生成器

測試：

斷點(diǎn)調(diào)試

 查看調(diào)度日志：

 xxlJob的配置過程不是很復(fù)雜，但是需要細(xì)心。

以上是“SpringBoot項目集成xxljob的示例分析”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對大家有所幫助，如果還想學(xué)習(xí)更多知識，歡迎關(guān)注億速云行業(yè)資訊頻道！