|
|
|
|
@ -16,29 +16,30 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
### 1.2 特性
|
|
|
|
|
- 1、简单：支持通过Web页面对任务进行CRUD操作，操作简单，一分钟上手；
|
|
|
|
|
- 2、动态：支持动态修改任务状态、暂停/恢复任务，以及终止运行中任务，即时生效；
|
|
|
|
|
- 3、调度中心HA（中心式）：调度采用中心式设计，“调度中心”基于集群Quartz实现，可保证调度中心HA；
|
|
|
|
|
- 3、调度中心HA（中心式）：调度采用中心式设计，“调度中心”基于集群Quartz实现并支持集群部署，可保证调度中心HA；
|
|
|
|
|
- 4、执行器HA（分布式）：任务分布式执行，任务"执行器"支持集群部署，可保证任务执行HA；
|
|
|
|
|
- 5、任务Failover：执行器集群部署时，任务路由策略选择"故障转移"情况下调度失败时将会平滑切换执行器进行Failover；
|
|
|
|
|
- 6、一致性：“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行；
|
|
|
|
|
- 7、自定义任务参数：支持在线配置调度任务入参，即时生效；
|
|
|
|
|
- 8、调度线程池：调度系统多线程触发调度运行，确保调度精确执行，不被堵塞；
|
|
|
|
|
- 9、弹性扩容缩容：一旦有新执行器机器上线或者下线，下次调度时将会重新分配任务；
|
|
|
|
|
- 10、邮件报警：任务失败时支持邮件报警，支持配置多邮件地址群发报警邮件；
|
|
|
|
|
- 11、状态监控：支持实时监控任务进度；
|
|
|
|
|
- 12、Rolling执行日志：支持在线查看调度结果，并且支持以Rolling方式实时查看执行器输出的完整的执行日志；
|
|
|
|
|
- 13、GLUE：提供Web IDE，支持在线开发任务逻辑代码，动态发布，实时编译生效，省略部署上线的过程。支持30个版本的历史版本回溯。
|
|
|
|
|
- 14、数据加密：调度中心和执行器之间的通讯进行数据加密，提升调度信息安全性；
|
|
|
|
|
- 15、任务依赖：支持配置子任务依赖，当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔；
|
|
|
|
|
- 16、推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用;
|
|
|
|
|
- 17、任务注册: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时，也支持手动录入执行器地址；
|
|
|
|
|
- 18、路由策略：执行器集群部署时提供丰富的路由策略，包括：第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等；
|
|
|
|
|
- 19、运行报表：支持实时查看运行数据，如任务数量、调度次数、执行器数量等；以及调度报表，如调度日期分布图，调度成功分布图等；
|
|
|
|
|
- 20、脚本任务：支持以GLUE模式开发和运行脚本任务，包括Shell、Python等类型脚本;
|
|
|
|
|
- 21、阻塞处理策略：调度过于密集执行器来不及处理时的处理策略，策略包括：单机串行（默认）、丢弃后续调度、覆盖之前调度；
|
|
|
|
|
- 22、失败处理策略；调度失败时的处理策略，策略包括：失败告警（默认）、失败重试；
|
|
|
|
|
- 23、分片广播任务：执行器集群部署时，任务路由策略选择"分片广播"情况下，一次任务调度将会广播触发集群中所有执行器执行一次任务，可根据分片参数开发分片任务；
|
|
|
|
|
- 24、动态分片：分片广播任务以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度。
|
|
|
|
|
- 25、事件触发：除了"Cron方式"和"任务依赖方式"触发任务执行之外，支持基于事件的触发任务方式。调度中心提供触发任务单次执行的API服务，可根据业务事件灵活触发。
|
|
|
|
|
- 5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时，也支持手动录入执行器地址；
|
|
|
|
|
- 6、弹性扩容缩容：一旦有新执行器机器上线或者下线，下次调度时将会重新分配任务；
|
|
|
|
|
- 7、路由策略：执行器集群部署时提供丰富的路由策略，包括：第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等；
|
|
|
|
|
- 8、故障转移：任务路由策略选择"故障转移"情况下，如果执行器集群中某一台机器故障，将会自动Failover切换到一台正常的执行器发送调度请求。
|
|
|
|
|
- 9、失败处理策略；调度失败时的处理策略，策略包括：失败告警（默认）、失败重试；
|
|
|
|
|
- 10、失败重试：调度中心调度失败且启用"失败重试"策略时，将会自动重试一次；执行器执行失败且回调失败重试状态时，也将会自动重试一次；
|
|
|
|
|
- 11、阻塞处理策略：调度过于密集执行器来不及处理时的处理策略，策略包括：单机串行（默认）、丢弃后续调度、覆盖之前调度；
|
|
|
|
|
- 12、分片广播任务：执行器集群部署时，任务路由策略选择"分片广播"情况下，一次任务调度将会广播触发集群中所有执行器执行一次任务，可根据分片参数开发分片任务；
|
|
|
|
|
- 13、动态分片：分片广播任务以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度。
|
|
|
|
|
- 14、事件触发：除了"Cron方式"和"任务依赖方式"触发任务执行之外，支持基于事件的触发任务方式。调度中心提供触发任务单次执行的API服务，可根据业务事件灵活触发。
|
|
|
|
|
- 15、任务进度监控：支持实时监控任务进度；
|
|
|
|
|
- 16、Rolling实时日志：支持在线查看调度结果，并且支持以Rolling方式实时查看执行器输出的完整的执行日志；
|
|
|
|
|
- 17、GLUE：提供Web IDE，支持在线开发任务逻辑代码，动态发布，实时编译生效，省略部署上线的过程。支持30个版本的历史版本回溯。
|
|
|
|
|
- 18、脚本任务：支持以GLUE模式开发和运行脚本任务，包括Shell、Python、NodeJS等类型脚本;
|
|
|
|
|
- 19、任务依赖：支持配置子任务依赖，当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔；
|
|
|
|
|
- 20、一致性：“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行；
|
|
|
|
|
- 21、自定义任务参数：支持在线配置调度任务入参，即时生效；
|
|
|
|
|
- 22、调度线程池：调度系统多线程触发调度运行，确保调度精确执行，不被堵塞；
|
|
|
|
|
- 23、数据加密：调度中心和执行器之间的通讯进行数据加密，提升调度信息安全性；
|
|
|
|
|
- 24、邮件报警：任务失败时支持邮件报警，支持配置多邮件地址群发报警邮件；
|
|
|
|
|
- 25、推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用;
|
|
|
|
|
- 26、运行报表：支持实时查看运行数据，如任务数量、调度次数、执行器数量等；以及调度报表，如调度日期分布图，调度成功分布图等；
|
|
|
|
|
|
|
|
|
|
### 1.3 发展
|
|
|
|
|
于2015年中，我在github上创建XXL-JOB项目仓库并提交第一个commit，随之进行系统结构设计，UI选型，交互设计……
|
|
|
|
|
@ -51,8 +52,10 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
|
|
|
|
|
于2017-05-13，在上海举办的 "[第62期开源中国源创会](https://www.oschina.net/event/2236961)" 的 "放码过来" 环节，我登台对XXL-JOB做了演讲，台下五百位在场观众反响热烈（[图文回顾](https://www.oschina.net/question/2686220_2242120) ）。
|
|
|
|
|
|
|
|
|
|
于2017-12-11，XXL-JOB有幸参会《[InfoQ ArchSummit全球架构师峰会](http://bj2017.archsummit.com/)》，并被拍拍贷架构总监"杨波老师"在专题 "[微服务原理、基础架构和开源实践](http://bj2017.archsummit.com/training/2)" 中现场介绍。
|
|
|
|
|
|
|
|
|
|
> 我司大众点评目前已接入XXL-JOB，内部别名《Ferrari》（Ferrari基于XXL-JOB的V1.1版本定制而成，新接入应用推荐升级最新版本）。
|
|
|
|
|
据最新统计, 自2016-01-21接入至2017-07-07期间，该系统已调度约60万余次，表现优异。新接入应用推荐使用最新版本，因为经过数个大版本的更新，系统的任务模型、UI交互模型以及底层调度通讯模型都有了较大的优化和提升，核心功能更加稳定高效。
|
|
|
|
|
据最新统计, 自2016-01-21接入至2017-12-01期间，该系统已调度约100万次，表现优异。新接入应用推荐使用最新版本，因为经过数个大版本的更新，系统的任务模型、UI交互模型以及底层调度通讯模型都有了较大的优化和提升，核心功能更加稳定高效。
|
|
|
|
|
|
|
|
|
|
至今，XXL-JOB已接入多家公司的线上产品线，接入场景如电商业务，O2O业务和大数据作业等，截止2016-07-19为止，XXL-JOB已接入的公司包括不限于：
|
|
|
|
|
|
|
|
|
|
@ -113,6 +116,8 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
- 55、中商惠民(北京)电子商务有限公司
|
|
|
|
|
- 56、凯京集团
|
|
|
|
|
- 57、华夏票联（北京）科技有限公司
|
|
|
|
|
- 58、拍拍贷
|
|
|
|
|
- 59、北京尚德机构在线教育有限公司
|
|
|
|
|
- ……
|
|
|
|
|
|
|
|
|
|
> 更多接入的公司，欢迎在 [登记地址](https://github.com/xuxueli/xxl-job/issues/1 ) 登记，登记仅仅为了产品推广。
|
|
|
|
|
@ -181,6 +186,7 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
：xxl-job-executor-sample-spring：Spring版本，通过Spring容器管理执行器，比较通用，推荐这种方式；
|
|
|
|
|
：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器；
|
|
|
|
|
：xxl-job-executor-sample-jfinal：JFinal版本，通过JFinal管理执行器；
|
|
|
|
|
：xxl-job-executor-sample-nutz：Nutz版本，通过Nutz管理执行器；
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### 2.3 配置部署“调度中心”
|
|
|
|
|
@ -226,15 +232,17 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
至此“调度中心”项目已经部署成功。
|
|
|
|
|
|
|
|
|
|
#### 步骤三：调度中心集群（可选）：
|
|
|
|
|
调度中心支持集群部署，提升调度系统可用性。
|
|
|
|
|
|
|
|
|
|
集群部署唯一要求为：保证每个集群节点配置（db和登陆账号等）保持一致。调度中心通过db配置区分不同集群。
|
|
|
|
|
调度中心支持集群部署，提升调度系统容灾和可用性。
|
|
|
|
|
|
|
|
|
|
调度中心在集群部署时可通过nginx负载均衡，此时可以为集群分配一个域名。该域名一方面可以用于访问，另一方面也可以用于配置执行器回调地址。
|
|
|
|
|
调度中心集群部署时，几点要求和建议：
|
|
|
|
|
- DB配置保持一致；
|
|
|
|
|
- 登陆账号配置保持一致；
|
|
|
|
|
- 集群机器时钟保持一致（单机集群忽视）；
|
|
|
|
|
- 建议：推荐通过nginx为调度中心集群做负载均衡，分配域名。调度中心访问、执行器回调配置、调用API服务等操作均通过该域名进行。
|
|
|
|
|
|
|
|
|
|
### 2.4 配置部署“执行器项目”
|
|
|
|
|
|
|
|
|
|
“执行器”项目：xxl-job-executor-sample-spring (如新建执行器项目，可参考该Sample示例执行器项目的配置步骤；)
|
|
|
|
|
“执行器”项目：xxl-job-executor-sample-spring (提供多种版本执行器供选择，现以Spring版本为例，可直接使用，也可以参考其并将现有项目改造成执行器)
|
|
|
|
|
作用：负责接收“调度中心”的调度并执行；可直接部署执行器，也可以将执行器集成到现有业务项目中。
|
|
|
|
|
|
|
|
|
|
#### 步骤一：maven依赖
|
|
|
|
|
@ -278,15 +286,15 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
<bean id="xxlJobExecutor" class="com.xxl.job.core.executor.XxlJobExecutor" init-method="start" destroy-method="destroy" >
|
|
|
|
|
<!-- 执行器IP[选填]，为空则自动获取 -->
|
|
|
|
|
<property name="ip" value="${xxl.job.executor.ip}" />
|
|
|
|
|
<!-- 执行器端口号[必须] -->
|
|
|
|
|
<!-- 执行器端口号[选填]，为空则自动获取 -->
|
|
|
|
|
<property name="port" value="${xxl.job.executor.port}" />
|
|
|
|
|
<!-- 执行器AppName[选填]，为空则关闭自动注册 -->
|
|
|
|
|
<property name="appName" value="${xxl.job.executor.appname}" />
|
|
|
|
|
<!-- 执行器注册中心地址[选填]，为空则关闭自动注册 -->
|
|
|
|
|
<property name="adminAddresses" value="${xxl.job.admin.addresses}" />
|
|
|
|
|
<!-- 执行器日志路径[必填] -->
|
|
|
|
|
<!-- 执行器日志路径[选填]，为空则使用默认路径 -->
|
|
|
|
|
<property name="logPath" value="${xxl.job.executor.logpath}" />
|
|
|
|
|
<!-- 访问令牌，非空则进行匹配校验[选填] -->
|
|
|
|
|
<!-- 访问令牌[选填]，非空则进行匹配校验 -->
|
|
|
|
|
<property name="accessToken" value="${xxl.job.accessToken}" />
|
|
|
|
|
</bean>
|
|
|
|
|
```
|
|
|
|
|
@ -316,7 +324,8 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### 步骤二：“GLUE模式(Java)” 任务开发：
|
|
|
|
|
请点击任务右侧 “GLUE” 按钮，进入 “GLUE编辑器开发界面” ，见下图。“GLUE模式(Java)” 运行模式的任务默认已经初始化了示例任务代码，即打印Hello World。
|
|
|
|
|
@ -365,14 +374,14 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
GLUE模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "python" 脚本；
|
|
|
|
|
GLUE模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "nodejs" 脚本；
|
|
|
|
|
- JobHandler：运行模式为 "BEAN模式" 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值；
|
|
|
|
|
- 子任务Key：每个任务都拥有一个唯一的任务Key(任务Key可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务Key所对应的任务的一次主动调度。
|
|
|
|
|
- 子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。
|
|
|
|
|
- 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
|
|
|
|
|
单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
|
|
|
|
|
丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
|
|
|
|
|
覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
|
|
|
|
|
- 失败处理策略；调度失败时的处理策略；
|
|
|
|
|
失败告警（默认）：调度失败时，将会触发失败报警，如发送报警邮件；
|
|
|
|
|
失败重试：调度失败时，将会主动进行一次失败重试调度，重试调度后仍然失败将会触发一失败告警。注意当任务以failover方式路由时，每次失败重试将会触发新一轮路由。
|
|
|
|
|
失败告警（默认）：调度失败和执行失败时，都将会触发失败报警，默认会发送报警邮件；
|
|
|
|
|
失败重试：调度失败时，除了进行失败告警之外，将会自动重试一次；注意在执行失败时不会重试，而是根据回调返回值判断是否重试；
|
|
|
|
|
- 执行参数：任务执行所需的参数，多个参数时用逗号分隔，任务执行时将会把多个参数转换成数组传入；
|
|
|
|
|
- 报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；
|
|
|
|
|
- 负责人：任务的负责人；
|
|
|
|
|
@ -381,9 +390,11 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
任务逻辑以JobHandler的形式存在于“执行器”所在项目中，开发流程如下：
|
|
|
|
|
|
|
|
|
|
#### 步骤一：执行器项目中，开发JobHandler：
|
|
|
|
|
- 1、 新建一个继承com.xxl.job.core.handler.IJobHandler的Java类；
|
|
|
|
|
- 2、 该类被Spring容器扫描为Bean实例，如加“@Component”注解；
|
|
|
|
|
- 3、 添加 “@JobHandler(value="自定义jobhandler名称")”注解，注解的value值为自定义的JobHandler名称，该名称对应的是调度中心新建任务的JobHandler属性的值。
|
|
|
|
|
|
|
|
|
|
- 1、继承"IJobHandler"：“com.xxl.job.core.handler.IJobHandler”；
|
|
|
|
|
- 2、注册到Spring容器：添加“@Component”注解，被Spring容器扫描为Bean实例；
|
|
|
|
|
- 3、注册到执行器工厂：添加“@JobHandler(value="自定义jobhandler名称")”注解，注解value值对应的是调度中心新建任务的JobHandler属性的值。
|
|
|
|
|
- 4、执行日志：需要通过 "XxlJobLogger.log" 打印执行日志；
|
|
|
|
|
（可参考Sample示例执行器中的DemoJobHandler，见下图）
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
@ -391,7 +402,7 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
#### 步骤二：调度中心，新建调度任务
|
|
|
|
|
参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 "BEAN模式"，JobHandler属性填写任务注解“@JobHandler”中定义的值；
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### 3.2 GLUE模式(Java)
|
|
|
|
|
任务以源码方式维护在调度中心，支持通过Web IDE在线更新，实时编译和生效，因此不需要指定JobHandler。开发流程如下：
|
|
|
|
|
@ -399,7 +410,7 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
#### 步骤一：调度中心，新建调度任务：
|
|
|
|
|
参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 "GLUE模式(Java)"；
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### 步骤二：开发任务代码：
|
|
|
|
|
选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发（也可以在IDE中开发完成后，复制粘贴到编辑中）。
|
|
|
|
|
@ -453,7 +464,8 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
2、"执行器列表" 中显示在线的执行器列表, 可通过"OnLine 机器"查看对应执行器的集群机器。
|
|
|
|
|
|
|
|
|
|
点击按钮 "+新增执行器" 弹框如下图, 可新增执行器配置:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
### 执行器属性说明
|
|
|
|
|
|
|
|
|
|
@ -493,7 +505,7 @@ XXL-JOB是一个轻量级分布式任务调度框架，其核心设计目标是
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
调度时间："调度中心"触发本次调度并向"执行器"发送任务执行信号的时间；
|
|
|
|
|
调度结果："调度中心"触发本次调度的结果，200表示成功，500或其他表示失败；
|
|
|
|
|
@ -677,7 +689,6 @@ xxl-job-admin#com.xxl.job.admin.controller.JobApiController.callback
|
|
|
|
|
执行器如若集群部署，调度中心将会感知到在线的所有执行器，如“127.0.0.1:9997, 127.0.0.1:9998, 127.0.0.1:9999”。
|
|
|
|
|
|
|
|
|
|
当任务"路由策略"选择"故障转移(FAILOVER)"时，当调度中心每次发起调度请求时，会按照顺序对执行器发出心跳检测请求，第一个检测为存活状态的执行器将会被选定并发送调度请求。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
调度成功后，可在日志监控界面查看“调度备注”，如下；
|
|
|
|
|
|
|
|
|
|
@ -688,12 +699,10 @@ xxl-job-admin#com.xxl.job.admin.controller.JobApiController.callback
|
|
|
|
|
#### 5.4.9 调度日志
|
|
|
|
|
调度中心每次进行任务调度，都会记录一条任务日志，任务日志主要包括以下三部分内容：
|
|
|
|
|
|
|
|
|
|
- 任务信息：包括“执行器地址”、“JobHandler”和“执行参数”等属性，根据这些参数，可以精确的定位任务执行的具体机器和任务代码；
|
|
|
|
|
- 任务信息：包括“执行器地址”、“JobHandler”和“执行参数”等属性，点击任务ID按钮可查看，根据这些参数，可以精确的定位任务执行的具体机器和任务代码；
|
|
|
|
|
- 调度信息：包括“调度时间”、“调度结果”和“调度日志”等，根据这些参数，可以了解“调度中心”发起调度请求时具体情况。
|
|
|
|
|
- 执行信息：包括“执行时间”、“执行结果”和“执行日志”等，根据这些参数，可以了解在“执行器”端任务执行的具体情况；
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
调度日志，针对单次调度，属性说明如下：
|
|
|
|
|
- 执行器地址：任务执行的机器地址；
|
|
|
|
|
- JobHandler：Bean模式表示任务执行的JobHandler名称；
|
|
|
|
|
@ -707,9 +716,9 @@ xxl-job-admin#com.xxl.job.admin.controller.JobApiController.callback
|
|
|
|
|
- 执行日志：任务执行过程中，业务代码中打印的完整执行日志，见“4.7 查看执行日志”；
|
|
|
|
|
|
|
|
|
|
#### 5.4.10 任务依赖
|
|
|
|
|
原理：XXL-JOB中每个任务都对应有一个任务Key，同时，每个任务支持设置属性“子任务Key”，因此，通过“任务Key”可以匹配任务依赖关系。
|
|
|
|
|
原理：XXL-JOB中每个任务都对应有一个任务ID，同时，每个任务支持设置属性“子任务ID”，因此，通过“任务ID”可以匹配任务依赖关系。
|
|
|
|
|
|
|
|
|
|
当父任务执行结束并且执行成功时，将会根据“子任务Key”匹配子任务依赖，如果匹配到子任务，将会主动触发一次子任务的执行。
|
|
|
|
|
当父任务执行结束并且执行成功时，将会根据“子任务ID”匹配子任务依赖，如果匹配到子任务，将会主动触发一次子任务的执行。
|
|
|
|
|
|
|
|
|
|
在任务日志界面，点击任务的“执行备注”的“查看”按钮，可以看到匹配子任务以及触发子任务执行的日志信息，如无信息则表示未触发子任务执行，可参考下图。
|
|
|
|
|
|
|
|
|
|
@ -738,9 +747,7 @@ xxl-job-admin#com.xxl.job.admin.controller.JobApiController.callback
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#### 5.5.4 执行器
|
|
|
|
|
执行器实际上是一个内嵌的Jetty服务器，默认端口9999，如下图配置文件所示（参数：xxl.job.executor.port）。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
执行器实际上是一个内嵌的Jetty服务器，默认端口9999（配置项：xxl.job.executor.port）。
|
|
|
|
|
|
|
|
|
|
在项目启动时，执行器会通过“@JobHandler”识别Spring容器中“Bean模式任务”，以注解的value属性为key管理起来。
|
|
|
|
|
|
|
|
|
|
@ -786,11 +793,21 @@ XXL-JOB会为每次调度请求生成一个单独的日志文件，需要通过
|
|
|
|
|
|
|
|
|
|
"分片广播" 以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度。
|
|
|
|
|
|
|
|
|
|
"分片广播" 和普通任务开发流程一致，不同之处在于可以可以获取分片参数，获取分片参数对象的代码如下（可参考Sample示例执行器中的示例任务"ShardingJobHandler" ）：
|
|
|
|
|
"分片广播" 和普通任务开发流程一致，不同之处在于可以可以获取分片参数，获取分片参数进行分片业务处理。
|
|
|
|
|
|
|
|
|
|
ShardingUtil.ShardingVO shardingVO = ShardingUtil.getShardingVo();
|
|
|
|
|
- Java语言任务获取分片参数方式：BEAN、GLUE模式(Java)
|
|
|
|
|
```
|
|
|
|
|
// 可参考Sample示例执行器中的示例任务"ShardingJobHandler"了解试用
|
|
|
|
|
ShardingUtil.ShardingVO shardingVO = ShardingUtil.getShardingVo();
|
|
|
|
|
```
|
|
|
|
|
- 脚本语言任务获取分片参数方式：GLUE模式(Shell)、GLUE模式(Python)、GLUE模式(Nodejs)
|
|
|
|
|
```
|
|
|
|
|
// 脚本任务入参固定为三个，依次为：任务传参、分片序号、分片总数。以Shell模式任务为例，获取分片参数代码如下
|
|
|
|
|
echo "分片序号 index = $2"
|
|
|
|
|
echo "分片总数 total = $3"
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
该分片参数对象拥有两个属性：
|
|
|
|
|
分片参数属性说明：
|
|
|
|
|
|
|
|
|
|
index：当前分片序号(从0开始)，执行器集群列表中当前执行器的序号；
|
|
|
|
|
total：总分片数，执行器集群的总机器数量；
|
|
|
|
|
@ -819,7 +836,7 @@ XXL-JOB会为每次调度请求生成一个单独的日志文件，需要通过
|
|
|
|
|
|
|
|
|
|
调度中心API服务位置：com.xxl.job.core.biz.AdminBiz.java
|
|
|
|
|
|
|
|
|
|
调度中心API服务请求参考代码：com.xxl.job.dao.impl.AdminBizTest.java
|
|
|
|
|
调度中心API服务请求参考代码：com.xxl.job.adminbiz.AdminBizTest.java
|
|
|
|
|
|
|
|
|
|
### 5.12 执行器API服务
|
|
|
|
|
执行器提供了API服务，供调度中心选择使用，目前提供的API服务有：
|
|
|
|
|
@ -834,6 +851,15 @@ XXL-JOB会为每次调度请求生成一个单独的日志文件，需要通过
|
|
|
|
|
|
|
|
|
|
执行器API服务请求参考代码：com.xxl.executor.test.DemoJobHandlerTest
|
|
|
|
|
|
|
|
|
|
### 5.13 故障转移 & 失败重试
|
|
|
|
|
一次完整任务流程包括"调度（调度中心） + 执行（执行器）"两个阶段。
|
|
|
|
|
|
|
|
|
|
- "故障转移"发生在调度阶段，在执行器集群部署时，如果某一台执行器发生故障，该策略支持自动进行Failover切换到一台正常的执行器机器并且完成调度请求流程。
|
|
|
|
|
- "失败重试"发生在"调度 + 执行"两个阶段，如下：
|
|
|
|
|
- 调度中心调度失败时，任务失败处理策略选择"失败重试"，将会自动重试一次；
|
|
|
|
|
- 执行器运行失败时，任务执行结果返回"失败重试（IJobHandler.FAIL_RETRY）"回调，将会自动重试一次；
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 六、版本更新日志
|
|
|
|
|
### 6.1 版本 V1.1.x，新特性[2015-12-05]
|
|
|
|
|
**【于V1.1.x版本，XXL-JOB正式应用于我司，内部定制别名为 “Ferrari”，新接入应用推荐使用最新版本】**
|
|
|
|
|
@ -1049,40 +1075,51 @@ Tips: 历史版本(V1.3.x)目前已经Release至稳定版本, 进入维护阶段
|
|
|
|
|
- 10、任务日志文件路径时间戳格式化时SimpleDateFormat并发问题解决；
|
|
|
|
|
|
|
|
|
|
### 6.20 版本 V1.9.0 特性[迭代中]
|
|
|
|
|
- 1、新增任务运行模式 "GLUE模式(NodeJS) "，支持NodeJS脚本任务；
|
|
|
|
|
- 2、失败告警策略扩展：默认提供邮件失败告警，可扩展短信等，扩展代码位置为 "JobFailMonitorHelper.failAlarm"；
|
|
|
|
|
- 3、修复任务监控线程被耗时任务阻塞的问题；
|
|
|
|
|
- 4、修复任务监控线程无法监控任务触发和执行状态均未0的问题；
|
|
|
|
|
- 5、调度中心项目日志配置改为xml文件格式；
|
|
|
|
|
- 6、执行器动态代理对象，拦截非业务方法的执行；
|
|
|
|
|
- 7、底层系统日志级别规范调整，清理遗留代码；
|
|
|
|
|
- 8、修改JobThread捕获Error错误不更新JobLog的问题；
|
|
|
|
|
- 9、任务注解调整为 “@JobHandler”，与任务注解统一；
|
|
|
|
|
- 10、执行器端口支持随机生成(小于等于0时)，避免端口定义冲突；
|
|
|
|
|
- 11、任务Cron长度扩展支持至128位；
|
|
|
|
|
- 12、调度报表优化，支持时间区间筛选；
|
|
|
|
|
- 1、新增Nutz执行器Sample示例项目；
|
|
|
|
|
- 2、新增任务运行模式 "GLUE模式(NodeJS) "，支持NodeJS脚本任务；
|
|
|
|
|
- 3、脚本任务Shell、Python和Nodejs等支持获取分片参数；
|
|
|
|
|
- 4、失败重试，完整支持：调度中心调度失败且启用"失败重试"策略时，将会自动重试一次；执行器执行失败且回调失败重试状态（新增失败重试状态返回值）时，也将会自动重试一次；
|
|
|
|
|
- 5、失败告警策略扩展：默认提供邮件失败告警，可扩展短信等，扩展代码位置为 "JobFailMonitorHelper.failAlarm"；
|
|
|
|
|
- 6、执行器端口支持自动生成(小于等于0时)，避免端口定义冲突；
|
|
|
|
|
- 7、调度报表优化，支持时间区间筛选；
|
|
|
|
|
- 8、Log组件支持输出异常栈信息，底层实现优化；
|
|
|
|
|
- 9、告警邮件样式优化，调整为表格形式，邮件组件调整为commons-email简化邮件操作；
|
|
|
|
|
- 10、项目依赖升级，如spring、jackson等；
|
|
|
|
|
- 11、任务日志，记录发起调度的机器信息；
|
|
|
|
|
- 12、交互优化，如登陆注销；
|
|
|
|
|
- 13、任务Cron长度扩展支持至128位，支持负责类型Cron设置；
|
|
|
|
|
- 14、执行器地址录入交互优化，地址长度扩展支持至512位，支持大规模执行器集群配置；
|
|
|
|
|
- 15、任务参数“IJobHandler.execute”入参改为“String params”，增强入参通用性。
|
|
|
|
|
- 16、JobHandler提供init/destroy方法，支持在JobHandler初始化和销毁时进行附加操作；
|
|
|
|
|
- 17、任务注解调整为 “@JobHandler”，与任务抽象接口统一；
|
|
|
|
|
- 18、修复任务监控线程被耗时任务阻塞的问题；
|
|
|
|
|
- 19、修复任务监控线程无法监控任务触发和执行状态均未0的问题；
|
|
|
|
|
- 20、执行器动态代理对象，拦截非业务方法的执行；
|
|
|
|
|
- 21、修复JobThread捕获Error错误不更新JobLog的问题；
|
|
|
|
|
- 22、修复任务列表界面左侧菜单合并时样式错乱问题；
|
|
|
|
|
- 23、调度中心项目日志配置改为xml文件格式；
|
|
|
|
|
- 24、Log地址格式兼容，支持非"/"结尾路径配置；
|
|
|
|
|
- 25、底层系统日志级别规范调整，清理遗留代码；
|
|
|
|
|
- 26、建表SQL优化，支持同步创建制定编码的库和表；
|
|
|
|
|
- 27、系统安全性优化，登陆Token写Cookie时进行MD5加密，同时Cookie启用HttpOnly；
|
|
|
|
|
- 28、新增"任务ID"属性，移除"JobKey"属性，前者承担所有功能，方便后续增强任务依赖功能。
|
|
|
|
|
- 29、任务循环依赖问题修复，避免子任务与父任务重复导致的调度死循环；
|
|
|
|
|
|
|
|
|
|
### TODO LIST
|
|
|
|
|
- 1、任务权限管理：执行器为粒度分配权限，核心操作校验权限；
|
|
|
|
|
- 2、任务分片路由：分片采用一致性Hash算法计算出尽量稳定的分片顺序，即使注册机器存在波动也不会引起分批分片顺序大的波动；目前采用IP自然排序，可以满足需求，待定；
|
|
|
|
|
- 3、失败重试完整支持：任务流程分为触发和执行，目前仅支持触发失败的重试；后续支持任务执行失败的重试，通过任务返回值判断。
|
|
|
|
|
- 3、任务单机多线程：提升任务单机并行处理能力；
|
|
|
|
|
- 4、回调失败丢包问题：执行器回调失败写文件，重启或周期性回调重试；调度中心周期性请求并同步未回调的执行结果；
|
|
|
|
|
- 5、任务依赖，流程图，子任务+会签任务，各节点日志；
|
|
|
|
|
- 6、调度任务优先级；
|
|
|
|
|
- 7、移除quartz依赖，重写调度模块：新增或恢复任务时将下次执行记录插入delayqueue，调度中心集群竞争分布式锁，成功节点批量加载到期delayqueue数据，批量执行。
|
|
|
|
|
- 8、springboot 和 docker镜像，并且推送docker镜像到中央仓库，更进一步实现产品开箱即用；
|
|
|
|
|
- 9、国际化：调度中心界面。
|
|
|
|
|
- 10、任务类方法"IJobHandler.execute"的参数类型改为"string"，进一步方便参数传递；任务注解和任务类统一并改为"JobHandler"";
|
|
|
|
|
- 11、任务日志，记录发起调度的机器信息；
|
|
|
|
|
- 12、任务告警逻辑调整：任务调度，以及任务回调失败时，均推送监控队列。后期考虑通过任务Log字段控制告警状态；
|
|
|
|
|
- 13、执行器Log清理功能：调度中心Log删除时同步删除执行器中的Log文件；
|
|
|
|
|
- 14、脚本任务 Shell、Python和Nodejs，如何友好获取分片参数；
|
|
|
|
|
- 15、Bean模式任务，JobHandler自动从执行器中查询展示为下拉框，选择后自动填充任务名称等属性；
|
|
|
|
|
- 16、任务告警邮件优化，调整为表格形式；
|
|
|
|
|
- 17、JobHandler提供 init/destroy 方法，支持自定义任务线程销毁逻辑；
|
|
|
|
|
- 18、cron表达式的最大长度调整，兼容复杂类型cron；
|
|
|
|
|
- 19、执行器回调地址/日志地址格式兼容，是否已"/"结尾均支持；
|
|
|
|
|
- 20、任务单机多线程：提升任务单机并行处理能力；
|
|
|
|
|
- 10、任务告警逻辑调整：任务调度，以及任务回调失败时，均推送监控队列。后期考虑通过任务Log字段控制告警状态；
|
|
|
|
|
- 11、执行器Log清理功能：调度中心Log删除时同步删除执行器中的Log文件；
|
|
|
|
|
- 12、Bean模式任务，JobHandler自动从执行器中查询展示为下拉框，选择后自动填充任务名称等属性；
|
|
|
|
|
- 13、API事件触发类型任务（更类似MQ消息）支持"动态传参、延时消费"；该类型任务不走Quartz，单独建立MQ消息表，调度中心竞争触发；
|
|
|
|
|
- 14、任务依赖增强，新增任务类型 "流程任务"，流程节点可挂载普通类型任务，承担任务依赖功能。现有子任务模型取消；需要考虑任务依赖死循环问题；
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## 七、其他
|
|
|
|
|
|
thinking_fioa
7 years ago
committed by
GitHub