XXL-JOB

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

文章目录

• • 《分布式任务调度平台XXL-JOB》
  • 一、简介
  • • 1.1 概述
    • 1.2 区交流
    • 1.3 特性
    • 1.4 发展
    • 1.5 下载
    • • 文档地址
      • 源码仓库地址
      • 中央仓库地址
    • 1.6 环境
  • 二、快速入门
  • • 2.1 初始化“调度数据库”
    • 2.2 编译源码
    • 2.3 配置部署“调度中心”
    • • 步骤一：调度中心配置：
      • 步骤二：部署项目：
      • 步骤三：调度中心集群（可选）：
      • 其他：Docker 镜像方式搭建调度中心：
    • 2.4 配置部署“执行器项目”
    • • 步骤一：maven依赖
      • 步骤二：执行器配置
      • 步骤三：执行器组件配置
      • 步骤四：部署执行器项目：
      • 步骤五：执行器集群（可选）：
    • 2.5 开发第一个任务“Hello World”
    • • 步骤一：新建任务：
      • 步骤二：“GLUE模式(Java)” 任务开发：
      • 步骤三：触发执行：
      • 步骤四：查看日志：
  • 三、任务详解
  • • 配置属性详细说明：
    • 3.1 BEAN模式（类形式）
    • • 步骤一：执行器项目中，开发Job类：
      • 步骤二：调度中心，新建调度任务
    • 3.2 BEAN模式（方法形式）
    • • 步骤一：执行器项目中，开发Job方法：
      • 步骤二：调度中心，新建调度任务
      • 原生内置Bean模式任务
    • 3.3 GLUE模式(Java)
    • • 步骤一：调度中心，新建调度任务：
      • 步骤二：开发任务代码：
    • 3.4 GLUE模式(Shell)
    • • 步骤一：调度中心，新建调度任务
      • 步骤二：开发任务代码：
    • 3.4 GLUE模式(Python)
    • • 步骤一：调度中心，新建调度任务
      • 步骤二：开发任务代码：
    • 3.5 GLUE模式(NodeJS)
    • • 步骤一：调度中心，新建调度任务
      • 步骤二：开发任务代码：
    • 3.6 GLUE模式(PHP)
    • 3.7 GLUE模式(PowerShell)
  • 四、操作指南
  • • 4.1 配置执行器
    • 4.2 新建任务
    • 4.5 启动/停止任务
    • 4.6 手动触发一次调度
    • 4.7 查看调度日志
    • 4.8 查看执行日志
    • 4.9 终止运行中的任务
    • 4.10 删除执行日志
    • 4.11 删除任务
    • 4.12 用户管理
  • 五、总体设计
  • • 5.1 源码目录介绍
    • 5.2 “调度数据库”配置
    • 5.3 架构设计
    • • 5.3.1 设计思想
      • 5.3.2 系统组成
      • 5.3.3 架构图
    • 5.4 调度模块剖析
    • • 5.4.1 quartz的不足
      • 5.4.2 自研调度模块
      • 5.4.3 调度中心HA（集群）
      • 5.4.4 调度线程池
      • 5.4.5 并行调度
      • 5.4.6 过期处理策略
      • 5.4.7 日志回调服务
      • 5.4.8 任务HA（Failover）
      • 5.4.9 调度日志
      • 5.4.10 任务依赖
      • 5.4.11 全异步化 & 轻量级
      • 5.4.12 均衡调度
    • 5.5 任务 “运行模式” 剖析
    • • 5.5.1 “Bean模式” 任务
      • 5.5.2 “GLUE模式(Java)” 任务
      • 5.5.3 GLUE模式(Shell) + GLUE模式(Python) + GLUE模式(PHP) + GLUE模式(NodeJS) + GLUE模式(Powershell)
      • 5.5.4 执行器
      • 5.5.5 任务日志
    • 5.6 通讯模块剖析
    • • 5.6.1 一次完整的任务调度通讯流程
      • 5.6.2 通讯数据加密
    • 5.7 任务注册, 任务自动发现
    • 5.8 任务执行结果
    • 5.9 分片广播 & 动态分片
    • 5.10 访问令牌（AccessToken）
    • 5.11 故障转移 & 失败重试
    • 5.12 执行器灰度上线
    • 5.13 任务执行结果说明
    • 5.14 任务超时控制
    • 5.15 跨语言
    • 5.16 任务失败告警
    • 5.17 调度中心Docker镜像构建
    • 5.20 避免任务重复执行
    • 5.21 命令行任务
    • 5.22 日志自动清理
    • 5.23 调度结果丢失处理
  • 六、调度中心/执行器 RESTful API
  • • 6.1 调度中心 RESTful API
    • • a、任务回调
      • b、执行器注册
      • c、执行器注册摘除
    • 6.2 执行器 RESTful API
    • • a、心跳检测
      • b、忙碌检测
      • c、触发任务
      • f、终止任务
      • d、查看执行日志
  • 七、版本更新日志
  • • 7.1 版本 V1.1.x，新特性[2015-12-05]
    • 7.2 版本 V1.2.x，新特性[2016-01-17]
    • 7.3 版本 V1.3.0，新特性[2016-05-19]
    • 7.4 版本 V1.3.1，新特性[2016-05-23]
    • 7.5 版本 V1.3.2，新特性[2016-05-28]
    • 7.6 版本 V1.4.0 新特性[2016-07-24]
    • 7.7 版本 V1.4.1 新特性[2016-09-06]
    • 7.8 版本 V1.4.2 新特性[2016-09-29]
    • 7.9 版本 V1.5.0 特性[2016-11-13]
    • 7.10 版本 V1.5.1 特性[2016-11-13]
    • 7.11 版本 V1.5.2 特性[2017-02-28]
    • 7.12 版本 V1.6.0 特性[2017-03-13]
    • 7.13 版本 V1.6.1 特性[2017-03-25]
    • 7.14 版本 V1.6.2 特性[2017-04-25]
    • 7.15 版本 V1.7.0 特性[2017-05-02]
    • 7.16 版本 V1.7.1 特性[2017-05-08]
    • 7.17 版本 V1.7.2 特性[2017-05-17]
    • 7.18 版本 V1.8.0 特性[2017-07-17]
    • 7.19 版本 V1.8.1 特性[2017-07-30]
    • 7.20 版本 V1.8.2 特性[2017-09-04]
    • 7.21 版本 V1.9.0 特性[2017-12-29]
    • 7.22 版本 V1.9.1 特性[2018-02-22]
    • 7.23 版本 V1.9.2 特性[2018-10-05]
    • 7.24 版本 V2.0.0 Release Notes[2018-11-04]
    • 7.25 版本 v2.0.1 Release Notes[2018-11-09]
    • 7.26 版本 v2.0.2 Release Notes[2019-04-20]
    • 7.27 版本 v2.1.0 Release Notes[2019-07-07]
    • 7.28 版本 v2.1.1 Release Notes[2019-11-24]
    • 7.29 版本 v2.1.2 Release Notes[2019-12-12]
    • 7.30 版本 v2.2.0 Release Notes[2020-04-14]
    • 7.31 版本 v2.3.0 Release Notes[2021-02-09]
    • 7.32 版本 v2.4.0 Release Notes[规划中]
    • TODO LIST
  • 八、其他
  • • 8.1 项目贡献
    • 8.2 用户接入登记
    • 8.3 开源协议和版权
    • 捐赠

一、简介

1.1 概述

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

1.2 区交流

• 区交流

1.3 特性

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

1.4 发展

于2015年中，我在github上创建XXL-JOB项目仓库并提交第一个commit，随之进行系统结构设计，UI选型，交互设计……

于2015-11月，XXL-JOB终于RELEASE了第一个大版本V1.0， 随后我将之发布到OSCHINA，XXL-JOB在OSCHINA上获得了@红薯的热门推荐，同期分别达到了OSCHINA的“热门动弹”排行第一和git.oschina的开源软件月热度排行第一，在此特别感谢红薯，感谢大家的关注和支持。

于2015-12月，我将XXL-JOB发表到我司内部知识库，并且得到内部同事认可。

于2016-01月，我司展开XXL-JOB的内部接入和定制工作，在此感谢袁某和尹某两位同事的贡献，同时也感谢内部其他给与关注与支持的同事。

于2017-05-13，在上海举办的 “第62期开源中国源创会” 的 “放码过来” 环节，我登台对XXL-JOB做了演讲，台下五百位在场观众反响热烈（图文回顾 ）。

于2017-10-22，又拍云 Open Talk 联合 Spring Cloud 中国 区举办的 “进击的微服务实战派上海站”，我登台对XXL-JOB做了演讲，现场观众反响热烈并在会后与XXL-JOB用户热烈讨论交流。

于2017-12-11，XXL-JOB有幸参会《InfoQ ArchSummit全球架构师峰会》，并被拍拍贷架构总监”杨波老师”在专题 “微服务原理、基础架构和开源实践” 中现场介绍。

于2017-12-18，XXL-JOB参与”2017年度最受欢迎中国开源软件”评比，在当时已录入的约九千个国产开源项目中角逐，最终进入了前30强。

于2018-01-15，XXL-JOB参与”2017码云最火开源项目”评比，在当时已录入的约六千五百个码云项目中角逐，最终进去了前20强。

于2018-04-14，iTechPlus在上海举办的 “2018互联 开发者大会”，我登台对XXL-JOB做了演讲，现场观众反响热烈并在会后与XXL-JOB用户热烈讨论交流。

于2018-05-27，在上海举办的 “第75期开源中国源创会” 的 “架构” 主题专场，我登台进行“基础架构与中间件图谱”主题演讲，台下上千位在场观众反响热烈（图文回顾 ）。

于2018-12-05，XXL-JOB参与”2018年度最受欢迎中国开源软件”评比，在当时已录入的一万多个开源项目中角逐，最终排名第19名。

于2019-12-10，XXL-JOB参与”2019年度最受欢迎中国开源软件”评比，在当时已录入的一万多个开源项目中角逐，最终排名”开发框架和基础组件类”第9名。

于2020-11-16，XXL-JOB参与”2020年度最受欢迎中国开源软件”评比，在当时已录入的一万多个开源项目中角逐，最终排名”开发框架和基础组件类”第8名。

我司大众点评目前已接入XXL-JOB，内部别名《Ferrari》（Ferrari基于XXL-JOB的V1.1版本定制而成，新接入应用推荐升级最新版本）。
据最新统计, 自2016-01-21接入至2017-12-01期间，该系统已调度约100万次，表现优异。新接入应用推荐使用最新版本，因为经过数十个版本的更新，系统的任务模型、UI交互模型以及底层调度通讯模型都有了较大的优化和提升，核心功能更加稳定高效。

至今，XXL-JOB已接入多家公司的线上产品线，接入场景如电商业务，O2O业务和大数据作业等，截止最新统计时间为止，XXL-JOB已接入的公司包括不限于：