一、前言
公司服务器上有非常多的定时任务,管理起来非常不便,而且如果有定时任务执行失败了也不能及时收到通知;因此引入xxl-job任务调度平台对定时任务进行统一管理。
XXL-JOB特性
- 简单:支持通过Web页面对任务进行CRUD操作,操作简单,一分钟上手
- 动态:支持动态修改任务状态、启动/停止任务,以及终止运行中任务,即时生效
- 调度中心HA(中心式):调度采用中心式设计,“调度中心”基于集群Quartz实现并支持集群部署,可保证调度中心HA
- 执行器HA(分布式):任务分布式执行,任务”执行器”支持集群部署,可保证任务执行HA
- 注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时,也支持手动录入执行器地址
- 弹性扩容缩容:一旦有新执行器机器上线或者下线,下次调度时将会重新分配任务
- 路由策略:执行器集群部署时提供丰富的路由策略,包括:第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等
- 故障转移:任务路由策略选择”故障转移”情况下,如果执行器集群中某一台机器故障,将会自动Failover切换到一台正常的执行器发送调度请求。
- 阻塞处理策略:调度过于密集执行器来不及处理时的处理策略,策略包括:单机串行(默认)、丢弃后续调度、覆盖之前调度
- 任务超时控制:支持自定义任务超时时间,任务运行超时将会主动中断任务
- 任务失败重试:支持自定义任务失败重试次数,当任务失败时将会按照预设的失败重试次数主动进行重试;其中分片任务支持分片粒度的失败重试
- 任务失败告警;默认提供邮件方式失败告警,同时预留扩展接口,可方便的扩展短信、钉钉等告警方式
- 分片广播任务:执行器集群部署时,任务路由策略选择”分片广播”情况下,一次任务调度将会广播触发集群中所有执行器执行一次任务,可根据分片参数开发分片任务
- 动态分片:分片广播任务以执行器为维度进行分片,支持动态扩容执行器集群从而动态增加分片数量,协同进行业务处理;在进行大数据量业务操作时可显著提升任务处理能力和速度
- 事件触发:除了”Cron方式”和”任务依赖方式”触发任务执行之外,支持基于事件的触发任务方式。调度中心提供触发任务单次执行的API服务,可根据业务事件灵活触发
- 任务进度监控:支持实时监控任务进度
- Rolling实时日志:支持在线查看调度结果,并且支持以Rolling方式实时查看执行器输出的完整的执行日志
- GLUE:提供Web IDE,支持在线开发任务逻辑代码,动态发布,实时编译生效,省略部署上线的过程。支持30个版本的历史版本回溯
- 脚本任务:支持以GLUE模式开发和运行脚本任务,包括Shell、Python、NodeJS、PHP、PowerShell等类型脚本
- 命令行任务:原生提供通用命令行任务Handler(Bean任务,”CommandJobHandler”);业务方只需要提供命令行即可
- 任务依赖:支持配置子任务依赖,当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔
- 一致性:“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行
- 自定义任务参数:支持在线配置调度任务入参,即时生效
- 调度线程池:调度系统多线程触发调度运行,确保调度精确执行,不被堵塞
- 数据加密:调度中心和执行器之间的通讯进行数据加密,提升调度信息安全性
- 邮件报警:任务失败时支持邮件报警,支持配置多邮件地址群发报警邮件
- 推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用
- 运行报表:支持实时查看运行数据,如任务数量、调度次数、执行器数量等;以及调度报表,如调度日期分布图,调度成功分布图等
- 全异步:任务调度流程全异步化设计实现,如异步调度、异步运行、异步回调等,有效对密集调度进行流量削峰,理论上支持任意时长任务的运行
- 跨平台:原生提供通用HTTP任务Handler(Bean任务,”HttpJobHandler”),业务方只需要提供HTTP链接即可,不限制语言、平台
- 国际化:调度中心支持国际化设置,提供中文、英文两种可选语言,默认为中文
- 容器化:提供官方docker镜像,并实时更新推送dockerhub,进一步实现产品开箱即用
- 线程池隔离:调度线程池进行隔离拆分,慢任务自动降级进入”Slow”线程池,避免耗尽调度线程,提高系统稳定性
二、部署 XXL-JOB
环境
- Maven3+
- Jdk1.8+
- Mysql5.7+
2.1 准备工作
安装maven
1 | [admin@centos7 ~]$ sudo yum install -y maven |
安装jdk 1.8
1 | [admin@centos7 ~]$ wget --no-cookies --no-check-certificate --header "Cookie: gpw_e24=http%3A%2F%2Fwww.oracle.com%2F; oraclelicense=accept-securebackup-cookie" "http://download.oracle.com/otn-pub/java/jdk/8u141-b15/336fa29ff2bb4ef291e347e091f7f4a7/jdk-8u141-linux-x64.tar.gz" |
安装mysql 5.7
1 | [admin@centos7 ~]$ wget -i -c http://dev.mysql.com/get/mysql57-community-release-el7-10.noarch.rpm |
MySQL数据库设置
1 | [admin@centos7 ~]$ systemctl start mysqld.service |
2.2 初始化“调度数据库”
下载xxl-job
1 | [admin@centos7 downloads]$ wget https://github.com/xuxueli/xxl-job/archive/v2.2.0.tar.gz |
初始xxl-job化数据库
1 | mysql> create database xxl_job; |
创建xxl-job用户
1 | mysql> grant all on xxl_job.* to 'xxljob'@'%' identified by 'Abc.123456'; |
2.3 部署调度中心
调度中心项目:xxl-job-admin
作用:统一管理任务调度平台上调度任务,负责触发调度执行,并且提供任务管理平台。
步骤一:配置调度中心
1 | [admin@centos7 downloads]$ cd xxl-job-admin |
调度中心配置内容说明:
1 | ## 调度中心JDBC链接:链接地址请保持和 2.1章节 所创建的调度数据库的地址一致 |
步骤二:部署调度中心项目
如果已经正确进行上述配置,可将项目编译打包部署。
1 | [admin@centos7 xxl-job-admin]$ mvn install |
添加到系统服务
1 | [admin@centos7 xxl-job-admin]$ sudo vim /usr/lib/systemd/system/xxl-job-admin.service |
调度中心访问地址:http://localhost:8080/xxl-job-admin (该地址执行器将会使用到,作为回调地址)
默认登录账号 “admin/123456”, 登录后运行界面如下图所示。
至此“调度中心”项目已经部署成功。
步骤三:调度中心集群(可选)
调度中心支持集群部署,提升调度系统容灾和可用性。
调度中心集群部署时,几点要求和建议:
- DB配置保持一致;
- 登陆账号配置保持一致;
- 集群机器时钟保持一致(单机集群忽视);
- 建议:推荐通过nginx为调度中心集群做负载均衡,分配域名。调度中心访问、执行器回调配置、调用API服务等操作均通过该域名进行。
2.4 部署执行器
执行器项目:xxl-job-executor-samples
作用:执行器负责接收“调度中心”的调度并执行;
步骤一:配置执行器
这里使用springboot
1 | [admin@centos7 xxl-job-admin]$ cd ../xxl-job-executor-samples/xxl-job-executor-sample-springboot/ |
执行器配置,配置内容说明:
1 | ### 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册; |
步骤二:部署执行器项目
如果已经正确进行上述配置,可将执行器项目编译打部署。
1 | [admin@centos7 xxl-job-executor-sample-springboot]$ mvn install |
添加到系统服务
1 | [admin@centos7 xxl-job-admin]$ sudo vim /usr/lib/systemd/system/xxl-job-executor.service |
至此“执行器”项目已经部署结束。
步骤三:执行器集群(可选):
执行器支持集群部署,提升调度系统可用性,同时提升任务处理能力。
执行器集群部署时,几点要求和建议:
- 执行器回调地址(xxl.job.admin.addresses)需要保持一致;执行器根据该配置进行执行器自动注册等操作。
- 同一个执行器集群内AppName(xxl.job.executor.appname)需要保持一致;调度中心根据该配置动态发现不同集群的在线执行器列表。
2.5 添加第一个任务
这里以查看linux系统时间为例:
添加执行器
部署好执行器后,在xxl-job控制台 –>> 执行器管理 –>> 新增(新增执行器)
稍等几秒后,便可看到执行器已经注册进来了
添加并执行第一个任务
点击 xxl-job控制台 –>> 任务管理 –>> 新增(新增一个任务)
然后,找到刚刚新建的任务,选择右则操作 -->> GLUEIDE
写好你需要执行的命令/代码,然后保存
执行任务
在任务管理
中找到刚刚添加的任务,选择右则操作 -->> 执行一次
任务执行后,可在调度日志
中查看任务执行结果,以及执行日志;
任务代码调试完成即可在任务管理
中启动任务,调度中心会根据任务配置的时间执行相应的任务,当配置好邮箱和收件人可以在任务执行失败时发出告警邮件。