超越任务调度的极致：初探分布式定时任务 XXL-JOB 分片广播

news2025/1/11 7:09:17

XXL-JOB 是一个分布式任务调度平台，支持分片任务执行。

1. 依赖引入

在项目中引入 XXL-JOB 的相关依赖。通常，你需要在项目的 pom.xml 文件中添加如下依赖：

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

2. 任务类编写

编写需要调度的任务类，并使用 @XxlJob 注解标记需要执行的方法。
在需要分片的方法上使用 @XxlJob 注解，并添加 @XxlJob(value = "yourJobHandler", distributedJob = true) 注解配置分片任务。

import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;

public class MyJobHandler {

    @XxlJob(value = "yourJobHandler", distributedJob = true)
    public void execute() {
        // 获取分片参数
        int shardIndex = XxlJobHelper.getShardIndex();
        int shardTotal = XxlJobHelper.getShardTotal();

        // 根据分片参数执行相应的逻辑
        // ...

        // 任务执行完成后，如果有分片任务，需调用该方法告知调度中心当前分片任务已完成
        XxlJobHelper.handleShardResult("分片任务执行完成");
    }
}

3. JobHandler注册

在Spring Boot 项目中，需要注册 JobHandler 到 Spring 容器。可以使用 @Component 或者配置文件来完成注册。

import com.xxl.job.core.executor.XxlJobExecutor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class XxlJobConfig {

    @Bean
    public XxlJobExecutor xxlJobExecutor() {
        XxlJobExecutor xxlJobExecutor = new XxlJobExecutor();
        xxlJobExecutor.setAdminAddresses("http://your-admin-address");
        xxlJobExecutor.setAppName("your-app-name");
        xxlJobExecutor.setIp("your-ip");
        xxlJobExecutor.setPort(9999);
        xxlJobExecutor.setAccessToken("your-access-token");
        xxlJobExecutor.setLogPath("your-log-path");
        xxlJobExecutor.setLogRetentionDays(7);

        return xxlJobExecutor;
    }
}