XXL-JOB 分布式任务调度平台

1、下载和部署 XXL-JOB

• 从 Git 上拉取 xxl-job 项目源码：https://gitee.com/xuxueli0323/xxl-job
• 执行源码中提供的数据库初始化脚本：xxl-job/doc/db/tables_xxl_job.sql
• 配置调度中心的数据库、邮件信息等：xxl-job/xxl-job-admin/src/main/resources/application.properties
• 使用 Maven 打包并部署，调度中心访问地址：http://localhost:8080/xxl-job-admin。
• 默认登录账号 admin/123456 , 登录后运行界面如下图所示：
  

2、集成 XXL-JOB

2.1、引入 xxl-job-core 依赖

版本号需要和上一步拉取的项目版本一致

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

2.2、XXL-JOB 相关配置

xxl.job.accessToken 的默认值是 default_token（你可以在调度器的配置文件中修改）

properties 格式

### 调度中心地址（如集群部署存在多个地址则用逗号分隔）执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN
xxl.job.accessToken=default_token
### 执行器AppName
xxl.job.executor.appname=xxl-job-executor-blulibrary
### 执行器注册：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。
xxl.job.executor.address=
### 执行器IP：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
xxl.job.executor.ip=
### 执行器端口号：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
xxl.job.executor.port=9999
### 执行器运行日志文件存储磁盘路径 ：需要对该路径拥有读写权限；为空则使用默认路径；
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
xxl.job.executor.logretentiondays=30

yaml 格式：

xxl:
  job:
    admin:
      addresses: http://127.0.0.1:8080/xxl-job-admin
    accessToken: default_token
    executor:
      appname: xxl-job-executor-blulibrary
      address:
      ip:
      port: 9999
      logpath: /data/applogs/xxl-job/jobhandler
      logretentiondays: 30

2.3、定义执行器组件 Bean

package com.blu.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(">>>>>>>>>>> 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;
    }

}

3、创建分布式定时任务

3.1、执行器中使用 @XxlJob 注解定义Job方法

@Slf4j
@Controller
public class BluJobController {

    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        log.info("XXL-JOB, Hello BLU.");
    }

}

3.2、定义执行器

这里的 AppName就是 2.2、XXL-JOB 相关配置 节中配置的 xxl.job.executor.appname

3.3、注册任务

这里的 JobHandler 就是 3.1 中 @XxlJob 注解的 value 值