XXL-JOB（分布式任务调度）|Takagi

概述

XXL-JOB是一个轻量级的分布式任务调度平台，使用较为方便且下载后立即可以使用，非常方便。由于目前公司项目涉及到分布式，因此选择接入XXL-JOB来进行作业调度。

注：本文基于XXL-JOB-2.2.1-SNAPSHOT 版本，2.2.x版本较之前版本有很大区别，需要注意的是以下几点。

调度中心升级至SpringBoot2.x版本，因此系统要求JDK1.8+

完全移除旧版注解 JobHandler，目前使用基于方法的 xxlJob

特性

实际上，由于XXL-JOB本身为国人开发，因此教程非常直观，本来不打算过多介绍，但由于我使用的时候恰好网站崩了，所以还是写一篇教程来记录一下。以下特性也为官方说明。

1、简单：支持通过Web页面对任务进行CRUD操作，操作简单，一分钟上手；
2、动态：支持动态修改任务状态、启动/停止任务，以及终止运行中任务，即时生效；
3、调度中心HA（中心式）：调度采用中心式设计，“调度中心”自研调度组件并支持集群部署，可保证调度中心HA；
4、执行器HA（分布式）：任务分布式执行，任务"执行器"支持集群部署，可保证任务执行HA；
5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时，也支持手动录入执行器地址；
6、弹性扩容缩容：一旦有新执行器机器上线或者下线，下次调度时将会重新分配任务；
7、路由策略：执行器集群部署时提供丰富的路由策略，包括：第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等；
8、故障转移：任务路由策略选择"故障转移"情况下，如果执行器集群中某一台机器故障，将会自动Failover切换到一台正常的执行器发送调度请求。
9、阻塞处理策略：调度过于密集执行器来不及处理时的处理策略，策略包括：单机串行（默认）、丢弃后续调度、覆盖之前调度；
10、任务超时控制：支持自定义任务超时时间，任务运行超时将会主动中断任务；
11、任务失败重试：支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；其中分片任务支持分片粒度的失败重试；
12、任务失败告警；默认提供邮件方式失败告警，同时预留扩展接口，可方便的扩展短信、钉钉等告警方式；
13、分片广播任务：执行器集群部署时，任务路由策略选择"分片广播"情况下，一次任务调度将会广播触发集群中所有执行器执行一次任务，可根据分片参数开发分片任务；
14、动态分片：分片广播任务以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度。
15、事件触发：除了"Cron方式"和"任务依赖方式"触发任务执行之外，支持基于事件的触发任务方式。调度中心提供触发任务单次执行的API服务，可根据业务事件灵活触发。
16、任务进度监控：支持实时监控任务进度；
17、Rolling实时日志：支持在线查看调度结果，并且支持以Rolling方式实时查看执行器输出的完整的执行日志；
18、GLUE：提供Web IDE，支持在线开发任务逻辑代码，动态发布，实时编译生效，省略部署上线的过程。支持30个版本的历史版本回溯。
19、脚本任务：支持以GLUE模式开发和运行脚本任务，包括Shell、Python、NodeJS、PHP、PowerShell等类型脚本;
20、命令行任务：原生提供通用命令行任务Handler（Bean任务，"CommandJobHandler"）；业务方只需要提供命令行即可；
21、任务依赖：支持配置子任务依赖，当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔；
22、一致性：“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行；
23、自定义任务参数：支持在线配置调度任务入参，即时生效；
24、调度线程池：调度系统多线程触发调度运行，确保调度精确执行，不被堵塞；
25、数据加密：调度中心和执行器之间的通讯进行数据加密，提升调度信息安全性；
26、邮件报警：任务失败时支持邮件报警，支持配置多邮件地址群发报警邮件；
27、推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用;
28、运行报表：支持实时查看运行数据，如任务数量、调度次数、执行器数量等；以及调度报表，如调度日期分布图，调度成功分布图等；
29、全异步：任务调度流程全异步化设计实现，如异步调度、异步运行、异步回调等，有效对密集调度进行流量削峰，理论上支持任意时长任务的运行；
30、跨语言：调度中心与执行器提供语言无关的 RESTful API 服务，第三方任意语言可据此对接调度中心或者实现执行器。除此之外，还提供了 “多任务模式”和“httpJobHandler”等其他跨语言方案；
31、国际化：调度中心支持国际化设置，提供中文、英文两种可选语言，默认为中文；
32、容器化：提供官方docker镜像，并实时更新推送dockerhub，进一步实现产品开箱即用；
33、线程池隔离：调度线程池进行隔离拆分，慢任务自动降级进入"Slow"线程池，避免耗尽调度线程，提高系统稳定性；
34、用户管理：支持在线管理系统用户，存在管理员、普通用户两种角色；
35、权限控制：执行器维度进行权限控制，管理员拥有全量权限，普通用户需要分配执行器权限后才允许相关操作；

快速入门

本项目是一个Maven项目，因此下载之后，使用IDE打开，利用maven编译即可。

1、源码地址

git地址：https://github.com/xuxueli/xxl-job
码云地址（国内推荐）：https://gitee.com/xuxueli0323/xxl-job

2、文档地址

中文文档：http://www.xuxueli.com/xxl-job/#/
英文文档：http://www.xuxueli.com/xxl-job/en/#/

从git/码云上克隆项目到本地，使用maven编译即可。

3、源码结构

4、初始化数据库

目前XXL-JOB支持MySQL数据库，初始化SQL脚本在源目录 /doc/db/tables_xxl_job.sql 下。会生成8张数据库表。

5、部署调度中心

调度中心为源码中的 xxl-job-admin 工程，该工程可以让我们以图形化的方式统一管理调度任务。

①、调度中心配置

调度中心的配置文件地址：xxl-job-admin/src/main/resources/application.properties

### web 调度中心项目的访问端口与路径
server.port=8080
server.servlet.context-path=/xxl-job-admin

### actuator 健康端点路径，默认不开启
management.server.servlet.context-path=/actuator
management.health.mail.enabled=false

### resources 静态资源配置
spring.mvc.servlet.load-on-startup=0
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/

### freemarker 模板文件配置
spring.freemarker.templateLoaderPath=classpath:/templates/
spring.freemarker.suffix=.ftl
spring.freemarker.charset=UTF-8
spring.freemarker.request-context-attribute=request
spring.freemarker.settings.number_format=0.##########

### mybatis 配置mybatis的mapper路径
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
#mybatis.type-aliases-package=com.xxl.job.admin.core.model

### xxl-job, datasource 数据库配置
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root
### 当前driver-class为5.7+的数据源，如果为5.7-修改为com.mysql.jdbc.Driver
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

### datasource-pool 连接池配置
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.maximum-pool-size=30
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.max-lifetime=900000
spring.datasource.hikari.connection-timeout=10000
spring.datasource.hikari.connection-test-query=SELECT 1

### xxl-job, email 配置报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.from=xxx@qq.com
spring.mail.password=
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

### xxl-job, access token token，用于与执行器加密交互数据
xxl.job.accessToken=

### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
xxl.job.i18n=zh_CN

## xxl-job, triggerpool max size
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

### xxl-job, log retention days
xxl.job.logretentiondays=30

当前配置文件一般来说，只需要修改第25行的数据库配置。以及第43行的报警邮箱即可。

②、部署调度中心

调度中心项目为一个 SpringBoot 项目，因此只需要在设置好配置文件后，直接运行 XxlJobAdminApplication 即可。

③、访问调度中心

在浏览器中输入 http://127.0.0.1:8080/xxl-job-admin，然后输入默认用户名和密码（admin/123456），即可进入管理页面

④、调度中心的集群实现（可选）

按照官方的说明，想要实现调度中心的集群部署，需要有以下几点

DB配置一样
登录账号一样
集群机器时钟保持一致

建议采用Nginx为调度中心集群做负载均衡，分配域名。
调度中心访问、执行器回调配置、调用API服务等操作均通过该域名进行。

由于连接的为同一个数据库，因此不会产生重复执行的问题。集群中采用谁先启动谁为主的方式。

6、部署执行器项目

项目中有各种版本的执行器项目，本文中采用 SpringBoot 版本的执行器。对应执行器为源码中的 xxl-job-executor-sample-springboot 工程。
执行器可以使用默认的，也可以使用已有的项目作为执行器。默认的直接启动即可，没什么难度，因而本文采用新的 SpringBoot 项目来创建一个执行器，也可以用已经存在的项目按以下步骤改成一个执行器。

①、创建一个新的SpringBoot项目（略）

②、添加Maven依赖

在新创建好的SpringBoot项目的pom.xml里加入xxl-job的公共依赖

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

③、配置执行器

当前新建的SpringBoot项目采用yml作为配置文件，因此需要在 application.yml 中添加如下配置

server:
  #项目端口号
  port: 8081
logging:
  #日志文件
  config: classpath:logback.xml

xxl:
  job:
    admin:
      #调度中心部署跟地址：如调度中心集群部署存在多个地址则用逗号分隔。
      #执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"。
      addresses: http://127.0.0.1:8080/xxl-job-admin

    #分别配置执行器的名称、ip地址、端口号
    #注意：如果配置多个执行器时，防止端口冲突
    executor:
      appname: demo
      ip: 127.0.0.1
      address:
      port: 9999
      #执行器运行日志文件存储的磁盘位置，需要对该路径拥有读写权限
      logpath: /data/applogs/xxl-job/jobhandler
      #执行器Log文件定期清理功能，指定日志保存天数，日志文件过期自动删除。限制至少保持3天，否则功能不生效；
      #-1表示永不删除
      logretentiondays: -1
    accessToken:

④、载入配置文件

在示例的SpringBoot项目中，找到 xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java ，将 XxlJobConfig.java 复制到自己的项目中，如下图

⑤、创建任务

在目前我所使用的2.2.1版本，已经抛弃原有的JobHandler注解，推荐使用基于方法的 xxlJob 注解。

package com.example.demo.jobhandler;

import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import com.xxl.job.core.log.XxlJobLogger;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

import java.util.concurrent.TimeUnit;

/**
 * 任务示例（Bean模式）
 *
 * 开发步骤：
 * 1、在Spring Bean实例中，开发Job方法，方式格式要求为 "public ReturnT<String> execute(String param)"
 * 2、为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")"，注解value值对应的是调度中心新建任务的JobHandler属性的值。
 * 3、执行日志：需要通过 "XxlJobLogger.log" 打印执行日志；
 */
@Component
public class JobHandlerDemo {
    private static Logger logger = LoggerFactory.getLogger(JobHandlerDemo.class);

    /**
     * 简单任务示例（Bean模式）
     */
    @XxlJob("demoJobHandler")
    public ReturnT<String> demoJobHandler(String param) throws Exception {
        XxlJobLogger.log("XXL-JOB, Hello World.");

        for (int i = 0; i < 5; i++) {
            XxlJobLogger.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
        return ReturnT.SUCCESS;
    }
}

当前的XxlJob注解有一个value： demoJobHandler 这个值会在调度中心的可视化界面中进行配置。

⑥、执行器项目集群（可选）

执行器也支持集群部署，对于执行器也有几点要求和建议。

执行器回调地址（xxl.job.admin.addresses）需要保持一致；执行器根据该配置进行执行器自动注册等操作
同一个执行器集群内AppName（xxl.job.executor.appname）需要保持一致；调度中心根据该配置动态发现不同集群的在线执行器列表

7、在调度中心中配置执行器

调度中心在第 5 步中已经配置完成，直接启动即可。执行器也已经在第 6 步中配置完成，直接启动即可。目前都启动一个就行。

①、配置执行器

点击执行器管理 -> 新增，弹出如下界面

参数介绍：
AppName：对于每个执行器集群的唯一标识AppName，执行器会周期性以AppName通过心跳的方式为对象进行自动注册。
名称：执行器的名称，为了方便阅读
注册方式：调度中心获取执行器集群地址的方式
自动注册：执行器周期性的自动进行注册，调度中心通过底层注册表可以动态发现执行器的地址
手动录入：人工手动录入执行器的地址，多个地址之间用英文逗号（,）分隔
机器地址：“注册方式”为“手动录入”时可填，支持人工维护执行器的地址信息

②、创建调度任务

点击任务管理 -> 新增，弹出如下界面

参数介绍：
执行器：任务绑定的执行器。每个任务必须绑定一个执行器。
路由策略：当执行器集群部署时，提供丰富的路由策略
FIRST（第一个）：固定选择第一个机器；
LAST（最后一个）：固定选择最后一个机器；
ROUND（轮询）
RANDOM（随机）：随机选择在线的机器；
CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上；
LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
LEAST_RECENTLY_USED（最近最久未使用）：最久为使用的机器优先被选举；
FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；
运行模式：
BEAN模式：任务以JobHandler方式维护在执行器端；需要结合 "JobHandler" 属性匹配执行器中任务；
GLUE模式(Java)：任务以源码方式维护在调度中心；该模式的任务实际上是一段继承自IJobHandler的Java类代码并 "groovy" 源码方式维护，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里中的其他服务；
GLUE模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "shell" 脚本；
GLUE模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "python" 脚本；
GLUE模式(PHP)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "php" 脚本；
GLUE模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "nodejs" 脚本；
GLUE模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "PowerShell" 脚本；
阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
负责人：任务的负责人；
任务参数：任务执行所需的参数，多个参数时用逗号分隔，任务执行时将会把多个参数转换成数组传入；
任务描述：任务的描述信息，便于任务管理；
Cron：触发任务执行的Cron表达式；
JobHandler：运行模式为 "BEAN模式" 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值；
子任务ID：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。