13.XXL-JOB应用

XXL-JOB应用

1.介绍

XXL-JOB是大众点评员工徐雪里于2015年发布的分布式任务调度平台

2.XXL-JOB与Quartz的关系

老版本依赖Quartz的定时任务触发，在V2.1.0版本开始移除了Quartz

3.官方地址

• 官方文档：https://www.xuxueli.com/xxl-job/
• gitee：https://gitee.com/xuxueli0323/xxl-job
• github：https://github.com/xuxueli/xxl-job/
• dockerhub：https://hub.docker.com/r/xuxueli/xxl-job-admin/

4.设计思想

• 将调度行为抽象形成“调度中心”公共平台，而平台自身并不承担业务逻辑，“调度中心”负责发起调度请求
• 将任务抽象成分散的JobHandler，交友“执行器”统一管理
• “执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑
• 因此，“调度”和“任务”两部分可以互相解耦，提高系统整体稳定性和扩展性

5.架构

调度中心

• 负责管理调度的信息，按照调度的配置来发出调度请求
• 支持可视化，简单的动态管理调度信息，包括新建，删除，更新等，这些操作都会实时生效，同时也支持监控调度结果以及执行日志

执行器

负责接收请求并且执行任务的逻辑。任务模块专注于任务的执行操作等等，使得开发和维护更加简单与高效

图示

6.特点

• 调度中心HA（中心式）：调度采用了中心式进行设计，“调度中心”支持集群部署，可保证调度中心HA
• 执行器HA（分布式）：任务分布式的执行，任务执行器支持集群部署，可保证任务执行HA
• 触发策略：用cron触发，固定间隔触发，固定延时触发，API事件触发，人工触发，父子任务触发
• 路由策略：执行器在集群部署的时候提供了丰富的路由策略，如：第一个，最后一个，轮询，随机，一致性Hash，最不经常使用LFU，最久未使用LRU，故障转移等等
• Rolling实时日志的监控：支持rolling方式查看输入的完整执行日志
• 脚本任务：支持GLUE模式开发和运行脚本任务，包括Shell，python，node.js，php等等类型脚本

7.源码

版本

V2.3.0

下载地址

https://github.com/xuxueli/xxl-job/releases/tag/2.3.0

源码目录介绍

• doc：xxl-job的文档资料，包括了数据库的脚本
• xxl-job-core：公共jar包依赖
• xxl-job-admin：调度中心，项目源码，是SpringBoot项目，可以直接启动
• xxl-job-executor-samples：执行器，是Sample实例项目，里面的SpringBoot工程可以直接启动，也可以在该项目的基础上进行开发，也可以将现有的项目改造为执行器项目

表介绍

• xxl_job_group：执行器信息表，用于维护任务执行器的信息
• xxl_job_info：调度扩展信息表，主要是用于xxl-job的调度任务的扩展信息，比如说像任务分组，任务名，机器的地址等等
• xxl_job_lock：任务调度锁表
• xxl_job_log：日志表，主要是用在保存xxl-job任务调度历史信息，像调度结果，执行结果，调度入参等
• xxl_job-log_report：日志报表，会存储xxl-job任务调度的日志报表，会在调度中心里的报表功能里使用到
• xxl_job_logglue：任务的GLUE日志，用于保存GLUE日志的更新历史变化，支持GLUE版本的回溯功能
• xxl_job_user：系统的用户表

8.部署

方式总览

• 手动部署
• Docker部署

部署架构图

手动部署

步骤

• 拉取源码
• 从源码中获取sql文件并执行
• 配置源码中的数据库路径信息
• 启动admin应用

拉取源码

省略…上面给了源码地址下载即可

从源码中获取sql文件并执行

配置源码中的数据库路径信息

启动admin应用

省略…就是个SpringBoot应用直接执行就行

Docker部署

# 拉取镜像，建议加版本
docker pull xuxueli/xxl-job-admin

# 如需自定义 mysql 等配置，可通过 "-e PARAMS" 指定，参数格式 PARAMS="--key=value  --key2=value2" ；
# 配置项参考文件：/xxl-job/xxl-job-admin/src/main/resources/application.properties
# 如需自定义 JVM内存参数 等配置，可通过 "-e JAVA_OPTS" 指定，参数格式 JAVA_OPTS="-Xmx512m" ；
docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai" -p 8080:8080 -v /tmp:/data/applogs --name xxl-job-admin  -d xuxueli/xxl-job-admin:{指定版本}

测试是否部署成功

访问调度中心控制台，能进去就算成功

• 地址：ip:8080/xxl-job-admin
• 默认账号密码：admin/123456

服务端配置文件详解

### 调度中心JDBC链接：链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root_pwd
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
### 报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
[email protected]
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=30

9.SpringBoot整合XXL-JOB

依赖

<dependency>
    <groupId>com.xuxueligroupId>
    <artifactId>xxl-job-coreartifactId>
    <version>2.3.0version>
dependency>

application.properties添加配置

### 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=
### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
### 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=
### 执行器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=30

配置类

@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
    logger.info(">>>>>>>>>>> xxl-job config init.");
    XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
    xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
    xxlJobSpringExecutor.setAppname(appname);
    xxlJobSpringExecutor.setIp(ip);
    xxlJobSpringExecutor.setPort(port);
    xxlJobSpringExecutor.setAccessToken(accessToken);
    xxlJobSpringExecutor.setLogPath(logPath);
    xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
    return xxlJobSpringExecutor;
}

基础知识

创建Job方法

页面创建任务

注意

SpringBoot项目启动后，执行器上显示在线机器一般要等30秒左右才回显的地址

页面执行任务

10.执行器多节点执行

介绍

执行器有多个然后同一个任务，调度中心去调度多个执行器

本机执行器多节点部署

• 程序端口修改
• 执行器端口修改

# 第一个要改的配置
server.port=8080
# 第二个要改的配置
xxl.job.executor.port=9999

执行

11.调度任务参数传递

介绍

在页面运行一个任务的时候可以编辑这个任务执行的时候传递的参数，然后再执行器的应用中使用XxlJobHelper.getJobParam()方法获得参数

UI界面设置

代码

12.调度任务日志打印与查看

介绍

调度任务的时候可以在代码里面打印一些日志，然后控制台上可以方便查看

代码

UI界面

13.自主设置调度任务执行结果

介绍

存在调度是否成功与执行是否成功，那么如何控制任务执行是否成功呢

默认情况

方法任务结果为”成功“，不需要主动设置

自主设置任务结果

• 设置任务结果为失败：XxlJobHelper.handleFail
• 设置任务结果成功：handleSuccess

14.调度中心集群部署

图示

执行器配置调度中心集群

15.任务分片

需求

• 有一个任务需要处理100w条数据，每条数据的业务逻辑处理要0.1s
• 对于普通任务来说，只有一个线程来处理，可能需要10万秒才能处理完，业务则严重收到影响
• 案例：双十一大促，给1000万用户发营销短信

什么是分片任务

执行器集群部署时，任务路由策略选择”分片广播”情况下，一次任务调度将会广播触发对应集群中所有执行器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务

“分片广播” 以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度

Java语言任务获取分片参数方式

// 可参考Sample示例执行器中的示例任务"ShardingJobHandler"了解试用 
int shardIndex = XxlJobHelper.getShardIndex();
int shardTotal = XxlJobHelper.getShardTotal();

脚本语言任务获取分片参数方式

// 脚本任务入参固定为三个，依次为：任务传参、分片序号、分片总数。以Shell模式任务为例，获取分片参数代码如下
echo "分片序号 index = $2"
echo "分片总数 total = $3"

分片参数说明

• index：当前分片序号（从0开始），执行器集群列表中当前执行器的序号
• total：总分片数，执行器集群的总机器数量

应用场景

• 分片任务场景：10个执行器的集群来处理10w条数据，每台机器只需要处理1w条数据，耗时降低10倍
• 广播任务场景：广播执行器机器运行shell脚本、广播集群节点进行缓存更新等

16.访问令牌

介绍

为提升系统安全性，调度中心和执行器进行安全性校验，双方AccessToken匹配才允许通讯

设置方式

调度中心和执行器，可通过配置项 “xxl.job.accessToken” 进行AccessToken的设置

正常通讯的两种情况

调度中心和执行器，如果需要正常通讯，只有两种设置；

• 调度中心和执行器，均不设置AccessToken；关闭安全性校验
• 调度中心和执行器，设置了相同的AccessToken