spring传统的定时任务@Scheduled,但是这样存在这一些问题 :
-
-
cron表达式定义在代码之中,修改不方便;
-
定时任务失败了,无法重试也没有统计;
-
解决这些问题的方案为:xxl-job 分布式任务调度框架
一、
1、
将单体应用拆分成多个微服务,为了提升系统并发可用性,我们做集群,
将任务调度程序分布式构建,这样就可以具有分布式系统的特点,并且提高任务的调度处理能力:
(1)、并行任务调度
并行任务调度实现靠多线程,如果有大量任务需要调度,此时光靠多线程就会有瓶颈了,因为一台计算机CPU的处理能力是有限的。
如果将任务调度程序分布式部署,每个结点还可以部署为集群,这样就可以让多台计算机共同去完成任务调度,我们可以将任务分割为若干个分片,由不同的实例并行执行,来提高任务调度的处理效率。
(2)、高可用
若某一个实例宕机,不影响其他实例来执行任务。
(3)、弹性扩容
当集群中增加实例就可以提高并执行任务的处理效率。
(4)、任务管理与监测
对系统中存在的所有定时任务进行统一的管理及监测。让开发人员及运维人员能够时刻了解任务执行情况,从而做出快速的应急处理响应。
分布式任务调度面临的问题:
当任务调度以集群方式部署,同一个任务调度可能会执行多次,例如:电商系统定期发放优惠券,就可能重复发放优惠券,对公司造成损失,信用卡还款提醒就会重复执行多次,给用户造成烦恼,所以我们需要控制相同的任务在多个运行实例上只执行一次。常见解决方案:
2、
这是美团公司一个程序员开源的框架
针对分布式任务调度的需求,市场上出现了很多的产品:
1)、TBSchedule:淘宝推出的一款非常优秀的高性能分布式调度框架,目前被应用于阿里、京东、支付宝、国美等很多互联网企业的流程调度系统中。但是已经多年未更新,文档缺失严重,缺少维护。
2)、XXL-Job:大众点评的分布式任务调度平台,是一个轻量级分布式任务调度平台, 其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
3)、Elastic-job:当当网借鉴TBSchedule并基于quartz 二次开发的弹性分布式任务调度系统,功能丰富强大,采用zookeeper实现分布式协调,具有任务高可用以及分片功能。
4)、Saturn: 唯品会开源的一个分布式任务调度平台,基于Elastic-job,可以全域统一配置,统一监 控,具有任务高可用以及分片功能。
XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。
源码地址:https://gitee.com/xuxueli0323/xxl-job
文档地址:https://www.xuxueli.com/xxl-job/
特性
-
-
丰富的任务管理功能 支持页面对任务CRUD操作; 支持在页面编写脚本任务、命令行任务、Java代码任务并执行; 支持任务级联编排,父任务执行结束后触发子任务执行; 支持设置指定任务执行节点路由策略,包括轮询、随机、广播、故障转移、忙碌转移等; 支持Cron方式、任务依赖、调度中心API接口方式触发任务执行
-
高性能 任务调度流程全异步化设计实现,如异步调度、异步运行、异步回调等,有效对密集调度进行流量削峰;
-
高可用 任务调度中心、任务执行节点均 集群部署,支持动态扩展、故障转移 支持任务配置路由故障转移策略,执行器节点不可用是自动转移到其他节点执行 支持任务超时控制、失败重试配置 支持任务处理阻塞策略:调度当任务执行节点忙碌时来不及执行任务的处理策略,包括:串行、抛弃、覆盖策略
-
易于监控运维 支持设置任务失败邮件告警,预留接口支持短信、钉钉告警;
3、XXL-Job-环境搭建
(1)、
-
-
Jdk1.8+
-
(2)、
Release Download | |
---|---|
https://github.com/xuxueli/xxl-job | |
http://gitee.com/xuxueli0323/xxl-job |
我们访问马云上面的地址去下载源码,我们下载2.3.0版本。
也可以使用资料文件夹中的源码,目录结构如下:
使用idea打开
xxl-job-admin为调度中心,一会我们会部署这个调度中心。
xxl-job-core为核心源码,如果我们想要在项目中使用xxl-job,必须导入这个核心依赖。xxl-job-executor-samples是一些案例,我们会重点分析xxl-job-executor-sample-springboot这个springboot集成样例。
(3)、
请下载项目源码并解压,获取 “调度数据库初始化SQL脚本” 并执行即可。
位置:/xxl-job/doc/db/tables_xxl_job.sql
共8张表
- xxl_job_lock:任务调度锁表; - xxl_job_group:执行器信息表,维护任务执行器信息; - xxl_job_info:调度扩展信息表: 用于保存XXL-JOB调度任务的扩展信息,如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等; - xxl_job_log:调度日志表: 用于保存XXL-JOB任务调度的历史信息,如调度结果、执行结果、调度入参、调度机器和执行器等等; - xxl_job_logglue:任务GLUE日志:用于保存GLUE更新历史,用于支持GLUE的版本回溯功能; - xxl_job_registry:执行器注册表,维护在线的执行器和调度中心机器地址信息; - xxl_job_user:系统用户表;
调度中心支持集群部署,集群情况下各节点务必连接同一个mysql实例;
如果mysql做主从,调度中心集群节点务必强制走主库;
4、
调度中心项目:xxl-job-admin
作用:统一管理任务调度平台上调度任务,负责触发调度执行,并且提供任务管理平台。
步骤一:调度中心配置
数据库的连接信息修改为自己的数据库,修改端口,避免冲突。
### web server.port=8989 server.servlet.context-path=/xxl-job-admin ### actuator management.server.servlet.context-path=/actuator management.health.mail.enabled=false ### resources spring.mvc.servlet.load-on-startup=0 spring.mvc.static-path-pattern=/static/** spring.resources.static-locations=classpath:/static/ ### 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.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml #mybatis.type-aliases-package=com.xxl.job.admin.core.model ### xxl-job, datasource 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=123456 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver ### datasource-pool spring.datasource.type=com.zaxxer.hikari.HikariDataSource spring.datasource.hikari.minimum-idle=10 spring.datasource.hikari.maximum-pool-size=30 spring.datasource.hikari.auto-commit=true spring.datasource.hikari.idle-timeout=30000 spring.datasource.hikari.pool-name=HikariCP spring.datasource.hikari.max-lifetime=900000 spring.datasource.hikari.connection-timeout=10000 spring.datasource.hikari.connection-test-query=SELECT 1 spring.datasource.hikari.validation-timeout=1000 ### xxl-job, email spring.mail.host=smtp.qq.com spring.mail.port=25 spring.mail.username=xxx@qq.com spring.mail.from=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 xxl.job.accessToken= ### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en") xxl.job.i18n=zh_CN ## xxl-job, triggerpool max size xxl.job.triggerpool.fast.max=200 xxl.job.triggerpool.slow.max=100 ### xxl-job, log retention days xxl.job.logretentiondays=30
启动调度中心,浏览器访问:http://localhost:8989/xxl-job-admin/toLogin,
默认登录账号 “admin/123456”, 登录后运行界面如下图所示。
说明调度中心安装完毕。
由于调度中心是一个服务,我们可以将xxl-job-admin打成一个jar包,然后通过java -jar xxl-job-admin-2.3.0.jar来启动。还可以创建startup.bat文件,内容为java -jar xxl-job-admin-2.3.0.jar,这样,双击该文件就可以启动。
5、
(1)、创建mysql容器,初始化xxl-job的SQL脚本
docker run -p 3306:3306 --name mysql57 \ -v /opt/mysql/conf:/etc/mysql \ -v /opt/mysql/logs:/var/log/mysql \ -v /opt/mysql/data:/var/lib/mysql \ -e MYSQL_ROOT_PASSWORD=root \ -d mysql:5.7
获取 “调度数据库初始化SQL脚本” 并执行。
(2)、拉取镜像
docker pull xuxueli/xxl-job-admin:2.3.0
(3)、创建容器
docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://172.17.0.2:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 \ --spring.datasource.username=root \ --spring.datasource.password=123456" \ -p 8989:8080 -v /tmp:/data/applogs \ --name xxl-job-admin --restart=always -d xuxueli/xxl-job-admin:2.3.0
注意:172.17.0.2是mysql在bridge网段的IP。mysql和xxl-job在同一网段。
去掉\改成一行执行
docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://172.17.0.2:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 --spring.datasource.username=root --spring.datasource.password=123456" -p 8989:8080 -v /tmp:/data/applogs --name xxl-job-admin --restart=always -d xuxueli/xxl-job-admin:2.3.0
如果是云服务器,则在安全组中放开8989端口。
浏览器访问:http://IP:8989/xxl-job-admin/toLogin,进入如下所示页面:
默认登录账号 “admin/123456”, 登录后运行界面如下图所示。
说明调度中心安装完毕。
二、xxl-job入门案例
1、
点击执行器管理,发现已经创建好了一个执行器:
我们根据项目名xxl-job-demo添加一个执行器
如果选择“自动注册”,那么“机器地址”中将禁止输入。
注意:AppName输入框中的值与执行器xxl-job-demo中配置文件的名称(xxl.job.executor.appname)保持一致,而不是跟spring.application.name保持一直,否则会出现执行器无法注册的情况。
名称输入框任意填写。
xxl: job: executor: appname: xxl-job-demo
启动执行器即xxl-job-demo项目,刷新执行器管理页面,效果如下:
发现有一个节点已经注册进来了,执行器注册成功。
执行器其实是根据任务进行分类。创建任务的时候必须指定在哪一个执行器下创建。
2、
点击编辑,修改cron表达式为:0/1 * * * * ? *,表示每秒运行一次
我们自己创建一个任务
注意:demoJobHandler要与@XxlJob注解中的值一致。
点击保存,如下所示
3、创建一个springboot工程并引入依赖
<!-- 继承Spring boot工程 --> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.2.1.RELEASE</version> </parent> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <!--xxl-job--> <dependency> <groupId>com.xuxueli</groupId> <artifactId>xxl-job-core</artifactId> <version>2.3.0</version> </dependency> </dependencies>
4、编写application.yml配置文件
server: port: 8881 xxl: job: admin: addresses: http://127.0.0.1:8989/xxl-job-admin executor: appname: xxl-job-demo port: 9898
定义执行器的名称xxl-job-demo和端口9898,执行器xxl-job-demo中配置文件的名称要与xxl-job-admin中AppName输入框中的值保持一致。
执行器端口可以自定义。如果有多个实例,则端口不要重复。
注意:调度中心要能访问本地才行,不能把调度中心放到云服务器,把该demo放到本地电脑。
XXL-JOB执行器的相关配置项的意义:
(1)、xxl.job.admin.addresses
调度中心的部署地址。若调度中心采用集群部署,存在多个地址,则用逗号分隔。执行器将会使用该地址进行”执行器心跳注册”和”任务结果回调”。
(2)、xxl.job.executor.appname
执行器的应用名称,它是执行器心跳注册的分组依据。
(3)、xxl.job.executor.ip
执行器的IP地址,用于”调度中心请求并触发任务”和”执行器注册”。执行器IP默认为空,表示自动获取IP。多网卡时可手动设置指定IP,手动设置IP时将会绑定Host。
(4)、xxl.job.executor.port
执行器的端口号,默认值为9999。单机部署多个执行器时,注意要配置不同的执行器端口。
(5)、xxl.job.accessToken
执行器的通信令牌,非空时启用。
(6)、xxl.job.executor.logpath
执行器输出的日志文件的存储路径,需要拥有该路径的读写权限。
(7)、xxl.job.executor.logretentiondays
执行器日志文件的定期清理功能,指定日志保存天数,日志文件过期自动删除。限制至少保存3天,否则功能不生效。
更多配置时如下:
xxl.job.admin.addresses=http://127.0.0.1:8989/xxl-job-admin xxl.job.executor.appname=xxl-job-cmdptcp xxl.job.executor.port=9897 xxl.job.executor.ip= xxl.job.executor.address= xxl.job.accessToken=default_token xxl.job.executor.logpath=/data/xxl-job/log xxl.job.executor.logretentiondays=10
5、编写配置类
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; /** * xxl-job config * * @author xuxueli 2017-04-28 */ @Configuration public class XxlJobConfig { private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class); @Value("${xxl.job.admin.addresses}") private String adminAddresses; @Value("${xxl.job.executor.appname}") private String appname; @Value("${xxl.job.executor.port}") private int port; @Bean public XxlJobSpringExecutor xxlJobExecutor() { logger.info(">>>>>>>>>>> xxl-job config init."); XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor(); xxlJobSpringExecutor.setAdminAddresses(adminAddresses); xxlJobSpringExecutor.setAppname(appname); xxlJobSpringExecutor.setPort(port); return xxlJobSpringExecutor; } }
告诉spring调度中心是哪一个,执行器是哪一个,执行器端口是什么。
更多配置时如下:
@Configuration public class XxlJobConfig { private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class); @Value("${xxl.job.admin.addresses}") private String adminAddresses; @Value("${xxl.job.executor.appname}") private String appname; @Value("${xxl.job.executor.port}") private int port; @Value("${xxl.job.executor.address}") private String address; @Value("${xxl.job.executor.ip}") private String ip; @Value("${xxl.job.accessToken}") private String accessToken; @Value("${xxl.job.executor.logpath}") private String logPath; @Value("${xxl.job.executor.logretentiondays}") private int logRetentionDays; @Bean public XxlJobSpringExecutor xxlJobExecutor() { logger.info(">>>>>>>>>>> xxl-job config init."); XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor(); xxlJobSpringExecutor.setAdminAddresses(adminAddresses); xxlJobSpringExecutor.setAppname(appname); xxlJobSpringExecutor.setPort(port); xxlJobSpringExecutor.setAddress(address); xxlJobSpringExecutor.setIp(ip); xxlJobSpringExecutor.setAccessToken(accessToken); xxlJobSpringExecutor.setLogPath(logPath); xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays); return xxlJobSpringExecutor; } }
6、编写启动类
@SpringBootApplication public class XxlJobApplication { public static void main(String[] args) { SpringApplication.run(XxlJobApplication.class,args); } }
7、创建任务
import com.xxl.job.core.handler.annotation.XxlJob; import org.springframework.stereotype.Component; @Component public class HelloJob { @XxlJob("demoJobHandler") public void helloJob(){ System.out.println("简单任务执行了。。。。"); } }
8、测试单节点
(1)、启动项目
(2)、启动任务
目前任务是停止状态,点击操作,再选择启动,再点击确定,此时状态变为running
此时控制台打印如下:
简单任务执行了。。。。
简单任务执行了。。。。
简单任务执行了。。。。
简单任务执行了。。。。
简单任务执行了。。。。
简单任务执行了。。。。
简单任务执行了。。。。
简单任务执行了。。。。
简单任务执行了。。。。
简单任务执行了。。。。
简单任务执行了。。。。
简单任务执行了。。。。
查询日志:
三、任务详解
1、执行器
说明 | |
---|---|
AppName | 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用; |
名称 | 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性; |
排序 | 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表; |
注册方式 | 调度中心获取执行器地址的方式; |
机器地址 |
2、基础配置
基础配置
-
-
任务描述:任务的描述信息,便于任务管理;
-
负责人:任务的负责人;
-
调度配置
-
-
无:该类型不会主动触发调度;
-
CRON:该类型将会通过CRON,触发任务调度;
-
-
任务配置
-
运行模式:
-
JobHandler:运行模式为 "BEAN模式" 时生效,对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值;
-
执行参数:任务执行所需的参数;
注意:中间用英文逗号分隔。
此时执行,参数自定填写到“任务参数”
高级配置:主要争对集群模式。
阻塞处理策略
阻塞处理策略:调度过于密集(任务量特别大)执行器来不及处理时的处理策略;
-
单机串行(默认):调度请求进入单机执行器后,调度请求进入FIFO(First Input First Output)队列并以串行方式运行;
-
丢弃后续调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,本次请求将会被丢弃并标记为失败;
-
覆盖之前调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,将会终止运行中的调度任务并清空队列,然后运行本地调度任务;
路由策略
当执行器集群部署时,提供丰富的路由策略,包括;
-
FIRST(第一个):固定选择第一个机器;
-
LAST(最后一个):固定选择最后一个机器;
-
ROUND(轮询)
-
RANDOM(随机):随机选择在线的机器;
-
CONSISTENT_HASH(一致性HASH):每个任务按照Hash算法固定选择某一台机器,且所有任务均匀散列在不同机器上。
-
LEAST_FREQUENTLY_USED(最不经常使用):使用频率最低的机器优先被选举;
-
LEAST_RECENTLY_USED(最近最久未使用):最久未使用的机器优先被选举;
-
FAILOVER(故障转移):按照顺序依次进行心跳检测,第一个心跳检测成功的机器选定为目标执行器并发起调度;
-
BUSYOVER(忙碌转移):按照顺序依次进行空闲检测,第一个空闲检测成功的机器选定为目标执行器并发起调度;
-
SHARDING_BROADCAST(分片广播):广播触发对应集群中所有机器执行一次任务,同时系统自动传递分片参数;可根据分片参数开发分片任务;
3、
(1)、修改路由策略为轮询
(2)、启动多个服务
修改配置
server: port: ${port:8881} xxl: job: admin: addresses: http://127.0.0.1:8989/xxl-job-admin executor: appname: xxl-job-demo port: ${executor.port:9898}
修改任务代码
@Component public class HelloJob { @Value("${server.port}") private String port; @XxlJob("demoJobHandler") public void helloJob(){ System.out.println("简单任务执行了。。。。" + port); } }
启动
点击复制
启动这两个服务器,这两个服务连接同一个执行器,并执行同一个任务。
发现已经有两个节点注册成功了。下面启动任务,发现每个微服务轮询的去执行任务。
4、
分片逻辑
支付宝花呗每月10都会通知用户还款,用户量很大,有可能上亿,任务量特别的大,如果使用轮询的话,任务执行的效率肯定是不高的。那在同一个时间点执行大量的任务,通常情况下,我们肯定要做集群,我们给每一台服务器分配任务:实例1执行任务123,实例2执行任务456,实例3执行任务789。他们同时执行任务,这样就分摊了各个实例的压力,
那在xxl-job中是如何做的呢?通过取模的方式将任务分配到各个分片执行。
执行器集群部署时,任务路由策略选择”分片广播”情况下,一次任务调度将会广播触发对应集群中所有执行器执行一次任务。
路由策略(分片广播)-案例
需求:让两个节点同时执行10000个任务,每个节点分别执行5000个任务
(1)、创建分片执行器
(2)、创建任务,路由策略为分片广播
(3)、分片广播代码
由于执行器的appname变了,故要修改配置文件
server: port: ${port:8881} xxl: job: admin: addresses: http://127.0.0.1:8989/xxl-job-admin executor: appname: xxl-job-sharding-executor port: ${executor.port:9898}
分片参数
index:当前分片序号(从0开始),执行器集群列表中当前执行器的序号;
total:总分片数,执行器集群的总机器数量;
import com.xxl.job.core.context.XxlJobHelper; import com.xxl.job.core.handler.annotation.XxlJob; import org.springframework.beans.factory.annotation.Value; import org.springframework.stereotype.Component; import java.util.ArrayList; import java.util.List; @Component public class HelloJob { @Value("${server.port}") private String port; @XxlJob("demoJobHandler") public void helloJob(){ System.out.println("简单任务执行了。。。。" + port); } @XxlJob("shardingJobHandler") public void shardingJobHandler() { // 获取分片参数 int shardIndex = XxlJobHelper.getShardIndex(); // 当前分片序号,从0开始 int shardTotal = XxlJobHelper.getShardTotal(); // 总分片数 // 业务逻辑 List<Integer> list = getList(); for (Integer integer : list) { // 将任务的数值模总分片数 if (integer % shardTotal == shardIndex) { System.out.println("当前第"+shardIndex+"分片执行了,任务项为:"+integer); } } } public List<Integer> getList(){ List<Integer> list = new ArrayList<>(); for (int i = 0; i < 10000; i++) { list.add(i); } return list; } }
(4)、测试
启动多个服务测试,一次执行可以执行多个任务
此时执行器注册成功,如下所示:
我们启动任务,只执行一次
XxlJobApplication-1服务的控制台打印如下:
..... 当前第0分片执行了,任务项为:9978 当前第0分片执行了,任务项为:9980 当前第0分片执行了,任务项为:9982 当前第0分片执行了,任务项为:9984 当前第0分片执行了,任务项为:9986 当前第0分片执行了,任务项为:9988 当前第0分片执行了,任务项为:9990 当前第0分片执行了,任务项为:9992 当前第0分片执行了,任务项为:9994 当前第0分片执行了,任务项为:9996 当前第0分片执行了,任务项为:9998
XxlJobApplication-2服务的控制台打印如下:
....... 当前第1分片执行了,任务项为:9979 当前第1分片执行了,任务项为:9981 当前第1分片执行了,任务项为:9983 当前第1分片执行了,任务项为:9985 当前第1分片执行了,任务项为:9987 当前第1分片执行了,任务项为:9989 当前第1分片执行了,任务项为:9991 当前第1分片执行了,任务项为:9993 当前第1分片执行了,任务项为:9995 当前第1分片执行了,任务项为:9997 当前第1分片执行了,任务项为:9999
现在只执行了一次任务,每个服务执行了5000次任务,如果任务量特别大的时候,我们可以通过分片广播去缓解各个服务的压力,