Springboot集成分布式任務調度系統XXl-Job(調度器和執行器)

作者：言沫東 2023-11-07 07:56:40

開發架構

我們部署的是調度器管理平臺，執行器就是我們實際開發的應用系統：比如：會員系統、訂單系統、結算系統等等；執行器管理可以對每一個注冊上來的執行器進行管理（編輯、刪除執行器等）。

一、部署xxl-job服務端

下載xxl-job源碼

下載地址：https://gitee.com/xuxueli0323/xxl-job

二、導入項目、創建xxl_job數據庫、修改配置文件為自己的數據庫

三、啟動項目、訪問首頁

訪問地址：http://localhost:8080/xxl-job-admin/ 賬號：admin 密碼：123456.

執行器管理

任務管理

我們應用系統都會有自己特定的job任務：比如：會員系統定時拉取一些會員推送模板消息、短信消息；結算系統定時生成結算任務、報表等。任務管理可根據具體的執行器、job任務名稱（JobHandler）、任務描述等進行篩選；可新增任務、啟動任務、執行任務、查詢調度日志，功能比較豐富。

用戶管理

用戶管理可根據角色（普通用戶、管理員）進行管理：新增用戶、刪除用戶。

調度日志

在調度日志模塊可查詢我們執行任務時的具體情況，可根據具體的執行器、任務名稱、執行狀態進行篩選（成功、失敗、進行中），對于進行中的任務可手動終止；調度備注列可查看調度詳情，比如：我們的任務被調度到哪一臺機器、調度的結果碼、結果信息等等。

運行報表

運行報表是對調度平臺中執行器數、任務數、調度次數、調度明細（成功、失敗）數據的匯總統計。

四、新建結算系統執行器【僅僅是個demo案例】

看到此處，想必大家心中對xxl-job已經有了一些初步的了解和感受，摩拳擦掌，趁熱打鐵，下面我們新建一個結算系統應用，注冊到調度平臺，并新建一個月結任務，測試下吧。

引入xxl-job調度器依賴

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

application.properties配置文件新增xxl-job配置

#xxljob config
#調度器地址
xxl.job.admin.addresses = http://127.0.0.1:8080/xxl-job-admin
#鑒權用暫無
xxl.job.accessToken =
#執行器名稱（就是我們的業務系統） 
xxl.job.executor.appname = settle-system
#執行器地址和ip，demo案例無需填寫
xxl.job.executor.address =
xxl.job.executor.ip =
#執行器端口：默認值：9999
xxl.job.executor.port = 9999
#日志路徑
xxl.job.executor.logpath = D:\\tmp\\log
#日志清理時間
xxl.job.executor.logretentiondays = 30

執行器配置類(XxlJobConfig.java)：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.beans.factory.annotation.Value;
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.springframework.context.annotation.Configuration;

@Configuration
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.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;
    }

編寫結算系統-月結job任務(MonthlySettlementJobHandler.java)

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import com.xxl.job.core.handler.annotation.XxlJob;

@Component
public class MonthlySettlementJobHandler {

    private static Logger logger = LoggerFactory.getLogger(MonthlySettlementJobHandler.class);

		// 使用@XxlJob注解，將monthlySettlementJobHandler任務注冊到調度平臺
    @XxlJob("monthlySettlementJobHandler")
    public void monthlySettlementJobHandler(String param) throws InterruptedException {
        try {
            logger.info("結算系統-月結任務執行 參數: {}", param);
        } catch (Exception e) {
            logger.error("結算系統-月結任務執行 異常 參數: {} 異常信息: ", param, e);
        }
    }
}

結算系統執行器代碼編寫完畢，啟動成功后，就需要去調度器管理平臺新建我們的執行器、以及我們的job任務了。