XXL-JOB分布式任务调度平台配置详解

XXL-JOB是一个分布式任务调度平台，
其核心设计目标是开发迅速、学习简单、轻量级、易扩展。

个人建议：
对于需要定时调度任务开箱即用的小伙伴来说，完全可以学习参考下。

本文主要介绍了Xxl-Job分布式任务调度框架的配置信息详解，
以及路由策略、阻塞策略研究测试报告（文末第六点）

个人学习总结的初稿，望大佬勿喷！

一、Xxl-job-admin配置
1.1 初始化“调度数据库”
打开 “调度数据库初始化SQL脚本” 并执行即可。
1.2调度中心配置文件地址：
/xxl-job/xxl-job-admin/src/main/resources/application.properties

1.3调度中心配置内容说明：
server.port=8081 #调度中心端口号
server.context-path=/xxl-job-admin
调度中心JDBC链接：
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?Unicode=true&characterEncoding=UTF-8
spring.datasource.username=root
spring.datasource.password=root_pwd
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

###报警邮箱
spring.mail.host=xxxx.com
spring.mail.port=25
spring.mail.username=xxx@xx.com
spring.mail.password=xxx #邮箱授权码
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

//调度中心通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=

// 调度中心国际化配置 [必填]：
默认为 “zh_CN”/中文简体, 可选范围为 “zh_CN”/中文简体, “zh_TC”/中文繁体 and “en”/英文；
xxl.job.i18n=zh_CN

//调度线程池最大线程配置【必填】
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

//调度中心日志表数据保存天数 [必填]：
过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
xxl.job.logretentiondays=

// 调度中心登录
xxl.job.login.username=admin
xxl.job.login.password=123456

二、执行器

2.1 添加maven依赖
pom文件中引入了 “xxl-job-core” 的maven依赖；

2.2执行器配置
2.2.1执行器配置，配置文件地址：
/xxl-job/xxl-job-executor/src/main/resources/application.properties

2.2.2配置内容说明：

//调度中心部署跟地址 [选填]：
如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；xxl.job.admin.addresses=http://127.0.0.1:8081/xxl-job-admin

//执行器通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=

//执行器AppName [选填]：
执行器心跳注册分组依据；为空则关闭自动注册
xxl.job.executor.appname=executor
和任务调度中心AppName*需一致

执行器注册 [选填]：
优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
#端口号对应xxl-job-admin调度中心端口号、名称对应server.context-path
xxl.job.executor.address=http://127.0.0.1:8081/xxl-job-admin

//执行器IP [选填]：
默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 “执行器注册” 和 “调度中心请求并触发任务”；
xxl.job.executor.ip=

//执行器端口号 [选填]：
小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
xxl.job.executor.port=9999

//执行器运行日志文件存储磁盘路径 [选填] ：
需要对该路径拥有读写权限；为空则使用默认路径；xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler

//执行器日志文件保存天数 [选填] ：
过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
xxl.job.executor.logretentiondays=-1

2.2.3 执行器组件配置
执行器组件，配置文件地址：
/xxl-job/xxl-job-executor//src/main/java/com/comiot/xxl/executor/config/XxlJobConfig.java

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

2.2.4执行器job
例：

value值对应调度中心任务管理Jobhandler

在execute方法中实现执行业务逻辑。

三、调度中心执行器管理

新建、编辑执行器

###配置说明
AppName*：是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
填写执行器配置文件中 xxl.job.executor.appname=executor 的值；

名称*： 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;

排序*： 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;

注册方式*：可选：自动注册、手动注册；
自动注册，执行器自动进行执行器注册，调度中心通过底层注册表可以动态发现执行器机器地址；
手动注册，支持人工维护执行器的地址信息。

四、调度中心任务管理

新增、编辑任务

###配置说明
执行器*：
任务的绑定的执行器，任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 “执行器管理” 进行设置;

路由策略*：

路由策略是用来分发任务的。当执行器集群部署时，提供丰富的路由策略；包括：
FIRST（第一个） ：固定选择第一个机器；
当有任务待执行器执行时，调度中心会将任务下发到权重较高（路由路径最短的）的执行器。当执行器挂了，90s以后会重新设置第一个。在执行过程中挂了，那么此任务执行失败，在未来的90s内有新的任务进来也将会失败。
LAST（最后一个）：固定选择最后一个机器； 原理和“第一个”相同；
RANDOM（随机）：随机选择在线的机器；
当有任务待执行器执行时，调度中心会将任务随机下发某个执行器上，在执行过程中挂了，那么此任务执行失败，在未来的90s内有新的任务进来也将会失败。
ROUND（轮询）： 原理和“随机”相同；
CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。
LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举；
FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
在执行过程中挂了，那么此任务执行失败，下一次任务进来时立马分派到新的存活的服务器上，不必等待90s
BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；

运行模式*：

BEAN模式(推荐)：任务以JobHandler方式维护在执行器端；需要结合 “JobHandler” 属性匹配执行器中任务；
GLUE模式(Java)：任务以源码方式维护在调度中心；
该模式的任务实际上是一段继承自IJobHandler的Java类代码并 “groovy” 源码方式维护，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里的其他服务；
GLUE模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “shell” 脚本；
GLUE模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “python” 脚本；
GLUE模式(PHP)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “php” 脚本； GLUE模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “nodejs” 脚本；
GLUE模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 “PowerShell” 脚本；

阻塞处理策略*：

调度过于密集执行器来不及处理时的处理策略；

单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
丢弃后续调度：对重复任务只执行一次.调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
覆盖之前调度(不推荐)：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
在执行过程中如果收到了同一个任务会立马停掉当前任务去执行最新进来的任务；

任务超时时间*：支持自定义任务超时时间，任务运行超时将会主动中断任务；单位秒，大于0时生效；

负责人*：任务负责人；

任务描述*: 任务的描述信息，便于任务管理；

Cron*: 触发任务执行的Cron表达式；

JobHandler*:
运行模式为 “BEAN模式” 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值；

子任务ID*：
每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。

失败重试次数*：支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

报警邮件*：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；

任务参数*：任务执行所需的参数。

4.1 BEAN模式(类形式)

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

4.1.1 执行器项目中，开发Job类：

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

4.2 BEAN模式（方法形式）

Bean模式任务，支持基于方法的开发方式，每个任务对应一个方法。
优点：每个任务只需要开发一个方法，并添加"@XxlJob"注解即可，更加方便、快速。
支持自动扫描任务并注入到执行器容器。
缺点：要求Spring容器环境；
基于方法开发的任务，底层会生成JobHandler代理，和基于类的方式一样，任务也会以JobHandler的形式存在于执行器任务容器中。

4.2.1 执行器项目中，开发Job方法：

1、在Spring Bean实例中，开发Job方法，方式格式要求为 “public ReturnT execute(String param)”

2、为Job方法添加注解 “@XxlJob(value="自定义jobhandler名称”, init = “JobHandler初始化方法”, destroy = “JobHandler销毁方法”)"，
注解value值对应的是调度中心新建任务的JobHandler属性的值。

3、执行日志：需要通过 “XxlJobLogger.log” 打印执行日志；
// 可参考Sample示例执行器中的 “com.xxl.job.executor.service.jobhandler.SampleXxlJob” ，如下：

4.2.2调度中心，新建调度任务

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

4.3 原生内置Bean模式任务

demoJobHandler：简单示例任务，任务内部模拟耗时任务逻辑；
shardingJobHandler：分片示例任务，任务内部模拟处理分片参数，可参考熟悉分片任务；
httpJobHandler：通用HTTP任务Handler；业务方只需要提供HTTP链接等信息即可，不限制语言、平台。
示例任务入参如下：
url: http://www.xxx.com
method: get 或 post
data: post-data

commandJobHandler：通用命令行任务Handler；业务方只需要提供命令行即可；如 “pwd”命令；

4.4 GLUE模式

任务以源码方式维护在调度中心，支持通过Web IDE在线更新，实时编译和生效，因此不需要指定JobHandler。
GLUE模式(Java)、GLUE模式(Shell)、GLUE模式(Python)、GLUE模式(NodeJS)、GLUE模式(PHP)、GLUE模式(PowerShell)
选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发（也可以在IDE中开发完成后，复制粘贴到编辑中）。
版本回溯功能（支持30个版本的版本回溯）：在GLUE任务的Web IDE界面，选择右上角下拉框“版本回溯”，会列出该GLUE的更新历史，选择相应版本即可显示该版本代码，保存后GLUE代码即回退到对应的历史版本；

五、调度日志

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

调度时间："调度中心"触发本次调度并向"执行器"发送任务执行信号的时间；
调度结果："调度中心"触发本次调度的结果，200表示成功，500或其他表示失败；
调度备注："调度中心"触发本次调度的日志信息；
执行器地址：本次任务执行的机器地址
运行模式：触发调度时任务的运行模式；
任务参数：本地任务执行的入参执行时间："执行器"中本次任务执行结束后回调的时间；
执行结果："执行器"中本次任务执行的结果，200表示成功，500或其他表示失败；
执行备注："执行器"中本次任务执行的日志信息；
操作：
"执行日志"按钮：点击可查看本地任务执行的详细日志信息；
"终止任务"按钮：点击可终止本地调度对应执行器上本任务的执行线程，包括未执行的阻塞任务一并被终止；

六、路由策略、阻塞策略研究

(个人亲自部署验证基于2.0.1版xxl-job，如有错误理解还望指出)

路由策略研究测试：
验证前提：运行模式 BEAN, 路由阻塞策略 单机串行，使用三台执行器测试

FIRST（第一个）：正常启动执行，均执行注册执行器的第一个。如果第一台挂掉了，则执行失败，在90s恢复正常继续执行下一个。挂掉的第一台恢复，执行恢复后第一台机器。
LAST（最后一个）：原理同上。
RANDOM（随机） ：随机选择执行器执行。随机挂掉一台，在90s内如果随机到挂掉的机器则执行失败。恢复后恢复随机。
ROUND（轮询）： 每台机器依次执行。随机挂掉一台，如果在90s内轮询到挂掉机器则执行失败。挂掉机器恢复后恢复轮询。
CONSISTENT_HASH（一致性HASH）：根据hash算法固定选择一台机器执行。执行过程中机器挂掉，在90s内任务执行失败，90s后重新根据hash算法在剩下机器中选择一台固定机器执行。挂掉机器恢复后，恢复执行。
LEAST_FREQUENTLY_USED（最不经常使用）： 频率最低的机器优先选举。随机挂掉一台，当策略选择到该机器时，会一直失败。恢复后立即恢复正常。
LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举。基本上为轮询状态。随机挂掉一台机器，该机器被选举到时会一直执行失败。注册机地址90s更新后还是会继续失败。

FAILOVER（故障转移）推荐：

启动后自动执行第一个注册执行器。机器挂掉时，自动进行心跳检查执行下一个执行器。故障机器恢复后恢复执行。

BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个进行执行。宕机时，进行空闲检测，检测到的第一个空闲机器执行。故障机恢复后恢复执行。

SHARDING_BROADCAST(分片广播)：广播触发所有机器执行一次。随机挂掉一台机器，故障机任务将执行失败，其他机器正常执行。60s左右故障机停止执行，剩下机器正常执行。故障机恢复，恢复执行。

阻塞策略研究测试：

验证前提：运行模式 BEAN, 路由策略 轮询，两台执行器

丢弃后续调度：对重复任务只执行一次.调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；

利用Thread.sleep(20000);使任务休眠20s,采用轮询策略，执行时间为5s每次，第一次执行，两台执行器执行成功，任务进行20s阻塞中，后续两台执行器分别执行两次均失败，阻塞策略为丢弃后续调度，阻塞期间，后续调度被丢弃。任务20s阻塞结束，再次执行则成功。

覆盖之前调度(不推荐)：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
在执行过程中如果收到了同一个任务会立马停掉当前任务去执行最新进来的任务；

利用Thread.sleep(20000);使任务休眠20s,采用轮询策略，执行时间为5s每次，第一次执行，两台执行器执行成功，任务进入阻塞20s中，5s后再次调度，阻塞策略为覆盖之前调度，前面执行中的阻塞任务将被中断，执行最新调度任务。

xxl-job下载
GitHub链接：https://github.com/xuxueli/xxl-job