XXL-JOB分布式任务调度框架探究-京东云开发者社区

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

# 2 为什么要使用XXL-JOB
## 2.1 现状
在Java中，传统的定时任务实现方案，比如Timer，Quartz等都或多或少存在一些问题：
- 不支持集群、不支持统计、没有管理平台、没有失败告警、没有监控等等；

显然传统的定时任务已经不满足现在的分布式架构，所以需要一个分布式任务调度平台。

## 2.2 XXL-JOB 优点

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

## 2.3 缺点
- 强依赖于时钟同步；

# 3 项目入手
## 3.1 架构图

![](//img1.jcloudcs.com/developer.jdcloud.com/57a599f3-386a-48ee-9a30-86085b9b268a20221205162826.png)

包含调度中心和执行器两大模块。
- 调度中心：负责管理调度信息，按照调度配置发出调度请求，自身不承担业务代码；
- 执行器：负责接收调度中的请求并执行任务逻辑；

# 3.2 后端管理界面
地址：http://localhost:8080/xxl-job-admin  
账号：admin  123456

### 3.2.1 运行报表
可查看任务数量、调度次数、执行器数量，以及调度成功率。

![](//img1.jcloudcs.com/developer.jdcloud.com/a29982f4-9899-435e-95dc-d7a66c330fb320221205162903.png)

### 3.2.2 任务管理
支持查询、新增、修改、删除任务，查询任务周期性执行时间，也可随时单独执行任务。

![](//img1.jcloudcs.com/developer.jdcloud.com/1fcfedb8-f56e-45a3-93b3-b74c0e5cf19920221205162952.png)

![](//img1.jcloudcs.com/developer.jdcloud.com/196a1ee8-d2bd-47b3-9bbd-e2af9a9d8af220221205163000.png)

配置解释：
1.基础配置
- 执行器：任务绑定的执行器，任务触发调度时会自动发现注册成功的执行器，并按照执行策略去执行任务；
- 任务描述：任务的描述信息，便于后期任务管理；
- 负责人：任务的负责人；
- 报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；

2.触发配置
- 调度类型：
无：该类型不会主动触发调度；
CRON：该类型将会通过CRON，触发任务调度；
固定速度：该类型将会以固定速度，触发任务调度；按照固定的间隔时间，周期性触发；
- CRON：
触发任务执行的Cron表达式；
固定速度：固件速度的时间间隔，单位为秒；

3.任务配置
- 运行模式：
BEAN模式：任务以JobHandler方式维护在执行器端；此时写 @XxlJob注解中的值；
GLUE模式(Java)：任务以源码方式维护在调度中心；调度时将在执行器项目中运行；
可以使用@Resource和@Autowired注入执行器里中的其他服务；
GLUE模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “shell” 脚本；
GLUE模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “python” 脚本；
GLUE模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “PowerShell” 脚本；
- JobHandler：运行模式为 “BEAN模式” 时生效，对应执行器中JobHandler类“@XxlJob”注解中的value值；
- 执行参数：任务执行所需的参数；

4.高级配置
- 路由策略：当执行器集群部署时，提供丰富的路由策略，其中包括：
FIRST（第一个）：固定选择第一个机器；
LAST（最后一个）：固定选择最后一个机器；
ROUND（轮询）：各个机器轮流执行；
RANDOM（随机）：随机选择在线的机器；
CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上；
LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举；
FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；

- 子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。
- 调度过期策略：
忽略：调度过期后，忽略过期的任务，从当前时间开始重新计算下次触发时间；
立即执行一次：调度过期后，立即执行一次，并从当前时间开始重新计算下次触发时间；
- 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
- 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
- 失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

### 3.2.3 调度日志
支持查看任务调度策略、任务调度时间、执行耗时、任务执行机器，以及实时返回执行日志。

![](//img1.jcloudcs.com/developer.jdcloud.com/7974fea0-518e-4fd1-91fb-bc7d0446fd6820221205163337.png)

![](//img1.jcloudcs.com/developer.jdcloud.com/a520b1a4-191b-4908-8e58-ea719a663e4f20221205163346.png)

日志回传方法：

```java
XxlJobHelper.log("XXL-JOB, Hello World.");
```

### 3.2.4 执行器管理
可查看注册节点，也支持手动添加注册执行器节点。

![](//img1.jcloudcs.com/developer.jdcloud.com/377ec23b-8b99-4dc3-8948-b772c076259a20221205163431.png)

![](//img1.jcloudcs.com/developer.jdcloud.com/55f0d4b7-8460-484f-948c-7ccedd53ed6520221205163439.png)

### 3.2.5 用户管理
支持添加普通用户，并可对普通用户分配执行器的执行权限。

![](//img1.jcloudcs.com/developer.jdcloud.com/b8a1dca4-11e0-4910-aeed-437d09b68ac620221205163511.png)

![](//img1.jcloudcs.com/developer.jdcloud.com/ace2738f-7ca0-4e9c-b409-d312e03233d320221205163521.png)

## 3.3 代码分析
### 3.2.1 结构
- xxl-job-admin：调度中心
- xxl-job-core：公共依赖
- xxl-job-executor-samples：执行器Sample示例
xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器（推荐）；
xxl-job-executor-sample-frameless：无框架版本；

### 3.3.2 执行器配置
执行器 JAR 包引入：

```html

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.0-SNAPSHOT</version>
</dependency>
```

配置文件：application.properties

```
# web port
server.port=8081
# no web
#spring.main.web-environment=false

# log config
logging.config=classpath:logback.xml

### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

### xxl-job, access token
xxl.job.accessToken=default_token

### xxl-job executor appname
xxl.job.executor.appname=xxl-job-executor-sample
### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null
xxl.job.executor.address=
### xxl-job executor server-info
xxl.job.executor.ip=
xxl.job.executor.port=9999
### xxl-job executor log-path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30

```

配置初始化：

```java
@Configuration
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.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 xxlJobExecutor() {
        logger.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.3 执行器调用

```java
    /**
     * 1、简单任务示例（Bean模式）
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");

for (int i = 0; i < 5; i++) {
            XxlJobHelper.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
        // default success
    }
```

## 3.4 原理
### 3.4.1 执行器注册
- 主动：执行器启动时将自己注册到调度中心，并保存在数据库（xxl_job_registry表），然后每隔30S定时发送心跳，保持续约。若执行器正常关闭，也主动告知调度中心注销；
- 被动：调度中心每隔90S对没有及时续约的执行器做下线操作；

### 3.4.2 调度中心和任务执行
- JobRegistryHelper 不停的更新注册表，把超时的执行器剔除（每隔30s扫描一次，超出90S即剔除）；
创建线程池
调度器线程ScheduleThread：计算预读取的任务数（默认6000），然后while 循环不停的获取到期的任务
时间轮线程池
- 获取任务锁：第一步获取数据库排它锁，如果没有成功说明其他的调度中心在加载任务；
- 查询任务：获取锁后，查询任务；
- 调度任务；
- 任务触发，选择执行器：按照配置的路由策略，不通路由策略获取方式也不一样；
- 远程执行：拿到执行器之后，runExecutor 触发远程的执行器；
- 执行器处理远程调用，回调管理端；

# 4 总结
本篇文章只是对XXL-JOB的架构、优缺点、使用方法等做了简单介绍，后面有机会再分享下XXL-JOB的核心源码。

—— 百舸争流，力争上游。

------------
自猿其说Tech-JDL京东物流技术与数据智能部
**作者：李世洪**