分布式定时任务-XXL-JOB-教程+实战

阿里云国内75折回扣微信号：monov8

阿里云国际，腾讯云国际，低至75折。AWS 93折免费开户实名账号代冲值优惠多多微信号：monov8 飞机：@monov6

一.定时任务概述

1.定时任务认识

1.1.什么是定时任务

定时任务是按照指定时间周期运行任务。使用场景为在某个固定时间点执行或者周期性的去执行某个任务比如每天晚上24点做数据汇总定时发送短信等。

1.2.常见定时任务方案

While + Sleep : 通过循环加休眠的方式定时执行
Timer和TimerTask JDK自带的定时任务可以实现简单的间隔执行任务在指定时间点执行某一任务也能定时的周期性执行无法实现按日历去调度执行任务。
ScheduledExecutorService : Java并发包下JDK1.5出现是比较理想的定时任务实现方案。Eureka就使用的是它。
QuartZ : 使用Quartz它是一个异步任务调度框架功能丰富可以实现按日历调度支持持久化。
Spring TaskSpring 3.0后提供Spring Task实现任务调度支持按日历调度相比Quartz功能稍简单但是在开发基本够用支持注解编程方式。
SpringBoot中的Schedule 通过@EnableScheduling+@Scheduled最实现定时任务底层使用的是Spring Task

2.分布式定时任务

2.1.遇到什么问题

上述的定时任务都是集中式(单体项目使用)的定时任务在分布式中将会面临一些问题或不足

业务量大单机性能瓶颈需要扩展
多台机器部署如何保证定时任务不重复执行
定时任务时间需要可调整可以暂停
机器发生故障down机定时任务依然可用如何实现故障转移
定时任务执行日志是否可监控

2.2.分布式定时任务xxl-job

XXL-JOB是一个分布式任务调度平台于2015问世其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线开箱即用。其具备且不止如下能力

简单支持通过Web页面对任务进行CRUD操作操作简单一分钟上手
动态支持动态修改任务状态、启动/停止任务以及终止运行中任务即时生效
调度中心HA中心式调度采用中心式设计“调度中心”基于集群Quartz实现并支持集群部署可保证调度中心HA执行器HA分布式任务分布式执行任务"执行器"支持集群部署可保证任务执行HA
弹性扩容缩容一旦有新执行器机器上线或者下线下次调度时将会重新分配任务
路由策略执行器集群部署时提供丰富的路由策略包括第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等
故障转移任务路由策略选择"故障转移"情况下如果执行器集群中某一台机器故障将会自动Failover切换到一台正常的执行器发送调度请求。
任务失败告警默认提供邮件方式失败告警同时预留扩展接口可方面的扩展短信、钉钉等告警方式

具体见https://github.com/xuxueli/xxl-job/tree/v2.0.0

二.XXL-JOB初体验

1.xxl-job架构设计

1.1.设计思想

将调度行为抽象形成“调度中心”公共平台而平台自身并不承担业务逻辑“调度中心”负责发起调度请求。

将任务抽象成分散的JobHandler交由“执行器”统一管理“执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑。因此“调度”和“任务”两部分可以相互解耦提高系统整体稳定性和扩展性

1.2.架构设计图

xxl-job分为调度中心和执行器两大模块

调度模块调度中心

负责管理调度信息按照调度配置发出调度请求自身不承担业务代码。调度系统与任务解耦提高了系统可用性和稳定性同时调度系统性能不再受限于任务模块

支持可视化、简单且动态的管理调度信息包括任务新建更新删除GLUE开发和任务报警等所有上述操作都会实时生效同时支持监控调度结果以及执行日志支持执行器Failover(故障转移)。

执行模块执行器

负责接收调度请求并执行任务逻辑。任务模块专注于任务的执行等操作开发和维护更加简单和高效

接收“调度中心”的执行请求、终止请求和日志请求等。

图片

调度中心高可用

基于数据库的集群方案数据库选用Mysql集群分布式并发环境中进行定时任务调度时会在各个节点会上报任务存到数据库中执行时会从数据库中取出触发器来执行如果触发器的名称和执行时间相同则只有一个节点去执行此任务。

并行调度

调度采用线程池方式实现避免单线程因阻塞而引起任务调度延迟。XXL-JOB调度模块默认采用并行机制在多线程调度的情况下调度模块被阻塞的几率很低大大提高了调度系统的承载量。

XXL-JOB的不同任务之间并行调度、并行执行。XXL-JOB的单个任务针对多个执行器是并行运行的针对单个执行器是串行执行的。同时支持任务终止。

执行器(任务)高可用

执行器如若集群部署调度中心将会感知到在线的所有执行器如“127.0.0.1:9997, 127.0.0.1:9998, 127.0.0.1:9999”。多个执行器可以选择“路由策略”来采用轮询随机等方式进行多机器调度。

当任务”路由策略”选择”故障转移(FAILOVER)”时当调度中心每次发起调度请求时会按照顺序对执行器发出心跳检测请求第一个检测为存活状态的执行器将会被选定并发送调度请求。调度成功后可在日志监控界面查看“调度备注”。

2.xxl-job安装

2.1.下载源码

请下载项目源码并解压使用IDEA工具导入项目

源码仓库地址

https://github.com/xuxueli/xxl-job
http://gitee.com/xuxueli0323/xxl-job

项目代码结构如下

图片

doc 文档即SQL脚本所在目录
db : “调度数据库”建表脚本
xxl-job-admin : 调度中心项目源码
xxl-job-core : 核心模块,公共Jar依赖
xxl-job-executor-samples : 执行器Sample示例项目大家可以在该项目上进行开发也可以将现有项目改造生成执行器项目

2.2.导入数据库

打开项目代码获取 “调度数据库初始化SQL脚本” 并执行即可。“调度数据库初始化SQL脚本” 位置为: /xxl-job/doc/db/tables_xxl_job.sql 数据库名xxl_job

图片

数据库如下

图片

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系统用户表

2.3.启动调度中心

打开 xxl-job-admin 的配置文件/xxl-job/xxl-job-admin/src/main/resources/application.properties 对调度中心进行配置重要配置如下

server.port : 根据情况修改端口
spring.datasource.url 指向刚才准备的数据库
spring.datasource.password : 记得修改成自己的数据库密码
spring.mail.username 配置自己的邮件账号
spring.mail.password 邮件的授权码我下面是以qq邮箱为例

下面根据自己的情况进行修改不要直接复制

### 调度中心JDBC链接链接地址请保持和 上述章节 所创建的调度数据库的地址一致
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
spring.mail.password=邮箱授权码不是登录密码
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

然后启动调度中心执行 XxlJobAdminApplication#main 方法启动之后浏览器访问 http://localhost:8080/xxl-job-admin/toLogin注意URL中有个上下文路径。

默认登录账号 “admin/123456”, 登录后运行界面如下图所示。

图片

2.3.配置部署“执行器项目

“执行器”项目xxl-job-executor-sample-springboot (提供多种版本执行器供选择现以 springboot 版本为例可直接使用也可以参考其并将现有项目改造成执行器)

作用负责接收“调度中心”的调度并执行可直接部署执行器也可以将执行器集成到现有业务项目中。

修改配置/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties

xxl.job.admin.addresses : 调度中心的地址如果调度中心修改过端口这里也要对应修改

### 调度中心部署跟地址 [选填]如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"为空则关闭自动注册
xxl.job.admin.addresses=http://127.0.0.1:18080/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

上面配置是为了在Spring容器中创建一个XxlJobSpringExecutor 执行器Bean见com.xxl.job.executor.core.config.XxlJobConfig#xxlJobExecutor

@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
    logger.info(">>>>>>>>>>> xxl-job config init.");
    XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
    xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
    xxlJobSpringExecutor.setAppname(appname);
    xxlJobSpringExecutor.setAddress(address);
    xxlJobSpringExecutor.setIp(ip);
    xxlJobSpringExecutor.setPort(port);
    xxlJobSpringExecutor.setAccessToken(accessToken);
    xxlJobSpringExecutor.setLogPath(logPath);
    xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);

    return xxlJobSpringExecutor;
}

在com.xxl.job.executor.service.jobhandler.SampleXxlJob中提供了简单的定时任务实例

为方便用户参考与快速实用示例执行器内原生提供多个Bean模式任务Handler可以直接配置实用如下

demoJobHandler简单示例任务任务内部模拟耗时任务逻辑用户可在线体验Rolling Log等功能
shardingJobHandler分片示例任务任务内部模拟处理分片参数可参考熟悉分片任务
httpJobHandler通用HTTP任务Handler业务方只需要提供HTTP链接等信息即可不限制语言、平台。示例任务入参如下

/**
 * XxlJob开发示例Bean模式
 *
 * 开发步骤
 * 1、在Spring Bean实例中开发Job方法方式格式要求为 "public ReturnT<String> execute(String param)"
 * 2、为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")"注解value值对应的是调度中心新建任务的JobHandler属性的值。
 * 3、执行日志需要通过 "XxlJobLogger.log" 打印执行日志
 *
 * @author xuxueli 2019-12-11 21:52:51
 */
@Component
public class SampleXxlJob {
    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
 /**
     * 1、简单任务示例Bean模式
     */
    @XxlJob("demoJobHandler")
    public ReturnT<String> demoJobHandler(String param) throws Exception {
        logger.info("XXL-JOB, Hello World. param={}",param);
        return ReturnT.SUCCESS;
    }
    //...省略...
}

【重要】 如果我们要写自己的定时任务参照上面方法在方法上注解一个@XxlJob("任务名字") ,方法可以接受一个字符串参数方法需要返回ReturnT格式。

最后启动执行器项目。

3.配置定时任务

3.1.执行器创建

打开调度中心可视化界面在执行器管理界面添加新增执行器

图片

appName : 执行器的名字可以任意填写
名称任意填写
注册方式调度中心是通过RPC的方式对执行器发起调度所以这里需要的是执行器项目的ip:port 注意该端口不是执行器项目的server.port 而是xxl.job.executor.port 端口。你可以选择自动注册也可以手动录入。

3.2.创建任务

在任务管理界面新增任务

图片

路由策略有轮询随机故障转移等等策略是用在集群模式下的调度方式。
cron : 定时任务的执行时间规则时间表达式
JobHandler : 这个是要对应 “执行器项目”中 @XxlJob("demoJobHandler") 注解中的名字
运行模式 Bean 使用内置代码方式也可以执行在线执行代码方式
报警邮件如果定时任务失败会发送报警邮件到邮箱
任务参数这个参数可以传递给 @XxlJob("demoJobHandler")所在方法的参数。

创建好任务之后就可以执行了

图片

调度日志

图片

IDEA工具控制台效果

15:47:33.017 logback [Thread-16] INFO  c.x.j.e.s.jobhandler.SampleXxlJob - XXL-JOB, Hello World. param=1024
15:47:34.007 logback [Thread-16] INFO  c.x.j.e.s.jobhandler.SampleXxlJob - XXL-JOB, Hello World. param=1024
15:47:35.008 logback [Thread-16] INFO  c.x.j.e.s.jobhandler.SampleXxlJob - XXL-JOB, Hello World. param=1024
...省略...

4.GLUE模式(Java)

4.1.添加任务

该模式支持在线编辑定时任务的内容立刻执行无需再开发工具中编辑代码也无需重启项目。

请点击任务右侧 “GLUE” 按钮进入 “GLUE编辑器开发界面” 见下图。“GLUE模式(Java)” 运行模式的任务默认已经初始化了示例任务代码即打印Hello World。

图片

任务以源码方式维护在调度中心支持通过Web IDE在线更新实时编译和生效因此不需要指定JobHandler

4.2.编写代码

保存之后可以在操作按钮里面去编写任务

图片

(“GLUE模式(Java)” 运行模式的任务实际上是一段继承自IJobHandler的Java类代码它在执行器项目中运行可使用@Resource/@Autowire注入执行器里中的其他服务比如我的定时任务如下编辑好之后点击保存

图片

保存好之后启动定时任务效果如下

图片

三.XXL-JOB集群部署

1.调度中心集群

1.1.问题概述

调度中心支持集群部署提升调度系统容灾和可用性。调度中心集群部署时几点要求和建议

DB配置保持一致
集群机器时钟保持一致单机集群忽视
当启动多个调度器时执行器配置调度中心部署跟地址可以用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"为空则关闭自动注册

但是建议推荐通过nginx为调度中心集群做负载均衡分配域名。调度中心访问、执行器回调配置、调用API服务等操作均通过该域名进行。

1.2.启动多个调度中心

修改调度中心端口启动多个调度中心我这里启动两个如

http://localhost:18080/xxl-job-admin/
http://localhost:18081/xxl-job-admin/

1.3.配置Nginx负载均衡

当启动多个调度器时执行器配置调度中心部署跟地址可以用逗号分隔。执行器将会使用该地址进行“执行器心跳注册”和“任务结果回调”为空则关闭自动注册

但是建议推荐通过nginx为调度中心集群做负载均衡分配域名。调度中心访问、执行器回调配置、调用API服务等操作均通过该域名进行。

我们启动了2个调度中心那么我的执行器项目该注册到哪个调度中心呢我们通过Nginx来解决这个问题原理如下图

图片

我们再hosts配置www.jobs.com作为nginx的主机域名然后反向代理到多个调度中心这样一来执行器就只需要注册到www.jobs.com Nginx即可。

修改 C:\Windows\System32\drivers\etc\hosts增加配置如下

127.0.0.1 www.jobs.com

Nginx配置如下

#调度中心
upstream jobs{
 server localhost:18080;
 server localhost:18081;
}

server {
      listen       80;
      #使用域名
      server_name  www.jobs.com;

      #charset koi8-r;

      #access_log  logs/host.access.log  main;

      location / {
       #调度中心反向代理配置
          proxy_pass   http://jobs/;
      }

      #error_page  404              /404.html;

      # redirect server error pages to the static page /50x.html
      #
      error_page   500 502 503 504  /50x.html;
      location = /50x.html {
          root   html;
      }

      
}

启动Nginx,通过浏览器访问 http://www.jobs.com/xxl-job-admin/ 可以访问到调度中心的管理界面

2.执行器项目集群

执行器支持集群部署提升调度系统可用性同时提升任务处理能力。

执行器集群部署时几点要求和建议

- 执行器回调地址xxl.job.admin.addresses需要保持一致执行器根据该配置进行执行器自动注册等操作。
- 同一个执行器集群内AppNamexxl.job.executor.appname需要保持一致调度中心根据该配置动态发现不同集群的在线执行器列表。

2.1.启动多个执行器项目

现在对执行器项目做集群修改xxl-job-executor-sample-springboot配置文件application.properties

server.port : 既然是做集群项目端口需要修改
xxl.job.admin.addresses : 调度中心地址需要修改成www.jobs.com 多个执行器配置同一个地址。
xxl.job.executor.port : RPC通信端口也要修改多个执行器该端口需要不一样

第一个实例配置

server.port=19090
xxl.job.admin.addresses=http://www.jobs.com/xxl-job-admin #对应Nginx地址
xxl.job.executor.port=9999

第二个实例配置

server.port=19091
xxl.job.admin.addresses=http://www.jobs.com/xxl-job-admin
xxl.job.executor.port=9998

在 Configurations中配置允许启动多个实例

图片

启动实例如下

图片

2.2.配置定时任务

通过http://www.jobs.com/xxl-job-admin 访问调度中心管理界面在执行器管理中可以看到多台执行器实例

图片

在任务管理中可以编辑任务然后选择路由策略比如选择轮询然后启动任务就会看到两个执行器项目轮着执行定时任务。

图片

说在最后

xxl-job确实很强大功能也很全,经过该文章学习相信你可以把xxl-job给用起来了但是如果你的项目是一个小体量的单体我不太建议使用它Quzrtz或者SpringBoot Task就足够对于xxl-job个人还是有些笨重。

阿里云国内75折回扣微信号：monov8

阿里云国际，腾讯云国际，低至75折。AWS 93折免费开户实名账号代冲值优惠多多微信号：monov8 飞机：@monov6

返回列表

上一篇：SpringMVC

下一篇：R22-11 《Specification of Time Synchronization》文摘

“分布式定时任务-XXL-JOB-教程+实战” 的相关文章

Compose 下拉刷新库——ComposeRefreshLayout1年前 (2023-02-02)

KAFKA EAGLE 监控MRS kafka之操作实践1年前 (2023-02-02)

华为云Astro的前世今生：用7年时间革新低代码开发观念1年前 (2023-02-02)

学习笔记——SpringMVC拦截器的两种装配方式；SpringMVC拦截器工作原理；SpringMVC中的异常处理器；SpringMVC工作原理1年前 (2023-02-02)

单片机、嵌入式的大神都平时浏览什么网站？1年前 (2023-02-02)

同态加密详解1年前 (2023-02-02)

VScode中配置 C/C++ 环境,超级详细，问题分析全面，绝对好用_vscode配置c/c++环境1年前 (2023-02-02)

美语发音【总结】1年前 (2023-02-02)

《MySQL高级篇》十、数据库其他调优策略1年前 (2023-02-02)