XXL-JOB定时任务知识点和应用实例

一、XXL-JOB简介

1. 简介：

XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。该处只是介绍xxl_job的一下基础知识和使用的实例，具体的安装调试请参照对应的最新的官方文档，中文开源地址：https://www.xuxueli.com/xxl-job

建议使用的环境：

• Maven3+
• Jdk1.8+
• Mysql5.7+

当前介绍的xxl_job版本如下：

<!-- https://mvnrepository.com/artifact/com.xuxueli/xxl-job-core -->

<dependency>

   <groupId>com.xuxueli</groupId>

   <artifactId>xxl-job-core</artifactId>

   <version>2.1.0</version>

</dependency>

2. 选项特点：

与Quartz相比，Quartz作为开源作业调度中的佼佼者，是作业调度的首选。但是集群环境中Quartz采用API的方式对任务进行管理，从而可以避免上述问题，但是同样存在以下问题：

问题一：调用API的的方式操作任务，不人性化；

问题二：需要持久化业务QuartzJobBean到底层数据表中，系统侵入性相当严重。

问题三：调度逻辑和QuartzJobBean耦合在同一个项目中，这将导致一个问题，在调度任务数量逐渐增多，同时调度任务逻辑逐渐加重的情况下，此时调度系统的性能将大大受限于业务；

问题四：quartz底层以“抢占式”获取DB锁并由抢占成功节点负责运行任务，会导致节点负载悬殊非常大；而XXL-JOB通过执行器实现“协同分配式”运行任务，充分发挥集群优势，负载各节点均衡。XXL-JOB弥补了quartz的上述不足之处。

以前的项目中就使用过Quartz，相对来说Quartz的使用对初学者不太友好，底层用于存储数据的表数量多且关系复杂，初次接触学习和使用中问题定位时相对困难，特别是当时想停止调一个定时任务失败需要更改数据库完成该项操作，那才最痛苦的操作经历，Quartz基于强悍的稳定性和重试功能，基于底层库的操作异常困难，当时因为系统的原因为了取消一个MQ定时推送消息的任务，也因为刚接触Quartz，导致当时一批次的其他定时任务也停滞了，搞得很尴尬。

3. 下载：

源码仓库地址

中央仓库地址

<!-- http://repo1.maven.org/maven2/com/xuxueli/xxl-job-core/ --><!-- 建议使用最新的稳定版本--><dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>2.1.0</version></dependency>

3. 特性：

3.1、简单：支持通过Web页面对任务进行CRUD操作，操作简单，一分钟上手；

3.2、动态：支持动态修改任务状态、启动/停止任务，以及终止运行中任务，即时生效；

3.3、调度中心HA（中心式）：调度采用中心式设计，“调度中心”自研调度组件并支持集群部署，可保证调度中心HA；

3.4、执行器HA（分布式）：任务分布式执行，任务”执行器”支持集群部署，可保证任务执行HA；

3.5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时，也支持手动录入执行器地址；

3.6、弹性扩容缩容：一旦有新执行器机器上线或者下线，下次调度时将会重新分配任务；

3.7、触发策略：提供丰富的任务触发策略，包括：Cron触发、固定间隔触发、固定延时触发、API（事件）触发、人工触发、父子任务触发；

3.8、调度过期策略：调度中心错过调度时间的补偿处理策略，包括：忽略、立即补偿触发一次等；

3.9、阻塞处理策略：调度过于密集执行器来不及处理时的处理策略，策略包括：单机串行（默认）、丢弃后续调度、覆盖之前调度；

3.10、任务超时控制：支持自定义任务超时时间，任务运行超时将会主动中断任务；

3.11、任务失败重试：支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；其中分片任务支持分片粒度的失败重试；

3.12、任务失败告警；默认提供邮件方式失败告警，同时预留扩展接口，可方便的扩展短信、钉钉等告警方式；

3.13、路由策略：执行器集群部署时提供丰富的路由策略，包括：第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等；

3.14、分片广播任务：执行器集群部署时，任务路由策略选择”分片广播”情况下，一次任务调度将会广播触发集群中所有执行器执行一次任务，可根据分片参数开发分片任务；

3.15、动态分片：分片广播任务以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度。

3.16、故障转移：任务路由策略选择”故障转移”情况下，如果执行器集群中某一台机器故障，将会自动Failover切换到一台正常的执行器发送调度请求。

3.17、任务进度监控：支持实时监控任务进度；

3.18、Rolling实时日志：支持在线查看调度结果，并且支持以Rolling方式实时查看执行器输出的完整的执行日志；

3.19、GLUE：提供Web IDE，支持在线开发任务逻辑代码，动态发布，实时编译生效，省略部署上线的过程。支持30个版本的历史版本回溯。

3.20、脚本任务：支持以GLUE模式开发和运行脚本任务，包括Shell、Python、NodeJS、PHP、PowerShell等类型脚本;

3.21、命令行任务：原生提供通用命令行任务Handler（Bean任务，”CommandJobHandler”）；业务方只需要提供命令行即可；

3.22、任务依赖：支持配置子任务依赖，当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔；

3.23、一致性：“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行；

3.24、自定义任务参数：支持在线配置调度任务入参，即时生效；

3.25、调度线程池：调度系统多线程触发调度运行，确保调度精确执行，不被堵塞；

3.26、数据加密：调度中心和执行器之间的通讯进行数据加密，提升调度信息安全性；

3.27、邮件报警：任务失败时支持邮件报警，支持配置多邮件地址群发报警邮件；

3.28、推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用;

3.29、运行报表：支持实时查看运行数据，如任务数量、调度次数、执行器数量等；以及调度报表，如调度日期分布图，调度成功分布图等；

3.30、全异步：任务调度流程全异步化设计实现，如异步调度、异步运行、异步回调等，有效对密集调度进行流量削峰，理论上支持任意时长任务的运行；

3.31、跨语言：调度中心与执行器提供语言无关的 RESTful API 服务，第三方任意语言可据此对接调度中心或者实现执行器。除此之外，还提供了 “多任务模式”和“httpJobHandler”等其他跨语言方案；

3.32、国际化：调度中心支持国际化设置，提供中文、英文两种可选语言，默认为中文；

3.33、容器化：提供官方docker镜像，并实时更新推送dockerhub，进一步实现产品开箱即用；

3.34、线程池隔离：调度线程池进行隔离拆分，慢任务自动降级进入”Slow”线程池，避免耗尽调度线程，提高系统稳定性；

3.35、用户管理：支持在线管理系统用户，存在管理员、普通用户两种角色；

3.36、权限控制：执行器维度进行权限控制，管理员拥有全量权限，普通用户需要分配执行器权限后才允许相关操作；

二、XXL-JOB架构讲解

1. 架构图：

2.系统组成及功能

2.1 调度模块（调度中心）：

负责管理调度信息，按照调度配置发出调度请求，自身不承担业务代码。调度系统与任务解耦，提高了系统可用性和稳定性，同时调度系统性能不再受限于任务模块；当前我们使用的xxl_job是单独部署到其他环境的应用，该环境和我们的应用的业务环境是隔离的（部署到不同的服务器上），调度中心和业务任务完全解耦；

支持可视化、简单且动态的管理调度信息，包括任务新建，更新，删除，GLUE开发和任务报警等，所有上述操作都会实时生效，同时支持监控调度结果以及执行日志，支持执行器Failover（故障转移）。

2.2 执行模块（执行器）：

负责接收调度请求并执行任务逻辑。任务模块专注于任务的执行等操作，开发和维护更加简单和高效；

接收“调度中心”的执行请求、终止请求和日志请求等。执行请求能配置成定时启动和也能手动单次启动，终止请求能通过手动停止。执行的请求执行完成，其实是代码中的调用方法执行完成后返回，如果使用同步方式调用执行方法的逻辑，那就是逻辑执行完成，那定时任务执行完成，如果是异步的执行同步逻辑，如果没有做加限制（例如使用线程池分发、调用执行逻辑，不适用类似CountDownLantch做限制，那就会出现任务提前返回，从而导致任务执行终止。）会导致任务提前返回，执行线程提前终止。

3 调度模块剖析

3.1 自研调度模块

舍弃了早期调度组件基于Quartz的设计，当前 XXL-JOB中“调度模块”和“任务模块”完全解耦，调度模块进行任务调度时，将会解析不同的任务参数发起远程调用，调用各自的远程执行器服务。这种调用模型类似RPC调用，调度中心提供调用代理的功能，而执行器提供远程服务的功能。

3.2 调度中心HA（集群）

基于数据库的集群方案，数据库选用Mysql；集群分布式并发环境中进行定时任务调度时，会在各个节点会上报任务，存到数据库中，执行时会从数据库中取出触发器来执行，如果触发器的名称和执行时间相同，则只有一个节点去执行此任务。

3.3 调度线程池

调度采用线程池方式实现，避免单线程因阻塞而引起任务调度延迟。

3.4 并行调度

XXL-JOB调度模块默认采用并行机制，在多线程调度的情况下，调度模块被阻塞的几率很低，大大提高了调度系统的承载量。XXL-JOB的不同任务之间并行调度、并行执行。XXL-JOB的单个任务，针对多个执行器是并行运行的，针对单个执行器是串行执行的。同时支持任务终止。

3.5 过期处理策略

任务调度错过触发时间时的处理策略：

可能原因：服务重启；调度线程被阻塞，线程被耗尽；上次调度持续阻塞，下次调度被错过；

处理策略：

1）过期超5s：本次忽略，当前时间开始计算下次触发时间；

2）过期5s内：立即触发一次，当前时间开始计算下次触发时间；

3）能设置失败重试功能，定时任务失败后能自动进行任务重试；

3.6 日志回调服务

调度模块的“调度中心”作为Web服务部署时，一方面承担调度中心功能，另一方面也为执行器提供API服务。调度中心提供的”日志回调服务API服务”代码位置如下：xxl-job-admin#com.xxl.job.admin.controller.JobApiController.callback“执行器”在接收到任务执行请求后，执行任务，在执行结束之后会将执行结果回调通知“调度中心”；调度结束之后可以前往控制台（控制页面）查看对应的执行日志。

3.7 任务HA（Failover）

执行器如若集群部署，调度中心将会感知到在线的所有执行器，如“127.0.0.1:9997, 127.0.0.1:9998, 127.0.0.1:9999”。当任务”路由策略”选择”故障转移(FAILOVER)”时，当调度中心每次发起调度请求时，会按照顺序对执行器发出心跳检测请求，第一个检测为存活状态的执行器将会被选定并发送调度请求。

3.8 调度日志及日志信息讲解

调度中心每次进行任务调度，都会记录一条任务日志，任务日志主要包括以下三部分内容：

任务信息：包括“执行器地址”、“JobHandler”和“执行参数”等属性，点击任务ID按钮可查看，根据这些参数，可以精确的定位任务执行的具体机器和任务代码；

调度信息：包括“调度时间”、“调度结果”和“调度日志”等，根据这些参数，可以了解“调度中心”发起调度请求时具体情况。

执行信息：包括“执行时间”、“执行结果”和“执行日志”等，根据这些参数，可以了解在“执行器”端任务执行的具体情况；

调度日志，针对单次调度，属性说明如下：

执行器地址：任务执行的机器地址；

JobHandler：Bean模式表示任务执行的JobHandler名称；

任务参数：任务执行的入参；

调度时间：调度中心，发起调度的时间；

调度结果：调度中心，发起调度的结果，SUCCESS或FAIL；

调度备注：调度中心，发起调度的备注信息，如地址心跳检测日志等；

执行时间：执行器，任务执行结束后回调的时间；

执行结果：执行器，任务执行的结果，SUCCESS或FAIL；

执行备注：执行器，任务执行的备注信息，如异常日志等；

执行日志：任务执行过程中，业务代码中打印的完整执行日志，见“4.8 查看执行日志”；

3.9 任务依赖

原理：XXL-JOB中每个任务都对应有一个任务ID，同时，每个任务支持设置属性“子任务ID”，因此，通过“任务ID”可以匹配任务依赖关系。

当父任务执行结束并且执行成功时，将会根据“子任务ID”匹配子任务依赖，如果匹配到子任务，将会主动触发一次子任务的执行。

在任务日志界面，点击任务的“执行备注”的“查看”按钮，可以看到匹配子任务以及触发子任务执行的日志信息，如无信息则表示未触发子任务执行，可参考下图。

日志信息如下：

3.10 全异步化 & 轻量级

全异步化设计：XXL-JOB系统中业务逻辑在远程执行器执行，触发流程全异步化设计。相比直接在调度中心内部执行业务逻辑，极大的降低了调度线程占用时间；

• 异步调度：调度中心每次任务触发时仅发送一次调度请求，该调度请求首先推送“异步调度队列”，然后异步推送给远程执行器
• 异步执行：执行器会将请求存入“异步执行队列”并且立即响应调度中心，异步运行。

轻量级设计：XXL-JOB调度中心中每个JOB逻辑非常 “轻”，在全异步化的基础上，单个JOB一次运行平均耗时基本在 “10ms” 之内（基本为一次请求的网络开销）；因此，可以保证使用有限的线程支撑大量的JOB并发运行；

得益于上述两点优化，理论上默认配置下的调度中心，单机能够支撑 5000 任务并发运行稳定运行；

实际场景中，由于调度中心与执行器网络ping延迟不同、DB读写耗时不同、任务调度密集程度不同，会导致任务量上限会上下波动。

如若需要支撑更多的任务量，可以通过 “调大调度线程数” 、”降低调度中心与执行器ping延迟” 和 “提升机器配置” 几种方式优化。

3.11 均衡调度

调度中心在集群部署时会自动进行任务平均分配，触发组件每次获取与线程池数量（调度中心支持自定义调度线程池大小）相关数量的任务，避免大量任务集中在单个调度中心集群节点；

4 任务运行模式解析

4.1 当前我们业务开发中使用的Bean模式” 任务
原理：每个Bean模式任务都是一个Spring的Bean类实例，它被维护在“执行器”项目的Spring容器中。任务类需要加“@JobHandler(value=”名称”)”注解，因为“执行器”会根据该注解识别Spring容器中的任务。任务类需要继承统一接口“IJobHandler”，任务逻辑在execute方法中开发，因为“执行器”在接收到调度中心的调度请求时，将会调用“IJobHandler”的execute方法，执行任务逻辑。

其他的还有：“GLUE模式(Java)” 任务，GLUE模式(Shell) + GLUE模式(Python) + GLUE模式(PHP) + GLUE模式(NodeJS) + GLUE模式(Powershell)

4.2 执行器

执行器实际上是一个内嵌的Server，默认端口9999（配置项：xxl.job.executor.port）。

在项目启动时，执行器会通过“@JobHandler”识别Spring容器中“Bean模式任务”，以注解的value属性为key管理起来。“执行器”接收到“调度中心”的调度请求时，如果任务类型为“Bean模式”，将会匹配Spring容器中的“Bean模式任务”，然后调用其execute方法，执行任务逻辑。如果任务类型为“GLUE模式”，将会加载GLue代码，实例化Java对象，注入依赖的Spring服务（注意：Glue代码中注入的Spring服务，必须存在与该“执行器”项目的Spring容器中），然后调用execute方法，执行任务逻辑。

4.3 任务日志

XXL-JOB会为每次调度请求生成一个单独的日志文件，需要通过 “XxlJobHelper.log” 打印执行日志，“调度中心”查看执行日志时将会加载对应的日志文件。

(历史版本通过重写LOG4J的Appender实现，存在依赖限制，该方式在新版本已经被抛弃)

日志文件存放的位置可在“执行器”配置文件进行自定义，默认目录格式为：/data/applogs/xxl-job/jobhandler/“格式化日期”/“数据库调度日志记录的主键ID.log”。

在JobHandler中开启子线程时，子线程将会将会把日志打印在父线程即JobHandler的执行日志中，方便日志追踪。

5 通讯模块剖析

5.1 一次完整的任务调度通讯流程

- 1、“调度中心”向“执行器”发送http调度请求: “执行器”中接收请求的服务，实际上是一台内嵌Server，默认端口9999;

- 2、“执行器”执行任务逻辑；

- 3、“执行器”http回调“调度中心”调度结果: “调度中心”中接收回调的服务，是针对执行器开放一套API服务;

5.2 通讯数据加密

调度中心向执行器发送的调度请求时使用RequestModel和ResponseModel两个对象封装调度请求参数和响应数据, 在进行通讯之前底层会将上述两个对象对象序列化，并进行数据协议以及时间戳检验,从而达到数据加密的功能;

6 任务注册, 任务自动发现

自v1.5版本之后, 任务取消了”任务执行机器”属性, 改为通过任务注册和自动发现的方式, 动态获取远程执行器地址并执行。

AppName: 每个执行器机器集群的唯一标示, 任务注册以 "执行器" 为最小粒度进行注册; 每个任务通过其绑定的执行器可感知对应的执行器机器列表;

注册表: 见"xxl_job_registry"表, "执行器" 在进行任务注册时将会周期性维护一条注册记录，即机器地址和AppName的绑定关系; "调度中心" 从而可以动态感知每个AppName在线的机器列表;

执行器注册: 任务注册Beat周期默认30s; 执行器以一倍Beat进行执行器注册, 调度中心以一倍Beat进行动态任务发现; 注册信息的失效时间为三倍Beat;

执行器注册摘除：执行器销毁时，将会主动上报调度中心并摘除对应的执行器机器信息，提高心跳注册的实时性；

为保证系统”轻量级”并且降低学习部署成本，没有采用Zookeeper作为注册中心，采用DB方式进行任务注册发现；（当前我们使用的只是单机的，使用HTTP调用的方式进行服务调用的）

7 任务执行结果

自v1.6.2之后，任务执行结果通过 “IJobHandler” 的返回值 “ReturnT” 进行判断；
当返回值符合 “ReturnT.code == ReturnT.SUCCESS_CODE” 时表示任务执行成功，否则表示任务执行失败，而且可以通过 “ReturnT.msg” 回调错误信息给调度中心；
从而，在任务逻辑中可以方便的控制任务执行结果；

8 分片广播 & 动态分片

执行器集群部署时，任务路由策略选择”分片广播”情况下，一次任务调度将会广播触发对应集群中所有执行器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；

“分片广播” 以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度。

“分片广播” 和普通任务开发流程一致，不同之处在于可以获取分片参数，获取分片参数进行分片业务处理。

• Java语言任务获取分片参数方式：BEAN、GLUE模式(Java)

// 可参考Sample示例执行器中的示例任务"ShardingJobHandler"了解试用

int shardIndex = XxlJobHelper.getShardIndex();

int shardTotal = XxlJobHelper.getShardTotal();

//分片参数说明：

//index：当前分片序号(从0开始)，执行器集群列表中当前执行器的序号；

//total：总分片数，执行器集群的总机器数量；

9 访问令牌（AccessToken）

为提升系统安全性，调度中心和执行器进行安全性校验，双方AccessToken匹配才允许通讯；

调度中心和执行器，可通过配置项 “xxl.job.accessToken” 进行AccessToken的设置。

调度中心和执行器，如果需要正常通讯，只有两种设置；

• 设置一：调度中心和执行器，均不设置AccessToken；关闭安全性校验；
• 设置二：调度中心和执行器，设置了相同的AccessToken；

10 故障转移 & 失败重试

一次完整任务流程包括”调度（调度中心） + 执行（执行器）”两个阶段。

• “故障转移”发生在调度阶段，在执行器集群部署时，如果某一台执行器发生故障，该策略支持自动进行Failover切换到一台正常的执行器机器并且完成调度请求流程。
• “失败重试”发生在”调度 + 执行”两个阶段，支持通过自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

11 执行器灰度上线

调度中心与业务解耦，只需部署一次后常年不需要维护。但是，执行器中托管运行着业务作业，作业上线和变更需要重启执行器，尤其是Bean模式任务。
执行器重启可能会中断运行中的任务。但是，XXL-JOB得益于自建执行器与自建注册中心，可以通过灰度上线的方式，避免因重启导致的任务中断的问题。

步骤如下：

• 1、执行器改为手动注册，下线一半机器列表（A组），线上运行另一半机器列表（B组）；
• 2、等待A组机器任务运行结束并编译上线；执行器注册地址替换为A组；
• 3、等待B组机器任务运行结束并编译上线；执行器注册地址替换为A组+B组；
  操作结束；

12 任务执行结果说明

系统根据以下标准判断任务执行结果，可参考之。

13 任务超时控制

支持设置任务超时时间，任务运行超时的情况下，将会主动中断任务；

需要注意的是，任务超时中断时与任务终止机制（可查看“4.9 终止运行中的任务”）类似，也是通过 “interrupt” 中断任务，因此业务代码需要将 “InterruptedException” 外抛，否则功能不可用。

14 跨语言

XXL-JOB是一个跨语言的任务调度平台，主要体现在如下几个方面：

• 1、RESTful API：调度中心与执行器提供语言无关的 RESTful API 服务，第三方任意语言可据此对接调度中心或者实现执行器。（可参考章节 “调度中心/执行器 RESTful API” ）
• 2、多任务模式：提供Java、Python、PHP……等十来种任务模式，可参考章节 “5.5 任务 “运行模式” ”；理论上可扩展任意语言任务模式；
• 2、提供基于HTTP的任务Handler（Bean任务，JobHandler=”httpJobHandler”）；业务方只需要提供HTTP链接等相关信息即可，不限制语言、平台；（可参考章节 “原生内置Bean模式任务” ）

15 任务失败告警

默认提供邮件失败告警，可扩展短信、钉钉等方式。如果需要新增一种告警方式，只需要新增一个实现 “com.xxl.job.admin.core.alarm.JobAlarm” 接口的告警实现即可。可以参考默认提供邮箱告警实现 “EmailJobAlarm”。

16 调度中心Docker镜像构建

可以通过以下命令快速构建调度中心，并启动运行；

mvn clean packagedocker build -t xuxueli/xxl-job-admin ./xxl-job-admindocker run --name xxl-job-admin -p 8080:8080-d xuxueli/xxl-job-admin

17 避免任务重复执行

调度密集或者耗时任务可能会导致任务阻塞，集群情况下调度组件小概率情况下会重复触发；
针对上述情况，可以通过结合 “单机路由策略（如：第一台、一致性哈希）” + “阻塞策略（如：单机串行、丢弃后续调度）” 来规避，最终避免任务重复执行。

19 命令行任务

原生提供通用命令行任务Handler（Bean任务，”CommandJobHandler”）；业务方只需要提供命令行即可；
如任务参数 “pwd” 将会执行命令并输出数据；

20 日志自动清理

XXL-JOB日志主要包含如下两部分，均支持日志自动清理，说明如下：

• 调度中心日志表数据：可借助配置项 “xxl.job.logretentiondays” 设置日志表数据保存天数，过期日志自动清理；详情可查看上文配置说明；
• 执行器日志文件数据：可借助配置项 “xxl.job.executor.logretentiondays” 设置日志文件数据保存天数，过期日志自动清理；详情可查看上文配置说明；

21 调度结果丢失处理

执行器因网络抖动回调失败或宕机等异常情况，会导致任务调度结果丢失。由于调度中心依赖执行器回调来感知调度结果，因此会导致调度日志永远处于 “运行中” 状态。

针对该问题，调度中心提供内置组件进行处理，逻辑为：调度记录停留在 “运行中” 状态超过10min，且对应执行器心跳注册失败不在线，则将本地调度主动标记失败；

三、调度中心/执行器 RESTful API

XXL-JOB 目标是一种跨平台、跨语言的任务调度规范和协议。

针对Java应用，可以直接通过官方提供的调度中心与执行器，方便快速的接入和使用调度中心，可以参考上文 “快速入门” 章节。

针对非Java应用，可借助 XXL-JOB 的标准 RESTful API 方便的实现多语言支持。

• 调度中心 RESTful API：

• 说明：调度中心提供给执行器使用的API；不局限于官方执行器使用，第三方可使用该API来实现执行器；
• API列表：执行器注册、任务结果回调等；

• 执行器 RESTful API ：

• 说明：执行器提供给调度中心使用的API；官方执行器默认已实现，第三方执行器需要实现并对接提供给调度中心；
• API列表：任务触发、任务终止、任务日志查询……等；

此处 RESTful API 主要用于非Java语言定制个性化执行器使用，实现跨语言。除此之外，如果有需要通过API操作调度中心，可以个性化扩展 “调度中心 RESTful API” 并使用。

1 调度中心 RESTful API

API服务位置：com.xxl.job.core.biz.AdminBiz （ com.xxl.job.admin.controller.JobApiController ）
API服务请求参考代码：com.xxl.job.adminbiz.AdminBizTest
说明：执行器执行完任务后，回调任务结果时使用
------
地址格式：{调度中心跟地址}/callback
Header：
    XXL-JOB-ACCESS-TOKEN : {请求令牌}
请求数据格式如下，放置在 RequestBody 中，JSON格式：
    [{
        "logId":1,              // 本次调度日志ID
        "logDateTim":0,         // 本次调度日志时间
        "executeResult":{
            "code": 200,        // 200 表示任务执行正常，500表示失败
            "msg": null
        }
    }]
响应数据格式：
    {
      "code": 200,      // 200 表示正常、其他失败
      "msg": null      // 错误提示消息
    }

b、执行器注册

说明：执行器注册时使用，调度中心会实时感知注册成功的执行器并发起任务调度
------
地址格式：{调度中心跟地址}/registry
Header：
    XXL-JOB-ACCESS-TOKEN : {请求令牌}
请求数据格式如下，放置在 RequestBody 中，JSON格式：
    {
        "registryGroup":"EXECUTOR",                     // 固定值
        "registryKey":"xxl-job-executor-example",       // 执行器AppName
        "registryValue":"http://127.0.0.1:9999/"        // 执行器地址，内置服务跟地址
    }
响应数据格式：
    {
      "code": 200,      // 200 表示正常、其他失败
      "msg": null      // 错误提示消息
    }

c、执行器注册摘除

说明：执行器注册摘除时使用，注册摘除后的执行器不参与任务调度与执行
------
地址格式：{调度中心跟地址}/registryRemove
Header：
    XXL-JOB-ACCESS-TOKEN : {请求令牌}
请求数据格式如下，放置在 RequestBody 中，JSON格式：
    {
        "registryGroup":"EXECUTOR",                     // 固定值
        "registryKey":"xxl-job-executor-example",       // 执行器AppName
        "registryValue":"http://127.0.0.1:9999/"        // 执行器地址，内置服务跟地址
    }
响应数据格式：
    {
      "code": 200,      // 200 表示正常、其他失败
      "msg": null      // 错误提示消息
    }

6.2 执行器 RESTful API

API服务位置：com.xxl.job.core.biz.ExecutorBiz
API服务请求参考代码：com.xxl.job.executorbiz.ExecutorBizTest

a、心跳检测

说明：调度中心检测执行器是否在线时使用
------
地址格式：{执行器内嵌服务跟地址}/beat
Header：
    XXL-JOB-ACCESS-TOKEN : {请求令牌}
请求数据格式如下，放置在 RequestBody 中，JSON格式：
响应数据格式：
    {
      "code": 200,      // 200 表示正常、其他失败
      "msg": null       // 错误提示消息
    }

b、忙碌检测

说明：调度中心检测指定执行器上指定任务是否忙碌（运行中）时使用
------
地址格式：{执行器内嵌服务跟地址}/idleBeat
Header：
    XXL-JOB-ACCESS-TOKEN : {请求令牌}
请求数据格式如下，放置在 RequestBody 中，JSON格式：
    {
        "jobId":1       // 任务ID
    }
响应数据格式：
    {
      "code": 200,      // 200 表示正常、其他失败
      "msg": null       // 错误提示消息
    }

c、触发任务

说明：触发任务执行
------
地址格式：{执行器内嵌服务跟地址}/run
Header：
    XXL-JOB-ACCESS-TOKEN : {请求令牌}
请求数据格式如下，放置在 RequestBody 中，JSON格式：
    {
        "jobId":1,                                  // 任务ID
        "executorHandler":"demoJobHandler",         // 任务标识
        "executorParams":"demoJobHandler",          // 任务参数
        "executorBlockStrategy":"COVER_EARLY",      // 任务阻塞策略，可选值参考 com.xxl.job.core.enums.ExecutorBlockStrategyEnum
        "executorTimeout":0,                        // 任务超时时间，单位秒，大于零时生效
        "logId":1,                                  // 本次调度日志ID
        "logDateTime":1586629003729,                // 本次调度日志时间
        "glueType":"BEAN",                          // 任务模式，可选值参考 com.xxl.job.core.glue.GlueTypeEnum
        "glueSource":"xxx",                         // GLUE脚本代码
        "glueUpdatetime":1586629003727,             // GLUE脚本更新时间，用于判定脚本是否变更以及是否需要刷新
        "broadcastIndex":0,                         // 分片参数：当前分片
        "broadcastTotal":0                          // 分片参数：总分片
    }
响应数据格式：
    {
      "code": 200,      // 200 表示正常、其他失败
      "msg": null       // 错误提示消息
    }

f、终止任务

说明：终止任务
------
地址格式：{执行器内嵌服务跟地址}/kill
Header：
    XXL-JOB-ACCESS-TOKEN : {请求令牌}
请求数据格式如下，放置在 RequestBody 中，JSON格式：
    {
        "jobId":1       // 任务ID
    }
响应数据格式：
    {
      "code": 200,      // 200 表示正常、其他失败
      "msg": null       // 错误提示消息
    }

d、查看执行日志

说明：终止任务，滚动方式加载
------
地址格式：{执行器内嵌服务跟地址}/log
Header：
    XXL-JOB-ACCESS-TOKEN : {请求令牌}
请求数据格式如下，放置在 RequestBody 中，JSON格式：
    {
        "logDateTim":0,     // 本次调度日志时间
        "logId":0,          // 本次调度日志ID
        "fromLineNum":0     // 日志开始行号，滚动加载日志
    }
响应数据格式：
    {
        "code":200,         // 200 表示正常、其他失败
        "msg": null         // 错误提示消息
        "content":{
            "fromLineNum":0,        // 本次请求，日志开始行数
            "toLineNum":100,        // 本次请求，日志结束行号
            "logContent":"xxx",     // 本次请求日志内容
            "isEnd":true            // 日志是否全部加载完
        }
    }

四、代码、项目集成

1. 项目结构

doc：文档资料，包括"调度数据库"建表脚本

xxl-job-core：公共 Jar 依赖。

xxl-job-admin：调度中心，项目源码，spring boot 项目，可以直接启动。

xxl-job-executor-samples：执行器，sample 示例项目。

2 doc模块：

文档资料，包括"调度数据库"建表脚本，其中建表脚本是 tables_xxl_job.sql，创建所有的xxl_job底层存储数据的表。各个表对应的作用：

3 xxl-job-core模块：

公共 Jar 依赖

4 xxl-job-admin模块：

调度中心，项目源码，spring boot 项目，可以直接启动

启动该模块：

1）先在本地安装MySQL数据库，执行doc模块中定tables_xxl_job.sql脚本，创建项目需要的表；

2）更改aplication.properties文档中的数据库配置信息，根据新建表的实际情况进行更改；

还可以显式的创建xxl_job客户端登陆的账号和密码

启动项目模块：xxl-job-admin，启动完成后打开浏览器输入访问地址，访问地址来源通过配置文件的中的server.servlet.context-path参数和IndexController类中的toLogin接口方法获取。登陆页面出来后，使用显式配置登陆账号和密码进行登陆：admin/admin

访问地址：127.0.0.1:8080/xxl-job-admin/toLogin

登陆进入后

当前这个是有任务的情况下的页面图。

实际的应用中，为了保证客户端的高可用，可以进行集群部署。

5 xxl-job-executor-samples模块：

执行器，sample 示例项目，其中的 spring boot 工程，可以直接启动。可以在该项目上进行开发，也可以将现有项目改造生成执行器项目。该模块下提供了两个子模块的执行器，一个是frameless的代码实现，一个是独立应用SpringBoot的项目。当前我们使用SpringBoot子模块为例执行。

查看配置文件：application.properties

配置 xxl.job.admin.addresses，这是注册到调度中心的地址， 可以使用逗号分隔配置多个。

集群环境下这两个配置要一至

启动执行器，在客户端做对应配置

xxl.job.executor.appname=xxl-job-executor-sample

现在客户端“执行器管理”中新建一个执行器，应用名称使用executor配置文件中的应用名称，例如：xxl-job-executor-sample。

测试xxl-job

至此 xxl-job 已经安装完毕，测试一下对应的任务

创建任务

使用源码提供的 SimpleXxlJob进行测试

新建任务注意点：在方法名上打上 @XxlJob 注解，这里面有几个属性，第一个 value 值对应的是调度中心新建任务的JobHandler属性的值。另外的 init 对应 JobHandler 初始化方法，destory 对应 JobHandler 销毁方法。这两个方法要在任务类里面创建。

新建、配置任务

对对应的任务进行操作：

任务启动可以手动执行一次，也可以开启定时执行。

若有收获，就点个赞吧