本文章基于xxl-job 2.2.0, jdk8 , springboot 2.2.6.RELEASE
XXL-JOB是一个分布式任务调度平台, 平台架构分为调度器和执行器(就是你的业务程序), 调度器一般是一个单独的服务,执行器可以是单独的服务,也可以改造现有项目(建议是单独建立服务,毕竟可以解耦合嘛)
xxl-job简单的说就是一个定时调任务的
使用场景:
特性:
挑了些比较关注的特性,更多见官网
源码结构:
xxl-job-admin：调度中心
xxl-job-core：公共依赖
xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；
：xxl-job-executor-sample-spring：Spring版本，通过Spring容器管理执行器，比较通用；
：xxl-job-executor-sample-frameless：无框架版本；
该文章只讲springboot版本, 学习阶段强烈建议下载源码,不光有源码还有案例!!
其实xxl-job 基本开箱即用, 官网也写得很好,我只是按自己的想法整理一下
xxl-job 需要一个数据表来保存信息,以便管理
数据库文件路径: /xxl-job/doc/db/tables_xxl_job.sql (源码中的相对位置)
xxl_job_lock： 任务调度锁表；
xxl_job_group： 执行器信息表，维护任务执行器信息；
xxl_job_info： 调度扩展信息表： 用于保存XXL-JOB调度任务的扩展信息，如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等；
xxl_job_log： 调度日志表： 用于保存XXL-JOB任务调度的历史信息，如调度结果、执行结果、调度入参、调度机器和执行器等等；
xxl_job_log_report： 调度日志报表：用户存储XXL-JOB任务调度日志的报表，调度中心报表功能页面会用到；
xxl_job_logglue： 任务GLUE日志：用于保存GLUE更新历史，用于支持GLUE的版本回溯功能；
xxl_job_registry： 执行器注册表，维护在线的执行器和调度中心机器地址信息；
xxl_job_user： 系统用户表；
调度中心项目：xxl-job-admin
修改配置文件
/xxl-job/xxl-job-admin/src/main/resources/application.properties
### 调度中心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
spring.mail.username=xxx@qq.com
# 如果是qq邮箱,这里写授权码 https://service.mail.qq.com/cgi-bin/help?subtype=1&&id=28&&no=1001256
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
在idea中启动后,访问调度器管理平台: http://localhost:8080/xxl-job-admin , 账号/密码: admin/123456, 如下图(官网偷图):
调度中心支持集群部署，提升调度系统容灾和可用性。
调度中心集群部署时，要求和建议：
“执行器”项目：xxl-job-executor-sample-springboot
修改配置文件 ,
/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/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
执行器支持集群部署，提升调度系统可用性，同时提升任务处理能力。
执行器集群部署时，要求和建议：
xxl.job.admin.addresses）需要保持一致；执行器根据该配置进行执行器自动注册等操作。xxl.job.executor.appname）需要保持一致；调度中心根据该配置动态发现不同集群的在线执行器列表。这个执行器集群好弄, 复制一下项目改改(端口)配置就好了
至此部署全部完成!!!
AppName字段应与执行器配置文件中 xxl.job.executor.appname 保持一致, 此字段用于服务发现,名字匹配上后,将自动读取xxl.job.executor.address字段(刷新并等待一会(30s)即可识别到地址)
部署完后,会有一个默认的执行器
也可以使用手动录入,指定ip:port 执行
可以设置多个执行器,一个执行器可以有多个ip(即集群部署)
基础配置：
触发配置：
任务配置：
高级配置：
来源官网
在samples中,有很好的例子,这里简单描述一下几个重点
使用方法级注解 @XxlJob(value=“名称”, init = “初始化方法”, destroy = “销毁方法”), 名字是必填项
方法返回值固定: ReturnT<String>
方法入参类型和数量固定: String 参数使用->做分片
方法返参类型固定: ReturnT<T>
源码位置: com.xxl.job.core.executor.impl.XxlJobSpringExecutor#initJobHandlerMethodRepository(ApplicationContext a):117
- 这里只讲bean模式,其他的比较简单,自个摸一摸
- ReturnT<T> 表示返回结果,T类型是String时,可以直接使用 ReturnT.SUCCESS 或者 ReturnT.FAIL, admin会根据返回码判定当前任务是否执行成功
- 以前是支持类级别的, 注解是 @JobHandler, 但现在已经不支持了…
- xxl-job 3.X的版本中,返回参数和入参不再强制指定
在当前执行器下,有如下任务,可以先执行一次,查看日志是否正常
日志分为两种:
调度中心只能看到xxl-job日志
com.xxl.job.admin.core.thread.JobScheduleHelper#start():70// 如果有激活环境的配置, 则后面拼接 环境 字符串, 但无论如何对于系统来说都是固定字符串,
String lockName = "schedule_lock";
// ...省略部分代码
preparedStatement = conn.prepareStatement( "select * from xxl_job_lock where lock_name = '" + lockName + "' for update" );
从锁可以看出, 在同一时间, 整个xxl-job中只有一个任务能执行, 这把锁真的大呢! 为什么锁的粒度不是任务呢?不是很懂,也许这也是个可以优化的点
分片:将任务拆分,分发到每个服务器上并发执行,以此增加执行
以执行器为粒度,根据执行器ip自然排序编号,结合任务入参,在发布任务时即可做到某片执行某些数据
分片代码:
for (int i = 0; i < group.getRegistryList().size(); i++) {
processTrigger(group, jobInfo, finalFailRetryCount, triggerType, i, group.getRegistryList().size());
}
com.xxl.job.admin.core.trigger.XxlJobTrigger#trigger(…):82
广播: 将完整任务分发每个服务器上(场景:每个执行节点的缓存更新/执行脚本)
代码同上,对每个服务器执行一次任务
参考文章: