xxl-job
<h1>概述</h1>
<pre><code>XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。
XXL-JOB分为xxl-admin任务管理端以及xxl-job任务执行端。
特性：
1、简单：支持通过Web页面对任务进行CRUD操作，操作简单，一分钟上手；
2、动态：支持动态修改任务状态、启动/停止任务，以及终止运行中任务，即时生效；
3、调度中心HA（中心式）：调度采用中心式设计，“调度中心”自研调度组件并支持集群部署，可保证调度中心HA；
4、执行器HA（分布式）：任务分布式执行，任务”执行器”支持集群部署，可保证任务执行HA；
5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时，也支持手动录入执行器地址；
6、弹性扩容缩容：一旦有新执行器机器上线或者下线，下次调度时将会重新分配任务；
7、路由策略：执行器集群部署时提供丰富的路由策略，包括：第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等；
8、故障转移：任务路由策略选择”故障转移”情况下，如果执行器集群中某一台机器故障，将会自动Failover切换到一台正常的执行器发送调度请求。
9、阻塞处理策略：调度过于密集执行器来不及处理时的处理策略，策略包括：单机串行（默认）、丢弃后续调度、覆盖之前调度；
10、任务超时控制：支持自定义任务超时时间，任务运行超时将会主动中断任务；
11、任务失败重试：支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；其中分片任务支持分片粒度的失败重试；
12、任务失败告警；默认提供邮件方式失败告警，同时预留扩展接口，可方便的扩展短信、钉钉等告警方式；
13、分片广播任务：执行器集群部署时，任务路由策略选择”分片广播”情况下，一次任务调度将会广播触发集群中所有执行器执行一次任务，可根据分片参数开发分片任务；
14、动态分片：分片广播任务以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度。
15、事件触发：除了”Cron方式”和”任务依赖方式”触发任务执行之外，支持基于事件的触发任务方式。调度中心提供触发任务单次执行的API服务，可根据业务事件灵活触发。
16、任务进度监控：支持实时监控任务进度；
17、Rolling实时日志：支持在线查看调度结果，并且支持以Rolling方式实时查看执行器输出的完整的执行日志；
18、GLUE：提供Web IDE，支持在线开发任务逻辑代码，动态发布，实时编译生效，省略部署上线的过程。支持30个版本的历史版本回溯。
19、脚本任务：支持以GLUE模式开发和运行脚本任务，包括Shell、Python、NodeJS、PHP、PowerShell等类型脚本;
20、命令行任务：原生提供通用命令行任务Handler（Bean任务，”CommandJobHandler”）；业务方只需要提供命令行即可；
21、任务依赖：支持配置子任务依赖，当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔；
22、一致性：“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行；
23、自定义任务参数：支持在线配置调度任务入参，即时生效；
24、调度线程池：调度系统多线程触发调度运行，确保调度精确执行，不被堵塞；
25、数据加密：调度中心和执行器之间的通讯进行数据加密，提升调度信息安全性；
26、邮件报警：任务失败时支持邮件报警，支持配置多邮件地址群发报警邮件；
27、推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用;
28、运行报表：支持实时查看运行数据，如任务数量、调度次数、执行器数量等；以及调度报表，如调度日期分布图，调度成功分布图等；
29、全异步：任务调度流程全异步化设计实现，如异步调度、异步运行、异步回调等，有效对密集调度进行流量削峰，理论上支持任意时长任务的运行；
30、跨语言：调度中心与执行器提供语言无关的 RESTful API 服务，第三方任意语言可据此对接调度中心或者实现执行器。除此之外，还提供了 “多任务模式”和“httpJobHandler”等其他跨语言方案；
31、国际化：调度中心支持国际化设置，提供中文、英文两种可选语言，默认为中文；
32、容器化：提供官方docker镜像，并实时更新推送dockerhub，进一步实现产品开箱即用；
33、线程池隔离：调度线程池进行隔离拆分，慢任务自动降级进入”Slow”线程池，避免耗尽调度线程，提高系统稳定性；
34、用户管理：支持在线管理系统用户，存在管理员、普通用户两种角色；
35、权限控制：执行器维度进行权限控制，管理员拥有全量权限，普通用户需要分配执行器权限后才允许相关操作；</code></pre>
<h1>环境安装</h1>
<h4>xxl-admin任务管理端</h4>
<h5>执行数据库脚本：</h5>
<pre><code>nisbos-thirdparty/nisbos-xxl-executor/docs/xxl-admin/tables_xxl_job.sql</code></pre>
<h5>更改数据库连接以及日志地址：</h5>
<pre><code>将
nisbos-thirdparty/nisbos-xxl-executor/docs/xxl-admin/application.properties
nisbos-thirdparty/nisbos-xxl-executor/docs/xxl-adminlogback.xml
对应的配置修改好后，替换到
nisbos-thirdparty/nisbos-xxl-executor/docs/xxl-admin/xxl-admin.jar</code></pre>
<h5>启动jar：</h5>
<pre><code>在xxl-admin.jar所在目录下执行：
java -jar xxl-admin.jar</code></pre>
<h4>xxl-executor任务执行端（参照nisbos-thirdparty/nisbos-xxl-executor项目）</h4>
<h5>新增maven依赖</h5>
<pre><code> <properties>
<apollo.version>1.6.0</apollo.version>
<xxl.version>2.2.0</xxl.version>
</properties>
<!--apollo-->
<dependency>
<groupId>com.ctrip.framework.apollo</groupId>
<artifactId>apollo-client</artifactId>
<version>${apollo.version}</version>
</dependency>
<!--xxl-job-->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>${xxl.version}</version>
</dependency></code></pre>
<h5>修改apollo配置</h5>
<pre><code> 在/src/main/resources目录下配置apollo相关配置，在对应的apollo配置如下</code></pre>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/37171cd972c7f2e65447b39e3eb0ff7f?showdoc=.jpg" alt="" /></p>
<pre><code>其中 xxl.job.admin.addresses 为xxl-admin任务管理端的地址
xxl.job.executor.appname 为xxl-executor任务执行端的名称
xxl.job.executor.port 为xxl-executor任务执行端的端口</code></pre>
<h5>读取apollo配置</h5>
<pre><code>参照/conf/XxlJobConfig.java读取对应的apollo配置</code></pre>
<h5>编写任务执行逻辑</h5>
<pre><code>参照/job/SingleJob.java，在需要执行任务的类上打上@Componen注解，方法上打上@XxlJob注解</code></pre>
<h1>场景预览</h1>
<h3>未使用xxl-job：同一任务部署了5台服务器，这5台各自行政，并未形成统一的管理，如果要启动服务，必须登录这5台服务器，一台一台地去执行linux命令:</h3>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/073bef6ae9bfecf581ba324294b13d19?showdoc=.jpg" alt="" /></p>
<h3>使用xxl-job可以通过Web页面对同一任务所部署的5台服务器进行统一的CRUD操作，操作简单:</h3>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/1a2414d6160d615835f29c5106cf5122?showdoc=.jpg" alt="" /></p>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/4e0edf206b6aed782b07c622a0f21c7a?showdoc=.jpg" alt="" /></p>
<h1>快速入门</h1>
<h4>部署xxl-admin任务管理端到10.1.4.70</h4>
<pre><code>地址：http://10.1.4.70:7001/xxl-job-admin/
账户密码： admin/123456</code></pre>
<h4>更改apollo配置并发布</h4>
<pre><code>xxl-admin任务管理端的地址：</code></pre>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/356090bb74fad7900a2dad270e446036?showdoc=.jpg" alt="" /></p>
<pre><code>xxl-executor任务执行端的名称：</code></pre>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/d026df658cfdf31940d965d1caa586aa?showdoc=.jpg" alt="" /></p>
<pre><code>xxl-executor任务执行端的端口：</code></pre>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/9f4f9a4dfb1121106e8d3da481713761?showdoc=.jpg" alt="" /></p>
<h4>部署xxl-executor任务管理端到10.1.4.72</h4>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/2571f1b1d7f6103d6a534bf95caa46a2?showdoc=.jpg" alt="" /></p>
<h4>新增执行器</h4>
<pre><code>AppName为apollo配置的xxl.job.executor.appname</code></pre>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/e6fbd0f1282e5fff22521db26e8fbc7a?showdoc=.jpg" alt="" /></p>
<pre><code>稍等片刻后刷新页面，可以看到xxl-executor任务执行端已成功注册到该执行器</code></pre>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/97640814a8babc401abb1552d68a4511?showdoc=.jpg" alt="" /></p>
<h4>新增任务</h4>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/06c5a0f510c1d41c15de0f186871ff27?showdoc=.jpg" alt="" /></p>
<pre><code>JobHandler为对应xxl-executor任任务执行端@XxlJob注解上的值
Cron为定时任务表达式</code></pre>
<h3>执行任务</h3>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/2171968d4c11634d6e0a67f02f26f855?showdoc=.jpg" alt="" /></p>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/5aa7467b15176ab664337446f1b0562a?showdoc=.jpg" alt="" /></p>
<h3>查询执行任务日志</h3>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/117622ad4d667f6b213a2b310f65413b?showdoc=.jpg" alt="" /></p>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/1cb82b3165fd0d10d4d6363a58af31ee?showdoc=.jpg" alt="" /></p>
<p><img src="https://www.showdoc.cc/server/api/common/visitfile/sign/efab50cd5bd830b949527fe871c09953?showdoc=.jpg" alt="" /></p>
<pre><code>可以看到已成功执行了一次该任务</code></pre>