springboot整合 xxl-job及使用步驟

更新時間：2025年01月09日 09:41:33 作者：m0_74825488

XXL-JOB是一個分布式任務調度平臺,用于解決分布式系統(tǒng)中的任務調度和管理問題,文章詳細介紹了XXL-JOB的架構,包括調度中心、執(zhí)行器和Web管理控制臺,并提供了使用步驟,包括下載、配置、啟動和創(chuàng)建執(zhí)行器和任務,感興趣的朋友一起看看吧

一、xxl-job是什么

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

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

二、使用步驟

1. 下載并運行管理端代碼

項目地址：
1：【gitee】https://gitee.com/xuxueli0323/xxl-job
2：【github】https://github.com/xuxueli/xxl-job

管理端需要注意的地方

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

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

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

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

accessToken的值需要和執(zhí)行器中配置的值(后面會寫)一致

xxl-job, access token

xxl.job.accessToken=default_token

通過Application運行程序，也可以打包后通過jar命令啟動

2. 訪問管理頁面，確認是否啟動成功

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

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

引入依賴

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

添加配置文件

accessToken與前面配置一致，address對應管理端訪問地址
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 # 填充地址，假設執(zhí)行器運行在本地
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(“x x l . j o b . a d m i n . a d d r e s s e s " ) p r i v a t e S t r i n g a d m i n A d d r e s s e s ; @ V a l u e ( " {xxl.job.admin.addresses}") private String adminAddresses; @Value("xxl.job.admin.addresses")privateStringadminAddresses;@Value("{xxl.job.accessToken}”)
private String accessToken;
@Value(“x x l . j o b . e x e c u t o r . a p p n a m e " ) p r i v a t e S t r i n g a p p n a m e ; @ V a l u e ( " {xxl.job.executor.appname}") private String appname; @Value("xxl.job.executor.appname")privateStringappname;@Value("{xxl.job.executor.address}”)
private String address;
@Value(“x x l . j o b . e x e c u t o r . i p " ) p r i v a t e S t r i n g i p ; @ V a l u e ( " {xxl.job.executor.ip}") private String ip; @Value("xxl.job.executor.ip")privateStringip;@Value("{xxl.job.executor.port}”)
private int port;
@Value(“x x l . j o b . e x e c u t o r . l o g p a t h " ) p r i v a t e S t r i n g l o g P a t h ; @ V a l u e ( " {xxl.job.executor.logpath}") private String logPath; @Value("xxl.job.executor.logpath")privateStringlogPath;@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("簡單任務執(zhí)行了。。。" + port);
    return  ReturnT.SUCCESS;
}
}

啟動項目，出現下面的提示說明啟動成功