快捷導(dǎo)航

springboot整合 xxl-job的項(xiàng)目實(shí)踐

更新時間：2024年09月14日 10:28:50 作者：世界需要行動派

XL-JOB是一個分布式任務(wù)調(diào)度平臺,用于解決分布式系統(tǒng)中的任務(wù)調(diào)度和管理問題,它包括調(diào)度中心、執(zhí)行器和Web管理控制臺,本文就來介紹一下springboot整合 xxl-job的項(xiàng)目實(shí)踐,感興趣的可以了解一下

一、xxl-job是什么

XXL-JOB 是一個分布式任務(wù)調(diào)度平臺，主要用于解決在分布式系統(tǒng)中任務(wù)調(diào)度和任務(wù)管理的問題。

XXL-JOB 的架構(gòu)通常包括以下幾個組件：
調(diào)度中心（Scheduler）：負(fù)責(zé)任務(wù)的調(diào)度、管理和監(jiān)控，是整個調(diào)度系統(tǒng)的核心。
執(zhí)行器（Executor）：負(fù)責(zé)具體任務(wù)的執(zhí)行，可以部署在不同的節(jié)點(diǎn)上。
Web 管理控制臺：提供友好的 Web 界面，方便用戶進(jìn)行任務(wù)的管理和監(jiān)控。

二、使用步驟

1. 下載并運(yùn)行管理端代碼

項(xiàng)目地址：
1??：【gitee】https://gitee.com/xuxueli0323/xxl-job
2??：【github】https://github.com/xuxueli/xxl-job

項(xiàng)目整體結(jié)構(gòu)

管理端需要注意的地方

在這里插入圖片描述

執(zhí)行sql腳本，tables_xxl_job.sql

修改application.properties配置文件，主要修改兩處

### xxl-job, datasource
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=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

### xxl-job, access token
xxl.job.accessToken=default_token

數(shù)據(jù)庫地址對應(yīng)的是第一步執(zhí)行腳本創(chuàng)建的庫的位置

accessToken的值需要和執(zhí)行器中配置的值(后面會寫)一致
通過Application運(yùn)行程序，也可以打包后通過jar命令啟動

2. 訪問管理頁面，確認(rèn)是否啟動成功

地址：http://127.0.0.1:8080/xxl-job-admin 【和配置文件一致】
默認(rèn)賬密：admin/123456【忘記密碼可以去數(shù)據(jù)庫修改，使用md5加密后填充】

3. 配置執(zhí)行器【在自己的springboot項(xiàng)目中配置】

引入依賴

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

添加配置文件

accessToken與前面配置一致，address對應(yīng)管理端訪問地址
executor（執(zhí)行器）的配置與后面在頁面上創(chuàng)建執(zhí)行器時保持一致

### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
xxl:
  job:
    accessToken: default_token
    admin:
      addresses: http://127.0.0.1:8080/xxl-job-admin
    executor:
      appname: xxl-job-executor-test-zhu
      address: http://localhost:9999  # 填充地址，假設(shè)執(zhí)行器運(yùn)行在本地
      ip: 127.0.0.1  # 填充本地IP，確保它與address配置一致
      port: 9999
      logpath: /data/applogs/xxl-job/jobhandler
      logretentiondays: -1

執(zhí)行器組件配置

package com.zhui.yudada.config;

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

@Slf4j
@Configuration
public class XxlJobConfig {
    @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() {
        log.info(">>>>>>>>>>> start 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;
    }
}

jobhander配置

package com.zhui.yudada.job;
 
 
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

 
 
@Component
public class HelloJob {
 
    @Value("${server.port}")
    private String port;
 
    @XxlJob("demoJobHandler")
    public ReturnT helloJob() {
        System.out.println("簡單任務(wù)執(zhí)行了。。。" + port);
        return  ReturnT.SUCCESS;
    }
}

啟動項(xiàng)目，出現(xiàn)下面的提示說明啟動成功

在這里插入圖片描述