master
xueli.xue 8 years ago
parent f7e18606dd
commit 9b8b397798
  1. 252
      doc/XXL-JOB-1.4.x用户手册.md
  2. BIN
      doc/images/image001.png

@ -50,8 +50,6 @@ XXL-JOB是一个轻量级分布式任务调度框架,其核心设计目标是
- [git.osc地址](http://git.oschina.net/xuxueli0323/xxl-job)
- [用户手册地址,见源码“/doc”目录下](https://github.com/xuxueli/xxl-job/tree/master/doc)
![image](./images/image001.png)
博客地址
- [oschina地址](http://my.oschina.net/xuxueli/blog/690978)
@ -61,229 +59,121 @@ XXL-JOB是一个轻量级分布式任务调度框架,其核心设计目标是
技术交流群(仅作技术交流):367260654 [![image](http://pub.idqqimg.com/wpa/images/group.png)](http://shang.qq.com/wpa/qunwpa?idkey=4686e3fe01118445c75673a66b4cc6b2c7ce0641528205b6f403c179062b0a52 )
Tips: 历史Release版本下载位置如下图所示,请自行前往进行选择和下载。
![输入图片说明](https://static.oschina.net/uploads/img/201607/23221244_nq9a.png "在这里输入图片标题")
#### 1.5 环境
- Maven3+
- Jdk1.7+
- Tomcat7+
- Mysql5.5+
#### 1.4 接入登记
更多接入公司,欢迎在https://github.com/xuxueli/xxl-job/issues/1 登记。
#### 1.5 报告问题
XXL-JOB托管在Github上,如有问题可在ISSUES上提问,也可以加入技术交流群(仅作技术交流):367260654 
#### 1.6 源码目录说明
- /xxl-job-admin 【调度中心】:负责管理调度信息,按照调度配置发出调度请求;
- /xxl-job-core 公共依赖
- /xxl-job-executor-example 【执行器】:负责接收调度请求并执行任务逻辑;
- /db 建表脚本
- /doc 用户手册
## 二 总体设计
#### 2.1 架构图
![XXL-JOB架构图](https://static.oschina.net/uploads/img/201606/14125314_NHk8.png "XXL-JOB架构图")
#### 2.2 设计思想
将调度行为抽象形成“调度中心”公共平台,而平台自身并不承担业务逻辑,“调度中心”负责发起调度请求。
将任务抽象成分散的JobHandler,交由“执行器”统一管理,“执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑。
## 二、快速入门
因此,“调度”和“任务”两部分可以相互解耦,提高系统整体稳定性和扩展性;
#### 2.1 初始化“调度数据库”
请下载项目源码并解压,获取 "调度数据库初始化SQL脚本"(脚本文件为: 源码解压根目录\xxl-job\db\tables_xxl_job.sql) 并执行即可。
#### 2.3 系统组成
**调度模块(调度中心)**:负责管理调度信息,按照调度配置发出调度请求,自身不承担业务代码。调度系统与任务解耦,提高了系统可用性和稳定性,同时调度系统性能不再受限于任务模块;
正常情况下,应该生成如下图所示14张表;
![输入图片说明](https://static.oschina.net/uploads/img/201607/23221308_DDW8.png "在这里输入图片标题")
支持可视化、简单且动态的维管理调度信息,包括任务新建,更新,删除,GLUE开发和任务报警等,所有上述操作都会实时生效,同时支持监控调度结果以及执行日志,支持执行器Failover。
#### 2.2 编译源码
解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可,源码结构如下图所示:
**执行模块(执行器)**:负责接收调度请求并执行任务逻辑。任务模块专注于任务的执行等操作,开发和维护更加简单和高效;
![输入图片说明](https://static.oschina.net/uploads/img/201607/23222522_JGCc.png "在这里输入图片标题")
支持接收“调度中心”的执行请求、终止请求和日志请求等。
- xxl-job-admin:调度中心
- xxl-job-core:公共依赖
- xxl-job-executor-example:执行器(可直接使用该执行器,也可以将现有项目改造成执行器使用)
## 三 实现原理
#### 3.1 quartz的不足
Quartz作为开源作业调度中的佼佼者,是作业调度的首选。但是集群环境中Quartz采用API的方式对任务进行管理,从而可以避免上述问题,但是同样存在以下问题:
- 问题一:调用API的的方式操作任务,不人性化;
- 问题二:需要持久化业务QuartzJobBean到底层数据表中,系统侵入性相当严重。
- 问题三:调度逻辑和QuartzJobBean耦合在同一个项目中,这将导致一个问题,在调度任务数量逐渐增多,同时调度任务逻辑逐渐加重的情况加,此时调度系统的性能将大大受限于业务;
#### 2.3 配置部署“调度中心”
调度中心项目:xxl-job-admin
XXL-JOB的调度中心基于Quartz实现,弥补了quartz的上述不足之处
作用:统一管理任务调度平台上调度任务,负责触发调度执行。
#### 3.2 RemoteHttpJobBean
常规Quartz的开发,任务逻辑一般维护在QuartzJobBean中,耦合很严重。XXL-JOB中“调度模块”和“任务模块”完全解耦,调度模块中的所有调度任务使用同一个QuartzJobBean,即RemoteHttpJobBean。不同的调度任务将各自参数维护在各自扩展表数据中,当触发RemoteHttpJobBean执行时,将会解析不同的任务参数发起远程调用,调用各自的远程执行器服务。这种调用模型类似RPC调用,RemoteHttpJobBean提供调用代理的功能,而执行器提供远程服务的功能。
- **A:配置调度中心JDBC链接**:请在下图所示位置配置jdbc链接地址,链接地址请保持和 2.1章节 所创建的调度数据库的地址一致。
#### 3.3 调度中心HA(集群)
基于Quartz的集群方案,数据库选用Mysql;集群分布式并发环境中使用QUARTZ定时任务调度,会在各个节点会上报任务,存到数据库中,执行时会从数据库中取出触发器来执行,如果触发器的名称和执行时间相同,则只有一个节点去执行此任务。
![输入图片说明](https://static.oschina.net/uploads/img/201607/23222438_wZv9.png "在这里输入图片标题")
![输入图片说明](https://static.oschina.net/uploads/img/201606/14125524_GxS9.png "在这里输入图片标题")
- **B:配置报警邮箱和登陆账号**:请在下图所示位置,设置自己的报警邮件发送邮箱和登陆账号密码。
#### 3.4 调度线程池
默认线程池中线程的数量为10个,避免单线程因阻塞而引起任务调度延迟。
![输入图片说明](https://static.oschina.net/uploads/img/201607/23223008_ArvZ.png "在这里输入图片标题")
![输入图片说明](https://static.oschina.net/uploads/img/201606/14125549_0Knr.png "在这里输入图片标题")
- **C:配置“调度中心”任务执行结果回调端口**:由于“调度中心”和“执行器”部署在不同项目中,“执行器”会请求该端口回调通知任务执行结果。如下图所示,默认回调服务端口号为8888。(此端口除非与现有端口冲突,可自行修改,否则可忽视)
#### 3.5 @DisallowConcurrentExecution
XXL-JOB调度模块的“调度中心”默认不使用该注解,即默认开启并行机制,因为RemoteHttpJobBean为公共QuartzJobBean,这样在多线程调度的情况下,调度模块被阻塞的几率很低,大大提高了调度系统的承载量。
![输入图片说明](https://static.oschina.net/uploads/img/201607/23223301_I03k.png "在这里输入图片标题")
XXL-JOB的每个调度任务虽然在调度模块是并行调度执行的,但是任务调度传递到任务模块的“执行器”确实串行执行的,同时支持任务终止
**部署项目**:如果已经正确进行上述配置,可将项目编译打war包并部署到tomcat中
#### 3.6 日志回调服务
调度模块的“调度中心”作为Web服务单独部署,除此之外,内部嵌入jetty服务器提供日志回调服务。
访问链接:http://localhost:8080/xxl-job-admin/ ,登陆界面如下图所示
“执行器”在接收到任务执行请求后,执行任务,在执行结束之后会将执行结果回调通知“调度中心”,如下图所示。
![输入图片说明](https://static.oschina.net/uploads/img/201607/23223648_b8Dx.png "在这里输入图片标题")
![输入图片说明](https://static.oschina.net/uploads/img/201606/14125628_qON8.png "在这里输入图片标题")
至此“调度中心”项目已经部署成功。
#### 3.7 任务HA(Failover)
如下图所示,任务“执行器地址”支持配置多个,用逗号分隔,如“127.0.0.1:9998,127.0.0.1:9999”。如果任务配置多个执行器地址,当调度中心每次发起调度请求时,会按照地址配置的顺序依次对执行器发出心跳检测请求,第一个检测为存活状态的执行器将会被选定。
#### 2.4 配置部署“执行器项目”
“执行器”项目:xxl-job-executor-example
![输入图片说明](https://static.oschina.net/uploads/img/201606/14125648_7kTR.png "在这里输入图片标题")
作用:负责接收“调度中心”的调度并执行;
调度成功后,可在日志监控界面查看执行日志;
- **A:配置Jdbc链接**:请在下图所示位置配置jdbc链接地址,链接地址请保持和 2.1章节 所创建的调度数据库的地址一致。
![输入图片说明](https://static.oschina.net/uploads/img/201606/14125703_xKWj.png "在这里输入图片标题")
![输入图片说明](https://static.oschina.net/uploads/img/201607/23224042_MeRg.png "在这里输入图片标题")
调度日志显示,任务配置的地址“227.0.0.1:9999,127.0.0.1:9999”,首先对第一个执行器地址“227.0.0.1:9999”进行心跳检测,心跳失败因此跳过;然后对第二个执行器地址“127.0.0.1:9999”进行心跳检测,心跳检测成功,选定为“目标执行器”;然后对“目标执行器”发送调度请求,调度流程结束,等待执行器回调执行结果
- **B:配置“执行器”端口**:由于“调度中心”和“执行器”部署在不同项目,“调度中心”会请求该端口触发任务执行。端口如下图所示,默认的“执行器”端口是9999,如果与系统现有端口冲突可自行修改,如若不冲突,可忽略
![输入图片说明](https://static.oschina.net/uploads/img/201606/14125738_xpGk.png "在这里输入图片标题")
![输入图片说明](https://static.oschina.net/uploads/img/201607/23224304_0jxT.png "在这里输入图片标题")
#### 3.8 调度日志组成
调度中心每次进行任务调度,都会记录一条任务日志,任务日志主要包括以下三部分内容:
- A、任务信息:包括“执行器地址”、“JobHandler”和“执行参数”等属性,根据这些参数,可以精确的定位任务执行的具体机器和任务代码;
- B、调度信息:包括“调度时间”、“调度结果”和“调度日志”等,根据这些参数,可以了解“调度中心”发起调度请求时具体情况。
- C、执行信息:包括“执行时间”、“执行结果”和“执行日志”等,根据这些参数,可以了解在“执行器”端任务执行的具体情况;
**部署项目**:如果已经正确进行上述配置,可将项目编译打war包并部署到tomcat中。
![输入图片说明](https://static.oschina.net/uploads/img/201606/14125801_9yfn.png "在这里输入图片标题")
至此“执行器”项目已经部署结束。
#### 3.9 Bean模式任务
开发步骤:
    - 1、开发一个继承“IJobHandler”的实现类,任务逻辑写在execute方法中;
    - 2、将任务类装配到Spring中,例如加 “@Service” 注解;
    - 3、在任务类上加 “@JobHander” 注解,定义注解的name属性值;
    (步骤3中定义的name属性值,在配置Bean模式任务时会用到)
#### 2.5 开发第一个任务“Hello World”
本示例为新建一个“GLUE模式任务”(“GLUE模式任务”的执行代码支持托管到调度中心在线维护,相比“Bean模式任务”需要在执行器项目开发部署上线,更加简便轻量)。更多有关任务的详细配置,请查看“章节三:任务详解”。
原理:
每个Bean模式任务都是一个Spring的Bean类实例,它被维护在“执行器”项目的Spring容器中。任务类需要加“@JobHander(name="名称")”注解,因为“执行器”会根据该注解识别Spring容器中的任务。任务类需要继承统一接口“IJobHandler”,任务逻辑在execute方法中开发,因为“执行器”在接收到调度中心的调度请求时,将会调用“IJobHandler”的execute方法,执行任务逻辑。
**前提:请确认“调度中心”和“执行器”项目已经成功部署并启动;**
#### 3.10 GLUE模式任务
开发步骤:GLUE模式任务的开发步骤比较简单,进入GLUE编辑界面,在Demo任务代码的execute方法中写入任务逻辑即可;可使用@Resource或@Autoward注解注入“执行器”项目中的Spring服务;
- **步骤一(新建任务)**:登陆调度中心,点击下图所示“新建任务”按钮,新建示例任务。然后,参考下面截图中任务的参数配置,点击保存。
原理:每个Glue任务的代码,实际上是“一个继承自“IJobHandler”的实现类的类代码”,“执行器”接收到“调度中心”的调度请求时,会通过Groovy类加载器加载此代码,实例化成Java对象,同时注入此代码中声明的Spring服务(请确保Glue代码中的服务和类引用在“执行器”项目中存在),然后调用该对象的execute方法,执行任务逻辑。
![输入图片说明](https://static.oschina.net/uploads/img/201607/23224905_MkGD.png "在这里输入图片标题")
#### 3.11 执行器
执行器实际上是一个内嵌的Jetty服务器,默认端口9999。
![输入图片说明](https://static.oschina.net/uploads/img/201607/23225207_GSeQ.png "在这里输入图片标题")
在项目启动时,执行器会通过“@JobHander”识别Spring容器中“Bean模式任务”,以注解的name属性为key管理起来。
- **步骤二(GLUE任务开发)**:请点击下图中所示“GLUE入口按钮”,进入“GLUE编辑器开发界面”,见下图。GLUE任务默认已经初始化了示例任务代码,即打印Hello World。
(GLUE实际上是一段继承自IJobHandler的Java类代码,它在执行器项目中运行,可使用@Resource/@Autowire注入执行器里中的其他服务,详细介绍请查看第三章节)
“执行器”接收到“调度中心”的调度请求时,如果任务类型为“Bean模式”,将会匹配Spring容器中的“Bean模式任务”,然后调用其execute方法,执行任务逻辑。如果任务类型为“GLUE模式”,将会加载GLue代码,实例化Java对象,注入依赖的Spring服务(注意:Glue代码中注入的Spring服务,必须存在与该“执行器”项目的Spring容器中),然后调用execute方法,执行任务逻辑。
![输入图片说明](https://static.oschina.net/uploads/img/201607/23225310_RYby.png "在这里输入图片标题")
![输入图片说明](https://static.oschina.net/uploads/img/201606/14125907_Eajh.png "在这里输入图片标题")
![输入图片说明](https://static.oschina.net/uploads/img/201607/23225327_Y1cn.png "在这里输入图片标题")
#### 3.12 任务日志
XXL-JOB会为每次调度请求生成一个单独的日志文件,通过重写LOG4J的Appender实现如下图的数据1处,“调度中心”查看执行日志时将会加载对应的日志文件。
- **步骤三(触发执行)**:点击下图所示“执行”按钮,可手动触发一次任务执行(通常情况下,通过配置Cron表达式进行任务调度出发)。
需要注意的是,“执行器”中日志Appender上配置的包名(如下图数据3处),需要覆盖到所有任务(Bean模式 + GLUE模式)的包名,否则覆盖不到的任务将不会生成日志文件。
![输入图片说明](https://static.oschina.net/uploads/img/201607/23225653_iY9K.png "在这里输入图片标题")
![输入图片说明](https://static.oschina.net/uploads/img/201606/14125931_Digy.png "在这里输入图片标题")
- **步骤四(查看日志)**
点击图2.5F所示“日志”按钮,可前往任务日志界面查看任务日志。
在如图2.5G的任务日志界面中,可查看任务调度状态,执行器接收到调度请求后的执行状态。
同时,点击如图2.5G中的“执行日志”按钮,可以查看本此调度在执行器端的完整执行日志,完整执行日志如图2.5H。
单独日志文件存放的位置可在“执行器”的log.xml文件进行自定义,如上图中的数字2的位置所示,默认位置为项目磁盘根目录下“/logs/xxl-job/”;
![输入图片说明](https://static.oschina.net/uploads/img/201607/23225953_7ey7.png "在这里输入图片标题")
(图2.5F:“调度中心”管理管理界面,任务日志入口)
目录格式为:/logs/xxl-job/ “格式化日期”/“数据库调度日志记录的主键ID . log”。
![输入图片说明](https://static.oschina.net/uploads/img/201607/23230953_BFVV.png "在这里输入图片标题")
(图2.5G:“调度中心”管理管理界面,任务日志入口)
#### 3.13 系统截图
登陆截图:
![输入图片说明](https://static.oschina.net/uploads/img/201607/23230416_2cLu.png "在这里输入图片标题")
(图2.5H:“调度中心”管理管理界面,任务日志入口)
![输入图片说明](https://static.oschina.net/uploads/img/201606/14125958_3lh1.png "在这里输入图片标题")
## 三、任务详解
#### 4.1 BEAN模式任务
Bean模式任务:任务逻辑以JobHandler的形式存在于“执行器”所在项目中,开发流程如下:
任务列表:
- **步骤一:开发JobHandler**
- 1. 新建一个继承com.xxl.job.core.handler.IJobHandler的Java类;
- 2. 该类被Spring容器扫描为Bean实例,如加“@Service注解”;
- 3. 添加 “@JobHander(value="自定义jobhandler名称")”注解,注解的value值为自定义的JobHandler名称,该名称对应的是调度中心新建任务的JobHandler属性的值。
(可参考xxl-job-executor-example项目中的DemoJobHandler,见下图)
![输入图片说明](https://static.oschina.net/uploads/img/201606/14130011_B19K.png "在这里输入图片标题")
![输入图片说明](https://static.oschina.net/uploads/img/201607/23232347_oLlM.png "在这里输入图片标题")
任务配置截图:
![输入图片说明](https://static.oschina.net/uploads/img/201606/14130021_CeGE.png "在这里输入图片标题")
在线开发任务GLUE代码,Wed IDE截图:
![输入图片说明](https://static.oschina.net/uploads/img/201606/14130036_tZPO.png "在这里输入图片标题")
## 四 版本更新
#### 4.1 版本 V1.1.x,新特性
**【于V1.1.x版本,XXL-JOB正式应用于我司,内部定制别名为 “Ferrari”,新接入应用推荐使用最新版本V1.3.x】**
- 1、简单:支持通过Web页面对任务进行CRUD操作,操作简单,一分钟上手;
- 2、动态:支持动态修改任务状态,动态暂停/恢复任务,即时生效;
- 3、服务HA:任务信息持久化到mysql中,Job服务天然支持集群,保证服务HA;
- 4、任务HA:某台Job服务挂掉,任务会平滑分配给其他的某一台存活服务,即使所有服务挂掉,重启时或补偿执行丢失任务;
- 5、一个任务只会在其中一台服务器上执行;
- 6、任务串行执行;
- 7、支持自定义参数;
- 8、支持远程任务执行终止;
#### 4.2 版本 V1.2.x,新特性
- 1、支持任务分组;
- 2、支持“本地任务”、“远程任务”;
- 3、底层通讯支持两种方式,Servlet方式 + JETTY方式;
- 4、支持“任务日志”;
- 5、支持“串行执行”,并行执行;
说明:V1.2版本将系统架构按功能拆分为:
- 调度模块(调度中心):负责管理调度信息,按照调度配置发出调度请求;
- 执行模块(执行器):负责接收调度请求并执行任务逻辑;
- 通讯模块:负责调度模块和任务模块之间的信息通讯;
优点:
- 解耦:任务模块提供任务接口,调度模块维护调度信息,业务相互独立;
- 高扩展性;
- 稳定性;
#### 4.3 版本 V1.3.0,新特性
- 1、遗弃“本地任务”模式,推荐使用“远程任务”,易于系统解耦,任务对应的JobHander统称为“执行器”;
- 2、遗弃“servlet”方式底层系统通讯,推荐使用JETTY方式,调度+回调双向通讯,重构通讯逻辑;
- 3、UI交互优化:左侧菜单展开状态优化,菜单项选中状态优化,任务列表打开表格有压缩优化;
- 4、【重要】“执行器”细分为:BEAN、GLUE两种开发模式,简介见下文:
“执行器” 模式简介:
- BEAN模式执行器:每个执行器都是Spring的一个Bean实例,XXL-JOB通过注解@JobHander识别和调度执行器;
-GLUE模式执行器:每个执行器对应一段代码,在线Web编辑和维护,动态编译生效,执行器负责加载GLUE代码和执行;
#### 4.4 版本 V1.3.1,新特性
- 1、更新项目目录结构:
- /xxl-job-admin -------------------- 【调度中心】:负责管理调度信息,按照调度配置发出调度请求;
- /xxl-job-core ----------------------- 公共依赖
- /xxl-job-executor-example ------ 【执行器】:负责接收调度请求并执行任务逻辑;
- /db ---------------------------------- 建表脚本
- /doc --------------------------------- 用户手册
- 2、在新的目录结构上,升级了用户手册;
- 3、优化了一些交互和UI;
#### 4.5 版本 V1.3.2,新特性
- 1、调度逻辑进行事务包裹;
- 2、执行器异步回调执行日志;
- 3、【重要】在 “调度中心” 支持HA的基础上,扩展执行器的Failover支持,支持配置多执行期地址;
#### 4.6 版本 V1.4.0 新特性
- 1、执行器底层实现代码进行重度重构, 优化底层建表脚本;
- 2、执行器中任务线程分组逻辑优化: 之前根据执行器JobHandler进行线程分组,当多个任务复用Jobhanlder会导致相互阻塞。现改为根据调度中心任务进行任务线程分组,任务与任务执行相互隔离;
- 3、执行器调度通讯方案优化, 通过Hex + HC实现建议RPC通讯协议, 优化了通讯参数的维护和解析流程;
- 4、调度中心, 新建/编辑任务, 界面属性调整:
- 4.1、任务新增/编辑界面中去除 "任务名JobName"属性 ,该属性改为系统自动生成: 该字段之前主要用于在 "调度中心" 唯一标示一个任务, 现实意义不大, 因此计划淡化掉该字段,改为系统生成UUID,从而简化任务新建的操作;
- 4.2、任务新增/编辑界面中去除 "GLUE模式" 复选框位置调整, 改为贴近"JobHandler"输入框右侧;
- 4.3、任务新增/编辑界面中去除 "报警阈值" 属性;
- 5、问题修复:
- 5.1、执行器jetty关闭优化,解决一处可能导致jetty无法关闭的问题;
- 5.2、执行器任务终止时,执行队列回调优化,解决一处导致任务无法回调的问题;
- 5.3、调度中心中列表分页参数优化,解决一处因服务器限制post长度而引起的问题;
- 5.4、执行器Jobhandler注解优化,解决一处因事务代理导致的容器无法加载JobHandler的问题;
- 5.5、远程调度优化,禁用retry策略,解决一处可能导致重复调用的问题;
Tips: 历史版本(V1.3.x)目前已经Release至稳定版本, 进入维护阶段, 地址见分支 [V1.3](https://github.com/xuxueli/xxl-job/tree/v1.3) 。新特性将会在master分支持续更新。
#### 规划中
- 1、任务依赖: 通过事件触发方式实现, 任务执行成功并回调SUCCESS时, 会主动触发一次依赖任务的调度;
- 2、任务执行规则自定义:假如前一个任务正在执行,后续调度执行规则支持自定义;
串行(默认,当前逻辑):后续调度入调度队列;
并行:后续调度并行执行;
Pass:后续调度被Pass;
- 3、兼容oracle;

Binary file not shown.

Before

Width:  |  Height:  |  Size: 131 KiB

Loading…
Cancel
Save