本地测试要用到xxl-job,官方文档关于docker部署xxl-job描述的不够详细,所以写一个关于docker部署xxl-job的文章
xxl-job是什么
XXL-JOB是一个轻量级分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
github地址: GitHub - xuxueli/xxl-job: A lightweight distributed task scheduling framework.(分布式任务调度平台
XXL-JOB)
Quartz的不足
问题一:调用API的的方式操作任务,不人性化;
问题二:需要持久化业务QuartzJobBean到底层数据表中,系统侵入性相当严重。
问题三:调度逻辑和QuartzJobBean耦合在同一个项目中,这将导致一个问题,在调度任务数量逐渐增多,同时调度任务逻辑逐渐加重的情况加,此时调度系统的性能将大大受限于业务;
问题四:quartz底层以“抢占式”获取DB锁并由抢占成功节点负责运行任务,会导致节点负载悬殊非常大;而XXL-JOB通过执行器实现“协同分配式”运行任务,充分发挥集群优势,负载各节点均衡。
XXL-JOB弥补了quartz的上述不足之处。
xxl-job的特性
1、简单:支持通过Web页面对任务进行CRUD操作,操作简单,一分钟上手;
2、动态:支持动态修改任务状态、启动/停止任务,以及终止运行中任务,即时生效;
3、调度中心HA(中心式):调度采用中心式设计,“调度中心”自研调度组件并支持集群部署,可保证调度中心HA;
4、执行器HA(分布式):任务分布式执行,任务"执行器"支持集群部署,可保证任务执行HA;
5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时,也支持手动录入执行器地址;
6、弹性扩容缩容:一旦有新执行器机器上线或者下线,下次调度时将会重新分配任务;
7、路由策略:执行器集群部署时提供丰富的路由策略,包括:第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等;
8、故障转移:任务路由策略选择"故障转移"情况下,如果执行器集群中某一台机器故障,将会自动Failover切换到一台正常的执行器发送调度请求。
9、阻塞处理策略:调度过于密集执行器来不及处理时的处理策略,策略包括:单机串行(默认)、丢弃后续调度、覆盖之前调度;
10、任务超时控制:支持自定义任务超时时间,任务运行超时将会主动中断任务;
11、任务失败重试:支持自定义任务失败重试次数,当任务失败时将会按照预设的失败重试次数主动进行重试;其中分片任务支持分片粒度的失败重试;
12、任务失败告警;默认提供邮件方式失败告警,同时预留扩展接口,可方便的扩展短信、钉钉等告警方式;
13、分片广播任务:执行器集群部署时,任务路由策略选择"分片广播"情况下,一次任务调度将会广播触发集群中所有执行器执行一次任务,可根据分片参数开发分片任务;
14、动态分片:分片广播任务以执行器为维度进行分片,支持动态扩容执行器集群从而动态增加分片数量,协同进行业务处理;在进行大数据量业务操作时可显著提升任务处理能力和速度。
15、事件触发:除了"Cron方式"和"任务依赖方式"触发任务执行之外,支持基于事件的触发任务方式。调度中心提供触发任务单次执行的API服务,可根据业务事件灵活触发。
16、任务进度监控:支持实时监控任务进度;
17、Rolling实时日志:支持在线查看调度结果,并且支持以Rolling方式实时查看执行器输出的完整的执行日志;
18、GLUE:提供Web IDE,支持在线开发任务逻辑代码,动态发布,实时编译生效,省略部署上线的过程。支持30个版本的历史版本回溯。
19、脚本任务:支持以GLUE模式开发和运行脚本任务,包括Shell、Python、NodeJS、PHP、PowerShell等类型脚本;
20、命令行任务:原生提供通用命令行任务Handler(Bean任务,"CommandJobHandler");业务方只需要提供命令行即可;
21、任务依赖:支持配置子任务依赖,当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔;
22、一致性:“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行;
23、自定义任务参数:支持在线配置调度任务入参,即时生效;
24、调度线程池:调度系统多线程触发调度运行,确保调度精确执行,不被堵塞;
25、数据加密:调度中心和执行器之间的通讯进行数据加密,提升调度信息安全性;
26、邮件报警:任务失败时支持邮件报警,支持配置多邮件地址群发报警邮件;
27、推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用;
28、运行报表:支持实时查看运行数据,如任务数量、调度次数、执行器数量等;以及调度报表,如调度日期分布图,调度成功分布图等;
29、全异步:任务调度流程全异步化设计实现,如异步调度、异步运行、异步回调等,有效对密集调度进行流量削峰,理论上支持任意时长任务的运行;
30、跨平台:原生提供通用HTTP任务Handler(Bean任务,"HttpJobHandler");业务方只需要提供HTTP链接即可,不限制语言、平台;
31、国际化:调度中心支持国际化设置,提供中文、英文两种可选语言,默认为中文;
32、容器化:提供官方docker镜像,并实时更新推送dockerhub,进一步实现产品开箱即用;
33、线程池隔离:调度线程池进行隔离拆分,慢任务自动降级进入"Slow"线程池,避免耗尽调度线程,提高系统稳定性;
34、用户管理:支持在线管理系统用户,存在管理员、普通用户两种角色;
35、权限控制:执行器维度进行权限控制,管理员拥有全量权限,普通用户需要分配执行器权限后才允许相关操作;
第一次尝试
- 直接利用docker启动xxl-job-admin
docker run -d --name xxl-job-admin --net host xuxueli/xxl-job-admin:2.0.2
- 然后发现并没有启动,我们看一下日志
docker logs xxl-job-admin
看报错是因为数据库密码错误,然后发现xxl-job-admin的docker hub主页并没有说明有哪些参数,翻了一下官方文档
- 官方文档给我们的示例是使用--spring.datasource.url这种方式覆盖默认配置,但是实际上这种方式创建容器后就不能再进行修改了,比如说换个端口,换个数据库地址就不行,所以不采用这种方式
docker run -p 8080:8080 -v /tmp:/data/applogs --name xxl-job-admin -d xuxueli/xxl-job-admin
/**
* 如需自定义 mysql 等配置,可通过 "PARAMS" 指定,参数格式 RAMS="--key=value --key2=value2" ;
* 配置项参考文件:/xxl-job/xxl-job-admin/src/main/resources/application.properties
*/
docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?Unicode=true&characterEncoding=UTF-8" -p 8080:8080 -v /tmp:/data/applogs --name xxl-job-admin -d xuxueli/xxl-job-admin
xxl-job-admin DockerFile文件
docker hub官方镜像地址: xxl-job-admin
先分析一下xxl-job-admin的docker file文件
FROM openjdk:7-jre-slim
MAINTAINER xuxueli
# 声明PARAMS环境变量
ENV PARAMS=""
# 设置时区默认为中国, PRC就是中华人民共和国
ENV TZ=PRC
RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
# 添加jar包到镜像中, 启动的jar包位置为/app.jar
ADD target/xxl-job-admin-*.jar /app.jar
# 容器启动的运行命令, PARAMS环境变量为命令行参数
ENTRYPOINT ["sh","-c","java -jar /app.jar $PARAMS"]
看到这里我们能够操作的也就只有$PARAMS参数了, 我们可以将application.properties配置文件映射到容器内部
, 然后利用spring.config.location
覆盖默认的启动配置文件
xxl-job-admin application.properties文件
### web
# 端口号
server.port=8080
# 根目录, 启动后的访问地址为: http://ip:[server.port]/[server.context-path]
server.context-path=/xxl-job-admin
### resources
# 静态资源配置, 不需要修改
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/
### freemarker
# freemarker模版配置, 不需要修改
spring.freemarker.templateLoaderPath=classpath:/templates/
spring.freemarker.suffix=.ftl
spring.freemarker.charset=UTF-8
spring.freemarker.request-context-attribute=request
spring.freemarker.settings.number_format=0.##########
### mybatis
# mybatis配置, 不需要修改
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
### xxl-job, datasource
# 数据库配置, 根据实际情况修改
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
spring.datasource.type=org.apache.tomcat.jdbc.pool.DataSource
spring.datasource.tomcat.max-wait=10000
spring.datasource.tomcat.max-active=30
spring.datasource.tomcat.test-on-borrow=true
spring.datasource.tomcat.validation-query=SELECT 1
spring.datasource.tomcat.validation-interval=30000
### xxl-job email
# 邮件发送配置
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
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
### xxl-job, access token
# 和客户端通信的token, 非空的时候启用, 如果不为空, 则客户端也需要填相同的token
xxl.job.accessToken=
### xxl-job, i18n (default empty as chinese, "en" as english)
# 国际化, 不需要改
xxl.job.i18n=
第二次尝试
将application.properties配置文件映射到容器内部
, 然后利用spring.config.location
覆盖默认的启动配置文件
- 首先将xxl-job-admin的数据库脚本下载下来
wget https://raw.githubusercontent.com/xuxueli/xxl-job/2.0.2/doc/db/tables_xxl_job.sql
- 在数据库中执行下载下来的脚本
- 下载application.properties
wget https://raw.githubusercontent.com/xuxueli/xxl-job/2.0.2/xxl-job-admin/src/main/resources/application.properties
- 修改数据库配置,以及端口号等配置
- 拉取镜像
docker pull xuxueli/xxl-job-admin:2.0.2
- 启动容器
docker run -d --name xxl-job-admin -v [修改后的配置文件位置]:/application.properties --net host -e PARAMS='--spring.config.location=/application.properties' xuxueli/xxl-job-admin:2.0.2
使用-v将修改后application.properties映射到容器内/application.properties,
--net因为是部署本地开发环境, 所以直接使用了host(共享宿主机网络), 或者也可以使用-p 8080:8080映射端口号(第一个8080为本机端口, 第二个8080为server.port端口), 使用-e来配置PARAMS环境变量,
--spring.config.location=/application.properties
这个参数的含义是指使用指定的配置文件启动xxl-job-admin
- 访问http://localhost:8080/xxl-job-admin (如果修改过配置则访问 http://ip:[server.port]/[server.context-path])即可,默认用户名为admin,密码为123456