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

1、概述

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

2、下载

中文文档:http://www.xuxueli.com/xxl-job
许雪里博客:https://www.cnblogs.com/xuxueli/p/5021979.html
复制代码

中央仓库地址:

<!-- http://repo1.maven.org/maven2/com/xuxueli/xxl-job-core/ -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>${最新稳定版本}</version>
</dependency>
复制代码

2、快速入门

2.1、项目结构图

xxl-job-admin：调度中心
xxl-job-core：公共依赖
xxl-job-executor：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
    ：xxl-job-executor-sample-frameless：无框架执行器，不依赖第三方框架，只需main方法即可启动运行执行器。
    ：xxl-job-executor-sample-jfinal：JFinal版本，通过JFinal管理执行器。
    ：xxl-job-executor-sample-nutz：Nutz版本，通过Nutz管理执行器。
    ：xxl-job-executor-sample-spring：Spring版本，通过Spring容器管理执行器，比较通用，推荐这种方式；
    ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器；
复制代码

2.2、初始化调度数据库

调度数据库初始化SQL脚本位置为:/xxl-job/doc/db/tables_xxl_job.sql，正常情况下应该生成16张表。
复制代码

2.3、配置部署调度中心

调度中心项目：xxl-job-admin
作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。
复制代码

步骤一：调度中心配置

调度中心配置文件地址：/xxl-job/xxl-job-admin/src/main/resources/xxl-job-admin.properties
调度中心配置内容说明：
复制代码

    ### 调度中心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
    
    ### 报警邮箱
    xxl.job.mail.host=smtp.163.com
    xxl.job.mail.port=25
    xxl.job.mail.ssl=false
    xxl.job.mail.username=ovono802302@163.com
    xxl.job.mail.password=asdfzxcv
    xxl.job.mail.sendNick=《任务调度平台XXL-JOB》
    
    ### 登录账号
    xxl.job.login.username=admin
    xxl.job.login.password=123456
    
    ### 调度中心通讯TOKEN，非空时启用
    xxl.job.accessToken=
    
    ### 调度中心国际化设置，默认为中文版本，值设置为“en”时切换为英文版本
    xxl.job.i18n=
复制代码

步骤二：部署项目

如果已经正确进行上述配置，可将项目编译打包部署。 调度中心访问地址：http://localhost:8080/xxl-job-admin (该地址执行器将会使用到，作为回调地址)
复制代码

2.4 配置部署执行器项目

执行器项目：xxl-job-executor-sample-xxx (提供多种版本执行器供选择，现以Springboot版本为例)
作用：负责接收调度中心的调度并执行；可直接部署执行器，也可以将执行器集成到现有业务项目中。
复制代码

步骤一：maven依赖

确认pom文件中引入了 "xxl-job-core" 的maven依赖
复制代码

步骤二：执行器配置

执行器配置，配置文件地址：/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/xxl-job-executor.properties
复制代码

执行器配置，配置内容说明：

### xxl-job admin address list：调度中心部署跟地址：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"
### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

### xxl-job executor address：执行器"AppName"和地址信息配置：AppName执行器心跳注册分组依据；地址信息用于"调度中心请求并触发任务"和"执行器注册"。执行器默认端口为9999，执行器IP默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用。单机部署多个执行器时，注意要配置不同执行器端口
### xxl-job executor address
xxl.job.executor.appname=xxl-job-executor-sample
xxl.job.executor.ip=
xxl.job.executor.port=9999

### xxl-job, access token：执行器通讯TOKEN，非空时启用
### xxl-job, access token
xxl.job.accessToken=
    
### xxl-job log path：执行器运行日志文件存储的磁盘位置，需要对该路径拥有读写权限
### xxl-job log path
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler/

### xxl-job log retention days：执行器Log文件定期清理功能，指定日志保存天数，日志文件过期自动删除。限制至少保持3天，否则功能不生效；
### xxl-job log retention days
xxl.job.executor.logretentiondays=-1
复制代码

步骤三：部署执行器项目

2.5、第一个程序hello world

2.6、任务详解

配置属性详细说明

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

• 任务描述：任务的描述信息，便于任务管理

• 路由策略：当执行器集群部署时，提供丰富的路由策略，包括：

    FIRST（第一个）：固定选择第一个机器；
    LAST（最后一个）：固定选择最后一个机器；
    ROUND（轮询）：；
    RANDOM（随机）：随机选择在线的机器；
    CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。
    LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
    LEAST_RECENTLY_USED（最近最久未使用）：最久为使用的机器优先被选举；
    FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
    BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
    SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；
  复制代码

• Cron：触发任务执行的Cron表达式；

• 运行模式：

    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" 脚本；
  复制代码

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

• 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略

    单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
    丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
    覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
  复制代码

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

• 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务

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

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

• 负责人：任务的负责人；

• 执行参数：任务执行所需的参数，多个参数时用逗号分隔，任务执行时将会把多个参数转换成数组传入

2.7、BEAN模式

任务逻辑以JobHandler的形式存在于“执行器”所在项目中，开发流程如下：

步骤一：执行器项目中，开发JobHandler：

• 1、继承"IJobHandler"：“com.xxl.job.core.handler.IJobHandler”；
• 2、注册到Spring容器：添加“@Component”注解，被Spring容器扫描为Bean实例；
• 3、注册到执行器工厂：添加“@JobHandler(value="自定义jobhandler名称")”注解，注解value值对应的是调度中心新建任务的JobHandler属性的值。
• 4、执行日志：需要通过 "XxlJobLogger.log" 打印执行日志

步骤二：调度中心，新建调度任务

对新建的任务进行参数配置，运行模式选中 "BEAN模式"，JobHandler属性填写任务注解“@JobHandler”中定义的值
复制代码

2.8、任务管理

• 配置执行器

    点击进入"执行器管理"界面
    1、"调度中心OnLine:"右侧显示在线的"调度中心"列表, 任务执行结束后, 将会以failover的模式进行回调调度中心通知执行结果, 避免回调的单点风险;
    2、"执行器列表" 中显示在线的执行器列表, 可通过"OnLine 机器"查看对应执行器的集群机器。
    点击按钮 "+新增执行器" 弹框如下图, 可新增执行器配置:
  复制代码

执行器属性说明：

AppName: 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
名称: 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;
排序: 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;
注册方式：调度中心获取执行器地址的方式；
    自动注册：执行器自动进行执行器注册，调度中心通过底层注册表可以动态发现执行器机器地址；
    手动录入：人工手动录入执行器的地址信息，多地址逗号分隔，供调度中心使用；
机器地址："注册方式"为"手动录入"时有效，支持人工维护执行器的地址信息；
复制代码

转载于:https://juejin.im/post/5c6a6e18e51d4549c134823f