1.简介
1.1概述
XXL-JOB是一个轻量级分布式任务调度框架,其核心设计目标是开发迅速、学习简单、轻量级、易拓展。代码开源,目前已接入多家公司线上产品,比较典型的有大众点评,优信二手车,一加手机等。
1.2特性
简单:支持通过Web页面对任务进行CRUD操作,操作简单;
动态:支持动态修改任务状态、暂停/恢复任务,以及终止运行中任务,即时生效;
调度中心HA:调度采用中心式设计,“调度中心”基于集群Quartz实现,可保证调度中心HA;
执行器HA(分布式):任务分布式执行,任务“执行器”支持集群部署,可保证任务执行HA;
任务Failover:执行器集群部署时,任务路由策略选择“故障转移”情况下调度失败时将会平滑切换执行器进行Failover;
一致性:“调度中心”通过DB锁保证集群分布式调度的一致性,一次任务调度只会触发一次执行;
自定义任务参数:支持在线配置调度任务入参,即时生效;
调度线程池:调度系统多线程触发调度运行,确保调度精确执行,不被堵塞;
弹性扩容缩容:一旦有新执行器上线或者下线,下次调度时将会重新分配任务;
邮件报警:任务失败时支持邮件报警,支持配置多邮件地址群发报警邮件;
状态监控:支持实时监控任务进度;
Rolling执行日志:支持在线查看调度结果,并且支持以Rolling方式实时查看执行器输出的完整的执行日志;
GLUE:提供Web IDE,支持在线开发任务逻辑代码,动态发布,实时编译生效,省略部署上线的过程。支持30个版本的历史版本回溯;
数据加密:调度中心和执行器之间的通讯进行数据加密,提升调度信息安全性;
任务依赖:支持配置子任务依赖,当父任务执行结束且执行成功后将会主动触发一次子任务的执行,多个子任务用逗号分隔;
推送maven中央仓库:将会把最新稳定版推送到maven中央仓库,方便用户接入和使用;
任务注册:执行器会周期性自动注册任务,调度中心将会自动发现注册的任务并触发执行。同时,也支持手动录入执行器地址;
路由策略:执行器集群部署时提供丰富的路由策略,包括:第一个、最后一个、轮询、随机、一致性Hash、最不经常使用、最近最久未使用、故障转移、忙碌转移等;
1.3下载
源码仓库地址
https://github.com/xuxueli/xxl-jobDownload
中央仓库地址
2.项目实践
2.1初始化“调度数据库”
数据库环境:Mysql5.6+
初始化SQL脚本tables_xxl_job.sql,正常情况下应该生成16张表。
调度中心支持集群部署,集群情况下各节点务必连接同一个Mysql示例
导入源码
xxl-job-admin:调度中心
xxl-job-executor:执行器
xxl-job-executor-sample-springboot:Springboot版本,通过Springboot管理执行器
2.2部署“调度中心”
调度中心配置:/xxl-job/xxl-job-admin/src/main/resources/xxl-job-admin.properties
配置内容说明:
>>>>>邮箱地址无效需自行配置
>>>>>dispatchertask为数据库名称
部署项目
正确配置后,将项目编译打包(war)部署在tomcat(/webapps目录下),修改tomcat配置文件,如下,即代表调度中心部署成功。
调度中心访问地址http://localhost:8080/xxl-job-admin,登录后运行界面如下图所示
3.部署执行器项目
3.1配置文件和配置类
确认pom文件引入了xxl-job-core的maven依赖,添加执行器配置:
Addresses:调度中心部署根地址,执行器将会使用该地址进行执行器心跳注册和任务结果回调
Appname:执行器心跳注册分组依据,即同一个集群下的执行器appname必须一致
Ip:默认为空表示自动获取IP,也可以手动设置
Port:执行器默认端口9999,集群下的执行器要配置不同的端口
AccessToken:执行器通讯Token,非空时启用,进行数据加密
注:日志基于logback,logback的使用请另找出处。
Config配置
3.2执行器集群
执行器支持集群部署,提升调度系统可用性,同时提升任务处理能力
集群部署唯一要求为:保证集群中每个执行器的配置项“调度中心地址”保持一致,执行器根据配置进行执行器自动注册等操作。
调度中心添加执行器
AppName:执行器配置中的Appname值,执行器会周期性以AppName为对象进行自动注册。
名称:执行器名称,因为AppName限制字母数字等组成,可读性不强,名称为了提高执行器的可读性
排序:执行器的排序,新增任务时,将会按照该排序读取可用的执行器列表
注册方式:调度中心获取执行器地址的方式;
自动注册:执行器自动进行执行器注册,调度中心通过底层注册表可以动态发现执行器地址
手动录入:人工手动录入执行器的地址信息,多地址逗号分隔,供调度中心使用
机器地址:“注册方式”为手动录入时有效,支持人工维护执行器的地址信息。
3.4新建任务
想要完成什么样的功能,必须由开发者手动编写实现,以“获取所有航司数据”为例:
>>>>execute方法实现自己要执行的任务
运行执行器之后,即可在调度中心新增任务
执行器:任务的绑定的执行器,任务触发调度时将会自动发现注册成功的执行器
描述:任务的描述信息,便于任务管理
路由策略:当执行器集群部署时,提供丰富的路由策略,包括,
第一个:固定选择第一个机器;
最后一个:固定选择最后一个机器;
轮询:执行器循环执行
随机:随机选择在线的机器
一致性HASH:每个任务按照Hash算法固定选择某一台机器,且所有任务均匀散列在不同机器上
最不经常使用:使用频率最低的机器优先被选举
最近最久未使用:轮询的倒序选用
故障转移:按照顺序依次进行心跳检测,第一个心跳检测成功的机器选定为目标执行器并发起调度
忙碌转移:按照顺序依次进行空闲检测,第一个空闲检测成功的机器选定为目标执行器并发起调度
Cron:触发任务执行的Cron表达式
运行模式:
模式:任务以JobHandler方式维护在执行器端,需要结合“JobHandler”属性匹配执行器中任务
JobHandler:运行模式为“Bean”时生效,对应执行器中新开发的JobHandler类@JobHandler注解自定义的value值
子任务Key:每个任务都拥有一个唯一的任务Key(任务Key可以从任务列表获取),当本任务执行结束并且执行成功时,将会触发子任务Key所对应的任务的一次主动调度。
阻塞处理策略:调度过于密集执行器来不及处理时的处理策略,
单机串行:调度请求进入单机执行器后,调度请求进入FIFO队列并以串行方式运行;
丢弃后续调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,本次请求将会将丢弃并标记为失败;
覆盖之前调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,将会终止运行中的调度任务并清空队列,然后运行本地调度任务
失败处理策略:
失败告警:调度失败时,将会触发失败报警,如发送报警邮件;
失败重试:调度失败时,将会主动进行一次失败重试调度,重试调度后仍然失败将会触发失败告警。注意当任务以failover方式路由时,每次失败重试将会触发新一轮路由;
执行参数:任务执行所需的参数,多个参数时用逗号分隔,任务执行时将会把多个参数转换为数组传入
报警邮件:任务调度失败时邮件通知的邮箱地址,支持配置多邮箱地址,配置多个邮箱地址时用逗号分隔
3.5Cron表达式详细用法
Cron表达式的格式
{秒数}{分钟}{小数}{日期}{月份}{星期}{年份{可为空}}
| 字段 | 允许值 | 允许的特殊字符 |
| -------- | -----: | :----: |
| 秒 | 0-59 | , - * / |
| 分 | 0-59 | , - * / |
| 小时 | 0-23 | , - * / |
| 日期 | 1-31 | , - * ? / L W C |
| 月份 | 1-12或者JAN-DEC | , - * / |
| 星期 | 1-12或者JAN-DEC | , - * ? / L W C # |
| 年 | 1970-2099 | , - * / |
秒
允许值范围:0~59,不允许为空值
“*”代表每隔1秒钟触发
“,”代表在指定的秒数触发,比如”0,15,45”代表0秒、15秒和45秒触发
“-”代表在指定的范围内触发,比如”25-45”代表从25秒开始触发到45秒结束触发,每隔1秒触发一次
“/”代表触发步进,”/”前面的值代表初始值("*”等同”0”),后面的值代表偏移量,比如”0/20”或者”*/20”代表从0秒开始,每隔20秒触发一次
特殊字符
“*”
“*”字符被用来指定所有的值。如:"*"在分钟的字段域里表示“每分钟”。
“?”
“?”字符只在日期域和星期域中使用。它被用来指定“非明确的值”。当你需要通过在这两个域中的一个来指定一些东西的时候,它是有用的。
“-”
“-”字符被用来指定一个范围。如:“10-12”在小时域意味着“10点、11点、12点”。
“,”
“,”字符被用来指定另外的值。如:“MON,WED,FRI”在星期域里表示”星期一、星期三、星期五”。
“/”
“/”字符用于指定增量。如:“0/15”在秒域意思是每分钟的0,15,30和45秒。“5/15”在分钟域表示每小时的5,20,35和50。符号“*”在“/”前面(如:*/10)等价于0在“/”前面(如:0/10)。记住一条本质:表达式的每个数值域都是一个有最大值和最小值的集合,如:秒域和分钟域的集合是0-59,日期域是1-31,月份域是1-12。字符“/”可以帮助你在每个字符域中取相应的数值。如:“7/6”在月份域的时候只有当7月的时候才会触发,并不是表示每个6月。
“W”
字符“W”只允许日期域出现。这个字符用于指定日期的最近工作日。例如:如果你在日期域中写“15W”,表示:这个月15号最近的工作日。所以,如果15号是周六,则任务会在14号触发。如果15号是周日,则任务会在周一也就是16号触发。
“#”
字符“#”只允许在星期域中出现。这个字符用于指定本月的某某天。例如:“6#3”表示本月第三周的星期五(6表示星期五,3表示第三周)。
“C”
字符“C”允许在日期域和星期域出现。这个字符依靠一个指定的“日历”。也就是说这个表达式的值依赖于相关的“日历”的计算结果,如果没有“日历”关联,则等价于所有包含的“日历”。如:日期域是“5C”表示关联“日历”中第一天,或者这个月开始的第一天的后5天。星期域是“1C”表示关联“日历”中第一天,或者星期的第一天的后1天,也就是周日的后一天(周一)。