《分布式任务调度平台XXL-JOB》

文档地址

https://www.xuxueli.com/xxl-job/

• 中文文档
• English Documentation

源码仓库地址

中央仓库地址

1. <!-- http://repo1.maven.org/maven2/com/xuxueli/xxl-job-core/ -->
2. <dependency>
3. <groupId>com.xuxueli</groupId>
4. <artifactId>xxl-job-core</artifactId>
5. <version>${最新稳定版本}</version>
6. </dependency>

1.6 环境

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

二、快速入门

2.1 初始化“调度数据库”

请下载项目源码并解压，获取 “调度数据库初始化SQL脚本” 并执行即可。

“调度数据库初始化SQL脚本” 位置为:

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

调度中心支持集群部署，集群情况下各节点务必连接同一个mysql实例;

如果mysql做主从,调度中心集群节点务必强制走主库;

2.2 编译源码

解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可，源码结构如下：

1. xxl-job-admin：调度中心
2. xxl-job-core：公共依赖
3. xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
4. ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；
5. ：xxl-job-executor-sample-frameless：无框架版本；

2.3 配置部署“调度中心”

1. 调度中心项目：xxl-job-admin
2. 作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。

步骤一：调度中心配置：

调度中心配置文件地址：

1. /xxl-job/xxl-job-admin/src/main/resources/application.properties

调度中心配置内容说明：

1. ### 调度中心JDBC链接：链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
2. spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
3. spring.datasource.username=root
4. spring.datasource.password=root_pwd
5. spring.datasource.driver-class-name=com.mysql.jdbc.Driver
7. ### 报警邮箱
8. spring.mail.host=smtp.qq.com
9. spring.mail.port=25
10. spring.mail.username=xxx@qq.com
11. spring.mail.password=xxx
12. spring.mail.properties.mail.smtp.auth=true
13. spring.mail.properties.mail.smtp.starttls.enable=true
14. spring.mail.properties.mail.smtp.starttls.required=true
15. spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
17. ### 调度中心通讯TOKEN [选填]：非空时启用；
18. xxl.job.accessToken=
20. ### 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文；
21. xxl.job.i18n=zh_CN
23. ## 调度线程池最大线程配置【必填】
24. xxl.job.triggerpool.fast.max=200
25. xxl.job.triggerpool.slow.max=100
27. ### 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
28. xxl.job.logretentiondays=30

步骤二：部署项目：

如果已经正确进行上述配置，可将项目编译打包部署。

调度中心访问地址：http://localhost:8080/xxl-job-admin (该地址执行器将会使用到，作为回调地址)

默认登录账号 “admin/123456”, 登录后运行界面如下图所示。

至此“调度中心”项目已经部署成功。

步骤三：调度中心集群（可选）：

调度中心支持集群部署，提升调度系统容灾和可用性。

调度中心集群部署时，几点要求和建议：

• DB配置保持一致；
• 集群机器时钟保持一致（单机集群忽视）；
• 建议：推荐通过nginx为调度中心集群做负载均衡，分配域名。调度中心访问、执行器回调配置、调用API服务等操作均通过该域名进行。

其他：Docker 镜像方式搭建调度中心：

• 下载镜像

1. // Docker地址：https://hub.docker.com/r/xuxueli/xxl-job-admin/ (建议指定版本号)
2. docker pull xuxueli/xxl-job-admin

• 创建容器并运行

1. docker run -p 8080:8080 -v /tmp:/data/applogs --name xxl-job-admin -d xuxueli/xxl-job-admin:{指定版本}
3. /**
4. * 如需自定义 mysql 等配置，可通过 "-e PARAMS" 指定，参数格式 PARAMS="--key=value --key2=value2" ；
5. * 配置项参考文件：/xxl-job/xxl-job-admin/src/main/resources/application.properties
6. * 如需自定义 JVM内存参数 等配置，可通过 "-e JAVA_OPTS" 指定，参数格式 JAVA_OPTS="-Xmx512m" ；
7. */
8. docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai" -p 8080:8080 -v /tmp:/data/applogs --name xxl-job-admin -d xuxueli/xxl-job-admin:{指定版本}

2.4 配置部署“执行器项目”

1. “执行器”项目：xxl-job-executor-sample-springboot (提供多种版本执行器供选择，现以 springboot 版本为例，可直接使用，也可以参考其并将现有项目改造成执行器)
2. 作用：负责接收“调度中心”的调度并执行；可直接部署执行器，也可以将执行器集成到现有业务项目中。

步骤一：maven依赖

确认pom文件中引入了 “xxl-job-core” 的maven依赖；

步骤二：执行器配置

执行器配置，配置文件地址：

1. /xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties

执行器配置，配置内容说明：

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

步骤三：执行器组件配置

执行器组件，配置文件地址：

1. /xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java

执行器组件，配置内容说明：

1. @Bean
2. public XxlJobSpringExecutor xxlJobExecutor() {
3. logger.info(">>>>>>>>>>> xxl-job config init.");
4. XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
5. xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
6. xxlJobSpringExecutor.setAppname(appname);
7. xxlJobSpringExecutor.setIp(ip);
8. xxlJobSpringExecutor.setPort(port);
9. xxlJobSpringExecutor.setAccessToken(accessToken);
10. xxlJobSpringExecutor.setLogPath(logPath);
11. xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
13. return xxlJobSpringExecutor;
14. }

步骤四：部署执行器项目：

如果已经正确进行上述配置，可将执行器项目编译打部署，系统提供多种执行器Sample示例项目，选择其中一个即可，各自的部署方式如下。

1. xxl-job-executor-sample-springboot：项目编译打包成springboot类型的可执行JAR包，命令启动即可；
2. xxl-job-executor-sample-frameless：项目编译打包成JAR包，命令启动即可；

至此“执行器”项目已经部署结束。

步骤五：执行器集群（可选）：

执行器支持集群部署，提升调度系统可用性，同时提升任务处理能力。

执行器集群部署时，几点要求和建议：

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

2.5 开发第一个任务“Hello World”

本示例以新建一个 “GLUE模式(Java)” 运行模式的任务为例。更多有关任务的详细配置，请查看“章节三：任务详解”。
（ “GLUE模式(Java)”的执行代码托管到调度中心在线维护，相比“Bean模式任务”需要在执行器项目开发部署上线，更加简便轻量）

前提：请确认“调度中心”和“执行器”项目已经成功部署并启动；

步骤一：新建任务：

登录调度中心，点击下图所示“新建任务”按钮，新建示例任务。然后，参考下面截图中任务的参数配置，点击保存。

步骤二：“GLUE模式(Java)” 任务开发：

请点击任务右侧 “GLUE” 按钮，进入 “GLUE编辑器开发界面” ，见下图。“GLUE模式(Java)” 运行模式的任务默认已经初始化了示例任务代码，即打印Hello World。
（ “GLUE模式(Java)” 运行模式的任务实际上是一段继承自IJobHandler的Java类代码，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里中的其他服务，详细介绍请查看第三章节）

步骤三：触发执行：

请点击任务右侧 “执行” 按钮，可手动触发一次任务执行（通常情况下，通过配置Cron表达式进行任务调度触发）。

步骤四：查看日志：

请点击任务右侧 “日志” 按钮，可前往任务日志界面查看任务日志。
在任务日志界面中，可查看该任务的历史调度记录以及每一次调度的任务调度信息、执行参数和执行信息。运行中的任务点击右侧的“执行日志”按钮，可进入日志控制台查看实时执行日志。

在日志控制台，可以Rolling方式实时查看任务在执行器一侧运行输出的日志信息，实时监控任务进度；

三、任务详解

配置属性详细说明：

1. 基础配置：
2. - 执行器：任务的绑定的执行器，任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 "执行器管理" 进行设置;
3. - 任务描述：任务的描述信息，便于任务管理；
4. - 负责人：任务的负责人；
5. - 报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；
7. 触发配置：
8. - 调度类型：
9. 无：该类型不会主动触发调度；
10. CRON：该类型将会通过CRON，触发任务调度；
11. 固定速度：该类型将会以固定速度，触发任务调度；按照固定的间隔时间，周期性触发；
12. 固定延迟：该类型将会以固定延迟，触发任务调度；按照固定的延迟时间，从上次调度结束后开始计算延迟时间，到达延迟时间后触发下次调度；
13. - CRON：触发任务执行的Cron表达式；
14. - 固定速度：固定速度的时间间隔，单位为秒；
15. - 固定延迟：固定延迟的时间间隔，单位为秒；
17. 任务配置：
18. - 运行模式：
19. BEAN模式：任务以JobHandler方式维护在执行器端；需要结合 "JobHandler" 属性匹配执行器中任务；
20. GLUE模式(Java)：任务以源码方式维护在调度中心；该模式的任务实际上是一段继承自IJobHandler的Java类代码并 "groovy" 源码方式维护，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里中的其他服务；
21. GLUE模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "shell" 脚本；
22. GLUE模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "python" 脚本；
23. GLUE模式(PHP)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "php" 脚本；
24. GLUE模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "nodejs" 脚本；
25. GLUE模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "PowerShell" 脚本；
26. - JobHandler：运行模式为 "BEAN模式" 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值；
27. - 执行参数：任务执行所需的参数；
29. 高级配置：
30. - 路由策略：当执行器集群部署时，提供丰富的路由策略，包括；
31. FIRST（第一个）：固定选择第一个机器；
32. LAST（最后一个）：固定选择最后一个机器；
33. ROUND（轮询）：；
34. RANDOM（随机）：随机选择在线的机器；
35. CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。
36. LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
37. LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举；
38. FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
39. BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
40. SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；
41. - 子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。
42. - 调度过期策略：
43. - 忽略：调度过期后，忽略过期的任务，从当前时间开始重新计算下次触发时间；
44. - 立即执行一次：调度过期后，立即执行一次，并从当前时间开始重新计算下次触发时间；
45. - 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
46. 单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
47. 丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
48. 覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
49. - 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
50. - 失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

3.1 BEAN模式（类形式）

Bean模式任务，支持基于类的开发方式，每个任务对应一个Java类。

• 优点：不限制项目环境，兼容性好。即使是无框架项目，如main方法直接启动的项目也可以提供支持，可以参考示例项目 “xxl-job-executor-sample-frameless”；
• 缺点：
  • 每个任务需要占用一个Java类，造成类的浪费；
  • 不支持自动扫描任务并注入到执行器容器，需要手动注入。

步骤一：执行器项目中，开发Job类：

1. 1、开发一个继承自"com.xxl.job.core.handler.IJobHandler"的JobHandler类，实现其中任务方法。
2. 2、手动通过如下方式注入到执行器容器。
3. ```
4. XxlJobExecutor.registJobHandler("demoJobHandler", new DemoJobHandler());
5. ```

步骤二：调度中心，新建调度任务

后续步骤和 “3.2 BEAN模式（方法形式）”一致，可以前往参考。

3.2 BEAN模式（方法形式）

Bean模式任务，支持基于方法的开发方式，每个任务对应一个方法。

• 优点：
  • 每个任务只需要开发一个方法，并添加”@XxlJob”注解即可，更加方便、快速。
  • 支持自动扫描任务并注入到执行器容器。
• 缺点：要求Spring容器环境；

基于方法开发的任务，底层会生成JobHandler代理，和基于类的方式一样，任务也会以JobHandler的形式存在于执行器任务容器中。

步骤一：执行器项目中，开发Job方法：

1. 1、任务开发：在Spring Bean实例中，开发Job方法；
2. 2、注解配置：为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")"，注解value值对应的是调度中心新建任务的JobHandler属性的值。
3. 3、执行日志：需要通过 "XxlJobHelper.log" 打印执行日志；
4. 4、任务结果：默认任务结果为 "成功" 状态，不需要主动设置；如有诉求，比如设置任务结果为失败，可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果；

1. // 可参考Sample示例执行器中的 "com.xxl.job.executor.service.jobhandler.SampleXxlJob" ，如下：
2. @XxlJob("demoJobHandler")
3. public void demoJobHandler() throws Exception {
4. XxlJobHelper.log("XXL-JOB, Hello World.");
5. }

步骤二：调度中心，新建调度任务

参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “BEAN模式”，JobHandler属性填写任务注解“@XxlJob”中定义的值；

原生内置Bean模式任务

为方便用户参考与快速实用，示例执行器内原生提供多个Bean模式任务Handler，可以直接配置实用，如下：

• demoJobHandler：简单示例任务，任务内部模拟耗时任务逻辑，用户可在线体验Rolling Log等功能；
• shardingJobHandler：分片示例任务，任务内部模拟处理分片参数，可参考熟悉分片任务；
• httpJobHandler：通用HTTP任务Handler；业务方只需要提供HTTP链接等信息即可，不限制语言、平台。示例任务入参如下：
  1. url: http://www.xxx.com
  2. method: get 或 post
  3. data: post-data
• commandJobHandler：通用命令行任务Handler；业务方只需要提供命令行即可；如 “pwd”命令；

3.3 GLUE模式(Java)

任务以源码方式维护在调度中心，支持通过Web IDE在线更新，实时编译和生效，因此不需要指定JobHandler。开发流程如下：

步骤一：调度中心，新建调度任务：

参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “GLUE模式(Java)”；

步骤二：开发任务代码：

选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发（也可以在IDE中开发完成后，复制粘贴到编辑中）。

版本回溯功能（支持30个版本的版本回溯）：在GLUE任务的Web IDE界面，选择右上角下拉框“版本回溯”，会列出该GLUE的更新历史，选择相应版本即可显示该版本代码，保存后GLUE代码即回退到对应的历史版本；

3.4 GLUE模式(Shell)

步骤一：调度中心，新建调度任务

参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “GLUE模式(Shell)”；

步骤二：开发任务代码：

选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发（也可以在IDE中开发完成后，复制粘贴到编辑中）。

该模式的任务实际上是一段 “shell” 脚本；

3.4 GLUE模式(Python)

步骤一：调度中心，新建调度任务

参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “GLUE模式(Python)”；

步骤二：开发任务代码：

选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发（也可以在IDE中开发完成后，复制粘贴到编辑中）。

该模式的任务实际上是一段 “python” 脚本；

3.5 GLUE模式(NodeJS)

步骤一：调度中心，新建调度任务

参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “GLUE模式(NodeJS)”；

步骤二：开发任务代码：

选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发（也可以在IDE中开发完成后，复制粘贴到编辑中）。

该模式的任务实际上是一段 “nodeJS” 脚本；

3.6 GLUE模式(PHP)

同上

3.7 GLUE模式(PowerShell)

同上

四、操作指南

4.1 配置执行器

点击进入”执行器管理”界面, 如下图:

1. 1、"调度中心OnLine:"右侧显示在线的"调度中心"列表, 任务执行结束后, 将会以failover的模式进行回调调度中心通知执行结果, 避免回调的单点风险;
2. 2、"执行器列表" 中显示在线的执行器列表, 可通过"OnLine 机器"查看对应执行器的集群机器。

点击按钮 “+新增执行器” 弹框如下图, 可新增执行器配置:

执行器属性说明

1. AppName: 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
2. 名称: 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;
3. 排序: 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;
4. 注册方式：调度中心获取执行器地址的方式；
5. 自动注册：执行器自动进行执行器注册，调度中心通过底层注册表可以动态发现执行器机器地址；
6. 手动录入：人工手动录入执行器的地址信息，多地址逗号分隔，供调度中心使用；
7. 机器地址："注册方式"为"手动录入"时有效，支持人工维护执行器的地址信息；

4.2 新建任务

进入任务管理界面，点击“新增任务”按钮，在弹出的“新增任务”界面配置任务属性后保存即可。详情页参考章节 “三、任务详解”。

4.3 编辑任务

进入任务管理界面，选中指定任务。点击该任务右侧“编辑”按钮，在弹出的“编辑任务”界面更新任务属性后保存即可，可以修改设置的任务属性信息：

4.4 编辑GLUE代码

该操作仅针对GLUE任务。

选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发。可参考章节 “3.3 GLUE模式(Java)”。

4.5 启动/停止任务

可对任务进行“启动”和“停止”操作。
需要注意的是，此处的启动/停止仅针对任务的后续调度触发行为，不会影响到已经触发的调度任务，如需终止已经触发的调度任务，可查看“4.9 终止运行中的任务”

4.6 手动触发一次调度

点击“执行”按钮，可手动触发一次任务调度，不影响原有调度规则。

4.7 查看调度日志

点击“日志”按钮，可以查看任务历史调度日志。在历史调入日志界面可查看每次任务调度的调度结果、执行结果等，点击“执行日志”按钮可查看执行器完整日志。

1. 调度时间："调度中心"触发本次调度并向"执行器"发送任务执行信号的时间；
2. 调度结果："调度中心"触发本次调度的结果，200表示成功，500或其他表示失败；
3. 调度备注："调度中心"触发本次调度的日志信息；
4. 执行器地址：本次任务执行的机器地址
5. 运行模式：触发调度时任务的运行模式，运行模式可参考章节 "三、任务详解"；
6. 任务参数：本地任务执行的入参
7. 执行时间："执行器"中本次任务执行结束后回调的时间；
8. 执行结果："执行器"中本次任务执行的结果，200表示成功，500或其他表示失败；
9. 执行备注："执行器"中本次任务执行的日志信息；
10. 操作：
11. "执行日志"按钮：点击可查看本地任务执行的详细日志信息；详见“4.8 查看执行日志”；
12. "终止任务"按钮：点击可终止本地调度对应执行器上本任务的执行线程，包括未执行的阻塞任务一并被终止；

4.8 查看执行日志

点击执行日志右侧的 “执行日志” 按钮，可跳转至执行日志界面，可以查看业务代码中打印的完整日志，如下图；

4.9 终止运行中的任务

仅针对执行中的任务。
在任务日志界面，点击右侧的“终止任务”按钮，将会向本次任务对应的执行器发送任务终止请求，将会终止掉本次任务，同时会清空掉整个任务执行队列。

任务终止时通过 “interrupt” 执行线程的方式实现, 将会触发 “InterruptedException” 异常。因此如果JobHandler内部catch到了该异常并消化掉的话, 任务终止功能将不可用。

因此, 如果遇到上述任务终止不可用的情况, 需要在JobHandler中应该针对 “InterruptedException” 异常进行特殊处理 (向上抛出) , 正确逻辑如下:

1. try{
2. // do something
3. } catch (Exception e) {
4. if (e instanceof InterruptedException) {
5. throw e;
6. }
7. logger.warn("{}", e);
8. }

而且，在JobHandler中开启子线程时，子线程也不可catch处理”InterruptedException”，应该主动向上抛出。

任务终止时会执行对应JobHandler的”destroy()”方法，可以借助该方法处理一些资源回收的逻辑。

4.10 删除执行日志

在任务日志界面，选中执行器和任务之后，点击右侧的”删除”按钮将会出现”日志清理”弹框，弹框中支持选择不同类型的日志清理策略，选中后点击”确定”按钮即可进行日志清理操作；

4.11 删除任务

点击删除按钮，可以删除对应任务。

4.12 用户管理

进入 “用户管理” 界面，可查看和管理用户信息；

目前用户分为两种角色：

• 管理员：拥有全量权限，支持在线管理用户信息，为用户分配权限，权限分配粒度为执行器；
• 普通用户：仅拥有被分配权限的执行器，及相关任务的操作权限；

五、总体设计

5.1 源码目录介绍

1. - /doc :文档资料
2. - /db :“调度数据库”建表脚本
3. - /xxl-job-admin :调度中心，项目源码
4. - /xxl-job-core :公共Jar依赖
5. - /xxl-job-executor-samples :执行器，Sample示例项目（大家可以在该项目上进行开发，也可以将现有项目改造生成执行器项目）

5.2 “调度数据库”配置

XXL-JOB调度模块基于自研调度组件并支持集群部署，调度数据库表说明如下：

1. - xxl_job_lock：任务调度锁表；
2. - xxl_job_group：执行器信息表，维护任务执行器信息；
3. - xxl_job_info：调度扩展信息表： 用于保存XXL-JOB调度任务的扩展信息，如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等；
4. - xxl_job_log：调度日志表： 用于保存XXL-JOB任务调度的历史信息，如调度结果、执行结果、调度入参、调度机器和执行器等等；
5. - xxl_job_log_report：调度日志报表：用户存储XXL-JOB任务调度日志的报表，调度中心报表功能页面会用到；
6. - xxl_job_logglue：任务GLUE日志：用于保存GLUE更新历史，用于支持GLUE的版本回溯功能；
7. - xxl_job_registry：执行器注册表，维护在线的执行器和调度中心机器地址信息；
8. - xxl_job_user：系统用户表；

5.3 架构设计

5.3.1 设计思想

将调度行为抽象形成“调度中心”公共平台，而平台自身并不承担业务逻辑，“调度中心”负责发起调度请求。

将任务抽象成分散的JobHandler，交由“执行器”统一管理，“执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑。

因此，“调度”和“任务”两部分可以相互解耦，提高系统整体稳定性和扩展性；

5.3.2 系统组成

• 调度模块（调度中心）：
  负责管理调度信息，按照调度配置发出调度请求，自身不承担业务代码。调度系统与任务解耦，提高了系统可用性和稳定性，同时调度系统性能不再受限于任务模块；
  支持可视化、简单且动态的管理调度信息，包括任务新建，更新，删除，GLUE开发和任务报警等，所有上述操作都会实时生效，同时支持监控调度结果以及执行日志，支持执行器Failover。
• 执行模块（执行器）：
  负责接收调度请求并执行任务逻辑。任务模块专注于任务的执行等操作，开发和维护更加简单和高效；
  接收“调度中心”的执行请求、终止请求和日志请求等。

5.3.3 架构图

5.4 调度模块剖析

5.4.1 quartz的不足

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

• 问题一：调用API的的方式操作任务，不人性化；
• 问题二：需要持久化业务QuartzJobBean到底层数据表中，系统侵入性相当严重。
• 问题三：调度逻辑和QuartzJobBean耦合在同一个项目中，这将导致一个问题，在调度任务数量逐渐增多，同时调度任务逻辑逐渐加重的情况下，此时调度系统的性能将大大受限于业务；
• 问题四：quartz底层以“抢占式”获取DB锁并由抢占成功节点负责运行任务，会导致节点负载悬殊非常大；而XXL-JOB通过执行器实现“协同分配式”运行任务，充分发挥集群优势，负载各节点均衡。

XXL-JOB弥补了quartz的上述不足之处。

5.4.2 自研调度模块

XXL-JOB最终选择自研调度组件（早期调度组件基于Quartz）；一方面是为了精简系统降低冗余依赖，另一方面是为了提供系统的可控度与稳定性；

XXL-JOB中“调度模块”和“任务模块”完全解耦，调度模块进行任务调度时，将会解析不同的任务参数发起远程调用，调用各自的远程执行器服务。这种调用模型类似RPC调用，调度中心提供调用代理的功能，而执行器提供远程服务的功能。

5.4.3 调度中心HA（集群）

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

5.4.4 调度线程池

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

5.4.5 并行调度

XXL-JOB调度模块默认采用并行机制，在多线程调度的情况下，调度模块被阻塞的几率很低，大大提高了调度系统的承载量。

XXL-JOB的不同任务之间并行调度、并行执行。
XXL-JOB的单个任务，针对多个执行器是并行运行的，针对单个执行器是串行执行的。同时支持任务终止。

5.4.6 过期处理策略

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

• 可能原因：服务重启；调度线程被阻塞，线程被耗尽；上次调度持续阻塞，下次调度被错过；
• 处理策略：
  • 过期超5s：本次忽略，当前时间开始计算下次触发时间
  • 过期5s内：立即触发一次，当前时间开始计算下次触发时间

5.4.7 日志回调服务

调度模块的“调度中心”作为Web服务部署时，一方面承担调度中心功能，另一方面也为执行器提供API服务。

调度中心提供的”日志回调服务API服务”代码位置如下：

1. xxl-job-admin#com.xxl.job.admin.controller.JobApiController.callback

“执行器”在接收到任务执行请求后，执行任务，在执行结束之后会将执行结果回调通知“调度中心”：

5.4.8 任务HA（Failover）

执行器如若集群部署，调度中心将会感知到在线的所有执行器，如“127.0.0.1:9997, 127.0.0.1:9998, 127.0.0.1:9999”。

当任务”路由策略”选择”故障转移(FAILOVER)”时，当调度中心每次发起调度请求时，会按照顺序对执行器发出心跳检测请求，第一个检测为存活状态的执行器将会被选定并发送调度请求。

调度成功后，可在日志监控界面查看“调度备注”，如下；

“调度备注”可以看出本地调度运行轨迹，执行器的”注册方式”、”地址列表”和任务的”路由策略”。”故障转移(FAILOVER)”路由策略下，调度中心首先对第一个地址进行心跳检测，心跳失败因此自动跳过，第二个依然心跳检测失败……
直至心跳检测第三个地址“127.0.0.1:9999”成功，选定为“目标执行器”；然后对“目标执行器”发送调度请求，调度流程结束，等待执行器回调执行结果。

5.4.9 调度日志

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

• 任务信息：包括“执行器地址”、“JobHandler”和“执行参数”等属性，点击任务ID按钮可查看，根据这些参数，可以精确的定位任务执行的具体机器和任务代码；
• 调度信息：包括“调度时间”、“调度结果”和“调度日志”等，根据这些参数，可以了解“调度中心”发起调度请求时具体情况。
• 执行信息：包括“执行时间”、“执行结果”和“执行日志”等，根据这些参数，可以了解在“执行器”端任务执行的具体情况；

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

• 执行器地址：任务执行的机器地址；
• JobHandler：Bean模式表示任务执行的JobHandler名称；
• 任务参数：任务执行的入参；
• 调度时间：调度中心，发起调度的时间；
• 调度结果：调度中心，发起调度的结果，SUCCESS或FAIL；
• 调度备注：调度中心，发起调度的备注信息，如地址心跳检测日志等；
• 执行时间：执行器，任务执行结束后回调的时间；
• 执行结果：执行器，任务执行的结果，SUCCESS或FAIL；
• 执行备注：执行器，任务执行的备注信息，如异常日志等；
• 执行日志：任务执行过程中，业务代码中打印的完整执行日志，见“4.8 查看执行日志”；

5.4.10 任务依赖

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

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

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

5.4.11 全异步化 & 轻量级

• 全异步化设计：XXL-JOB系统中业务逻辑在远程执行器执行，触发流程全异步化设计。相比直接在调度中心内部执行业务逻辑，极大的降低了调度线程占用时间；
  • 异步调度：调度中心每次任务触发时仅发送一次调度请求，该调度请求首先推送“异步调度队列”，然后异步推送给远程执行器
  • 异步执行：执行器会将请求存入“异步执行队列”并且立即响应调度中心，异步运行。
• 轻量级设计：XXL-JOB调度中心中每个JOB逻辑非常 “轻”，在全异步化的基础上，单个JOB一次运行平均耗时基本在 “10ms” 之内（基本为一次请求的网络开销）；因此，可以保证使用有限的线程支撑大量的JOB并发运行；

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

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

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

5.4.12 均衡调度

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

5.5 任务 “运行模式” 剖析

5.5.1 “Bean模式” 任务

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

5.5.2 “GLUE模式(Java)” 任务

开发步骤：可参考 “章节三” ；
原理：每个 “GLUE模式(Java)” 任务的代码，实际上是“一个继承自“IJobHandler”的实现类的类代码”，“执行器”接收到“调度中心”的调度请求时，会通过Groovy类加载器加载此代码，实例化成Java对象，同时注入此代码中声明的Spring服务（请确保Glue代码中的服务和类引用在“执行器”项目中存在），然后调用该对象的execute方法，执行任务逻辑。

5.5.3 GLUE模式(Shell) + GLUE模式(Python) + GLUE模式(PHP) + GLUE模式(NodeJS) + GLUE模式(Powershell)

开发步骤：可参考 “章节三” ；
原理：脚本任务的源码托管在调度中心，脚本逻辑在执行器运行。当触发脚本任务时，执行器会加载脚本源码在执行器机器上生成一份脚本文件，然后通过Java代码调用该脚本；并且实时将脚本输出日志写到任务日志文件中，从而在调度中心可以实时监控脚本运行情况；

目前支持的脚本类型如下：

1. - shell脚本：任务运行模式选择为 "GLUE模式(Shell)"时支持 "Shell" 脚本任务；
2. - python脚本：任务运行模式选择为 "GLUE模式(Python)"时支持 "Python" 脚本任务；
3. - php脚本：任务运行模式选择为 "GLUE模式(PHP)"时支持 "PHP" 脚本任务；
4. - nodejs脚本：任务运行模式选择为 "GLUE模式(NodeJS)"时支持 "NodeJS" 脚本任务；
5. - powershell：任务运行模式选择为 "GLUE模式(PowerShell)"时支持 "PowerShell" 脚本任务；

脚本任务通过 Exit Code 判断任务执行结果，状态码可参考章节 “5.15 任务执行结果说明”；

5.5.4 执行器

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

在项目启动时，执行器会通过“@JobHandler”识别Spring容器中“Bean模式任务”，以注解的value属性为key管理起来。

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

5.5.5 任务日志

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

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

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

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

5.6 通讯模块剖析

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

1. - 1、“调度中心”向“执行器”发送http调度请求: “执行器”中接收请求的服务，实际上是一台内嵌Server，默认端口9999;
2. - 2、“执行器”执行任务逻辑；
3. - 3、“执行器”http回调“调度中心”调度结果: “调度中心”中接收回调的服务，是针对执行器开放一套API服务;

5.6.2 通讯数据加密

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

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

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

1. AppName: 每个执行器机器集群的唯一标示, 任务注册以 "执行器" 为最小粒度进行注册; 每个任务通过其绑定的执行器可感知对应的执行器机器列表;
2. 注册表: 见"xxl_job_registry"表, "执行器" 在进行任务注册时将会周期性维护一条注册记录，即机器地址和AppName的绑定关系; "调度中心" 从而可以动态感知每个AppName在线的机器列表;
3. 执行器注册: 任务注册Beat周期默认30s; 执行器以一倍Beat进行执行器注册, 调度中心以一倍Beat进行动态任务发现; 注册信息的失效时间为三倍Beat;
4. 执行器注册摘除：执行器销毁时，将会主动上报调度中心并摘除对应的执行器机器信息，提高心跳注册的实时性；

为保证系统”轻量级”并且降低学习部署成本，没有采用Zookeeper作为注册中心，采用DB方式进行任务注册发现；

5.8 任务执行结果

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

5.9 分片广播 & 动态分片

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

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

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

• Java语言任务获取分片参数方式：BEAN、GLUE模式(Java)
  1. // 可参考Sample示例执行器中的示例任务"ShardingJobHandler"了解试用
  2. int shardIndex = XxlJobHelper.getShardIndex();
  3. int shardTotal = XxlJobHelper.getShardTotal();
• 脚本语言任务获取分片参数方式：GLUE模式(Shell)、GLUE模式(Python)、GLUE模式(Nodejs)
  1. // 脚本任务入参固定为三个，依次为：任务传参、分片序号、分片总数。以Shell模式任务为例，获取分片参数代码如下
  2. echo "分片序号 index = $2"
  3. echo "分片总数 total = $3"

分片参数属性说明：

1. index：当前分片序号(从0开始)，执行器集群列表中当前执行器的序号；
2. total：总分片数，执行器集群的总机器数量；

该特性适用场景如：

• 1、分片任务场景：10个执行器的集群来处理10w条数据，每台机器只需要处理1w条数据，耗时降低10倍；
• 2、广播任务场景：广播执行器机器运行shell脚本、广播集群节点进行缓存更新等

5.10 访问令牌（AccessToken）

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

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

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

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

5.11 故障转移 & 失败重试

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

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

5.12 执行器灰度上线

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

步骤如下：

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

5.13 任务执行结果说明

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

5.14 任务超时控制

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

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

5.15 跨语言

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

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

5.16 任务失败告警

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

5.17 调度中心Docker镜像构建

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

1. mvn clean package
2. docker build -t xuxueli/xxl-job-admin ./xxl-job-admin
3. docker run --name xxl-job-admin -p 8080:8080 -d xuxueli/xxl-job-admin

5.20 避免任务重复执行

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

5.21 命令行任务

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

5.22 日志自动清理

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

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

5.23 调度结果丢失处理

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

针对该问题，调度中心提供内置组件进行处理，逻辑为：调度记录停留在 “运行中” 状态超过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” 并使用。

6.1 调度中心 RESTful API

API服务位置：com.xxl.job.core.biz.AdminBiz （ com.xxl.job.admin.controller.JobApiController ）
API服务请求参考代码：com.xxl.job.adminbiz.AdminBizTest

a、任务回调

1. 说明：执行器执行完任务后，回调任务结果时使用
3. ------
5. 地址格式：{调度中心根地址}/api/callback
7. Header：
8. XXL-JOB-ACCESS-TOKEN : {请求令牌}
10. 请求数据格式如下，放置在 RequestBody 中，JSON格式：
11. [{
12. "logId":1, // 本次调度日志ID
13. "logDateTim":0, // 本次调度日志时间
14. "handleCode":200, // 200 表示任务执行正常，500表示失败
15. "handleMsg": null
16. }
17. }]
19. 响应数据格式：
20. {
21. "code": 200, // 200 表示正常、其他失败
22. "msg": null // 错误提示消息
23. }

b、执行器注册

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

c、执行器注册摘除

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

6.2 执行器 RESTful API

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

a、心跳检测

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

b、忙碌检测

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

c、触发任务

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

f、终止任务

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

d、查看执行日志

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

本栏目推荐文章
• 分布式限流——基于Redis的Lua脚本限流实现
• 微信对话平台API开发
• 分布式代码执行分析
• 毕设具体任务
• 简易机器学习笔记（十一）opencv 简易使用-人脸识别、分类任务
• 云平台大数据系统需求有哪些？
• .net core分布式定时任务调度系统
• ThingsKit 物联网平台 可视化规则引擎发布
• Kettle设置定时跑任务
• 分布式缓存的实现和使用

分布式 任务 XXL-JOB 平台 XXL分布式 任务xxl-job平台 分布式 任务xxl-job xxl 分布式 任务xxl-job java 任务 分布式 框架xxl-job 分布式 任务xxl-job项目 任务xxl-job代码java powerjob任务xxl-job功能 任务xxl-job xxl job 位置 任务xxl-job xxl 入门指南 任务xxl-job指南