SpringBoot整合XXL-JOB v2.5.0搭建分布式任务调度平台的完整指南

# GitHub
git clone https://github.com/xuxueli/xxl-job.git
# 或 Gitee（国内更快）
git clone https://gitee.com/xuxueli0323/xxl-job.git

# 1. 数据库连接（必须修改）
spring.datasource.url=jdbc:mysql://your-host:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai&useSSL=false
spring.datasource.username=your-username
spring.datasource.password=your-password
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 2. AccessToken（生产环境必须修改为复杂随机字符串）
xxl.job.accessToken=your-production-token
# 3. 可选：日志保留天数
xxl.job.logretentiondays=30
# 4. 可选：线程池大小
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

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

# 调度中心地址（集群用逗号分隔多个）
xxl.job.admin.addresses=http://localhost:8080/xxl-job-admin
# 执行器名称（唯一标识）
xxl.job.executor.appname=xxl-job-executor-demo
# 执行器端口（默认9999，生产建议修改）
xxl.job.executor.port=9999
# AccessToken（必须与调度中心一致）
xxl.job.accessToken=your-production-token
# 日志路径
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
# 日志保留天数
xxl.job.executor.logretentiondays=30

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
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.executor.appname}")
    private String appname;
    @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
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor executor = new XxlJobSpringExecutor();
        executor.setAdminAddresses(adminAddresses);
        executor.setAppname(appname);
        executor.setPort(port);
        executor.setAccessToken(accessToken);
        executor.setLogPath(logPath);
        executor.setLogRetentionDays(logRetentionDays);
        return executor;
    }
}

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

@Component
public class SampleXxlJob {
    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);

    /**
     * 简单任务示例
     * 注解中的 "demoJobHandler" 是任务标识，在调度中心配置时需要用到
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");

        // 获取任务参数（在调度中心配置时填写）
        String jobParam = XxlJobHelper.getJobParam();
        XxlJobHelper.log("任务参数: {}", jobParam);

        for (int i = 0; i < 5; i++) {
            XxlJobHelper.log("beat at: {}", i);
            Thread.sleep(2000);
        }
        // 默认返回 SUCCESS
    }
}

import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;

@Component
public class ShardingJob {

    @XxlJob("shardingJobHandler")
    public void shardingJobHandler() throws Exception {
        // 获取分片参数
        int shardIndex = XxlJobHelper.getShardIndex();   // 当前分片序号（从0开始）
        int shardTotal = XxlJobHelper.getShardTotal();   // 总分片数

        XxlJobHelper.log("分片参数：当前分片序号 = {}, 总分片数 = {}", shardIndex, shardTotal);

        // 业务逻辑：根据分片参数查询数据
        // 例如：从数据库查询 order_id % shardTotal == shardIndex 的数据
        // 每个节点只处理自己分片的数据，避免重复处理
        for (int i = 0; i < shardTotal; i++) {
            if (i == shardIndex) {
                XxlJobHelper.log("第 {} 片，命中分片开始处理", i);
                // 执行具体业务逻辑...
            } else {
                XxlJobHelper.log("第 {} 片，忽略", i);
            }
        }
    }
}