xxl-job使用详解（包含部分踩坑信息）

概念

XXL-JOB 是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。

分布式下，每个服务都可以搭建为集群，这样的好处是可以将任务切片分给每一个服务从而实现并行执行，提高任务调度的处理效率。

在集群服务下，如果还是使用每台机器按照单体系统的任务调度实现方式实现的话，会出现下面这四个问题：

1. 怎么做到对任务的控制（如何避免任务重复执行）。

2. 如果某台机器宕机了，会不会存在任务丢失。

3. 如果要增加服务实例，怎么做到弹性扩容。

4. 如何做到对任务调度的执行情况统一监测。

源码在gitee提供下载，请自行搜索。

简单来讲就是更好的管理定时任务，方便定时任务的使用降低bug率（个人理解）。

使用

本文结合spring cloud，nacos，分布式集群下使用。

依赖：

因为我是直接结合项目使用，所以直接引入依赖包使用

        
        
            com.xuxueli
            xxl-job-core
            2.3.0
        

nacos配置：

仅展示xxl-job配置

# xxl-job配置
xxl:
  job:
    admin:
      addresses: http://10.135.48.134:10081/xxl-job-admin
    accessToken: default_token
    #    accessToken:
    executor:
      address:
      appname: xxl-job-dynamic-dev
      ip: 
      port: 9998
      logpath: xxl-job/jobhandler
      logretentiondays: 30  

addresses为你的xxl-job地址，可本地搭建测试。

accessToken必填否则会出现拒绝连接，我这边是写死的所以直接引入就行，报错信息如下图所示。

 appname必须对应。

port找一个未被占用的端口使用即可。

至此naocs中配置完毕。

java代码

XxlJobConfig配置，可直接复制。

@Slf4j
@ConditionalOnProperty(value = "xxl.job.admin.addresses")
@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(">>>>>>>>>>> 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;
    }
}

JobHandler放置所有定时任务，可复制。 

@Slf4j
@Component
public class JobHandler {

    final static String KEY = ",";
    @Autowired
    ProductCalendarService service;

    @Autowired
    ProductHourCountService productCountService;

    @Autowired
    ProductHourService productHourService;
    @Autowired
    ProductHourMapper productHourMapper;
    @Autowired
    ProductWorkInfoService productWorkInfoService;
    @Autowired
    ProductRhythmService productRhythmService;

    /**
     * 分片广播任务
     */
    @XxlJob("shardingJobHandler")
    public void shardingJobHandler() {
        // 分片参数
        int shardIndex = XxlJobHelper.getShardIndex();
        int shardTotal = XxlJobHelper.getShardTotal();

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

        // 业务逻辑
        for (int i = 0; i < shardTotal; i++) {
            if (i == shardIndex) {
                XxlJobHelper.log("第 {} 片, 命中分片开始处理", i);
            } else {
                XxlJobHelper.log("第 {} 片, 忽略", i);
            }
        }
    }

    @XxlJob("extractJobHandler")
    public void extractJobHandler() {
        XxlJobHelper.log("生产日历处理开始！");
        service.extract(DateUtil.date());
        XxlJobHelper.log("生产日历处理结束！");
    }

}

@XxlJob()为定时任务方法名下面在xxl-job中配置会使用。

至此java中配置完成。 

xxl-job配置

进入页面后点击执行器管理

新增执行器，AppName必须与nacos中appname对应否则找不到相应配置。

注册方式选择自动注册即可。

新增完成后点击任务管理，选择到刚刚新建的执行器下点击新增

JobHandler对应java代码中@XxlJob()的名称。

新增完成后启动该任务即可进行测试。

至此，结束。

手动注册会出现以下问题

 该问题为执行器中机器地址未填写http://加上即可。