分布式任务调度平台XXL-JOB介绍及基本使用

分布式任务调度平台XXL-JOB介绍及基本使用

一、简介

在日常开发的需求中，常常会有需要定时执行的任务，如数据库备份，一定时间内的数据统计等。在Java开发中，有一个Quartz框架可以帮助我们开发定时任务，但今天介绍的 XXL-JOB 相比之下学习成本低，功能强大，开箱即用，代码侵入性小，官方的教程写的十分详细，能够快速上手，本文的主要目的是介绍 xxl-job 的基本使用与开发流程介绍，不深入探究原理流程。

XXL-JOB 是一个分布式任务平台，由许雪里开创的XXL开源社区推出，拥有高效、灵活、易用等特点。

XXL-JOB 提供了调度中心管理页面，调度中心提供了运行报表、任务管理、调度日志、执行器管理等功能供我们管理任务调度。

除上述外，XXL-JOB还提供了大量分布式架构中的相关功能，如调度过期策略、阻塞处理策略、任务超时控制、任务失败重试等等，具体可以到官网查看，官网是最好的教程，官方文档地址：https://www.xuxueli.com/xxl-job/

二、搭建 XXL-JOB 平台

下载源码：https://gitee.com/xuxueli0323/xxl-job

项目结构：

|_doc：项目文档，包含数据库初始化 sql 和架构图等
|_xxl-job-admin：调度中心
|_xxl-job-core：公共依赖
|_xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
    |__xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；
    |__xxl-job-executor-sample-frameless：无框架版本；

2.1 部署调度中心

• 首先初始化数据库，在MySQL中创建名为 xxl_job 的数据库，执行 ./doc/db/tables_xxl_job.sql 文件
• 其次修改 xxl-job-admin 项目的配置文件 ./xxl-job-admin/src/main/resources/application.properties 将数据库配置改成自己本地即可。
• 最后启动调度中心项目，访问项目地址：http://localhost:8080/xxl-job-admin/，默认账户：admin + 123456
• 后续部署时可以直接将项目进行打包，然后部署到服务器上

XXL-JOB调度中心控制面板

2.2 配置执行器及任务项目

以 springboot 版本为基础展开

2.2.1 修改执行器项目配置文件

./xxl-job-executor-sample-springboot/src/main/resources/application.properties 中配置执行器的相关参数。

### 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=
### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
### 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
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

2.2.2 编写执行器配置类

./xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java，示例项目中已提供。

@Configuration
public class XxlJobConfig {
   
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);

    @Value("${xxl.job.admin.addresses}")
    private String adminAddresses;

    @Value("${xxl.job.accessToken}"