分布式定时任务之XXL-JOB的配置使用

XXL-JOB概述

XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。

GitHub: https://github.com/xuxueli/xxl-job

文档地址： https://www.xuxueli.com/xxl-job/

XXL-JOB快速入门

1.配置部署“调度中心”

作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。

参照文档部署: xxl-job-admin作为“调度中心”，这里使用Docker部署。

1.初始化调度数据库

访问：https://github.com/xuxueli/xxl-job获取调度数据库初始化SQL脚本

/xxl-job/doc/db/tables_xxl_job.sql

2.启动参数配置

1.连接服务器数据库

docker pull xuxueli/xxl-job-admin:2.3.1

docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://112.74.96.150:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai --spring.datasource.username=root --spring.datasource.password=123456"  -e JAVA_OPTS="-Xmx512m"  -p 8080:8080 -v /usr/local/program/:/data/applogs --name xxl-job-admin  -d xuxueli/xxl-job-admin:2.3.1

2.连接MySQL容器

# name和id是源容器的name和id，alias是源容器在link下的别名

--link <name or id>:alias

--link mysql-container-name:mysql

docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://mysql:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai --spring.datasource.username=root --spring.datasource.password=123456"  -e JAVA_OPTS="-Xmx512m"  -p 8080:8080 -v /usr/local/program/:/data/applogs --name xxl-job-admin  -d --link mysql-container-name:mysql xuxueli/xxl-job-admin:2.3.1

3.访问

调度中心访问地址：http://localhost:8080/xxl-job-admin

默认登录账号 “admin/123456”

2.创建执行器项目

作用：负责接收“调度中心”的调度并执行

将xxl-job-core安装到本地后引入该maven依赖，或引入中央仓库中的坐标地址

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        
        <dependency>
            <groupId>com.xuxueli</groupId>
            <artifactId>xxl-job-core</artifactId>
            <version>2.3.1-SNAPSHOT</version>
        </dependency>

3.配置执行器项目

server.port=9001

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

4.配置执行器组件

@Configuration
public class MyJobConfig {
   
   

    private Logger logger = LoggerFactory.getLogger(MyJobConfig.class);

    @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 myJobExecutor() {
   
   
        logger.info("config init start .....");
        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);
        logger.info("config init end .....");
        return xxlJobSpringExecutor;
    }
}

5.开发Job方法

1、注解配置：为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")"，注解value值对应的是调度中心新建任务的JobHandler属性的值。

2、执行日志：需要通过 "XxlJobHelper.log" 打印执行日志；

3、任务结果：默认任务结果为 "成功" 状态，不需要主动设置；如有诉求，比如设置任务结果为失败，可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果；

@Component
public class MyJobHandler {