分布式任务调度平台——XXL-JOB

ゝ一世哀愁。 2023-10-13 19:28 122阅读 0赞

目录

  • 1.概述
    • 1.1.什么是任务调度？
    • 1.2.为什么需要分布式调度
    • 1.3 XXL-JOB 介绍
      • 1.3.1.概述
      • 1.3.2.✨系统架构图
      • 1.3.3.✨设计思想
      • 1.3.4.✨执行流程
  • 2.快速入门
    • 2.1.下载源码
    • 2.2.初始化调度数据库
    • 2.3.编译源码
    • 2.4.配置部署调度中心
      • 2.4.1.调度中心配置
      • 2.4.2.部署项目
    • 2.5.配置部署执行器项目
      • 2.5.1.添加 Maven 依赖
      • 2.5.2.执行器配置
      • 2.5.3.添加执行器配置
      • 2.5.4.添加任务处理类
    • 2.6.运行 HelloWorld 程序
      • 2.6.1.任务配置 & 触发执行
      • 2.5.2 查看日志
    • 2.7.GLUE 模式 (Java)
    • 2.8.执行器集群
      • 2.8.1.集群环境搭建
      • 2.8.2.✨调度路由算法讲解
  • 3.分片功能讲解
    • 3.1.案例需求讲解
      • 3.1.1.初始化数据
      • 3.1.2 集成 Druid & MyBatis
      • 3.1.3.业务功能实现
    • 3.2.分片概念讲解
    • 3.3 案例改造成任务分片

本章笔记整理自1小时掌握XXL-JOB分布式调度实战。

1.概述

1.1.什么是任务调度？

（1）我们可以思考一下下面业务场景的解决方案：

  • 某电商平台需要每天上午 10 点，下午 3 点，晚上 8 点发放一批优惠券；
  • 某银行系统需要在信用卡到期还款日的前三天进行短信提醒；
  • 某财务系统需要在每天凌晨 0:10 分结算前一天的财务数据，统计汇总；

（2）以上场景就是任务调度所需要解决的问题。任务调度是为了自动完成特定任务，在约定的特定时刻去执行任务的过程。

1.2.为什么需要分布式调度

（1）使用 Spring 中提供的注解 @Scheduled，也能实现调度的功能，在业务类中方法中使用这个注解，然后在启动类上使用 @EnableScheduling注解：

  1. @Scheduled(cron = "0/20 * * * * ? ")
  2. public void doWork(){
  4.     //doSomething   
  5. }

有关 Spring Boot 中如何实现定时任务的相关知识可以查看 Spring Boot 面试题——定时任务这篇文章。

（2）感觉 Spring 给我们提供的这个注解可以完成任务调度的功能，好像已经完美解决问题了，为什么还需要分布式呢？主要原因如下：

  • 高可用：单机版的定式任务调度只能在一台机器上运行，如果程序或者系统出现异常就会导致功能不可用。
  • 防止重复执行：在单机模式下，定时任务是没什么问题的。但当我们部署了多台服务，同时又每台服务又有定时任务时，若不进行合理的控制在同一时间，只有一个定时任务启动执行，这时，定时执行的结果就可能存在混乱和错误了
  • 单机处理极限：原本 1 分钟内需要处理 1 万个订单，但是现在需要 1 分钟内处理 10 万个订单；原来一个统计需要 1 小时，现在业务方需要 10 分钟就统计出来。你也许会说，你也可以多线程、单机多进程处理。的确，多线程并行处理可以提高单位时间的处理效率，但是单机能力毕竟有限（主要是 CPU、内存和磁盘），始终会有单机处理不过来的情况。

1.3 XXL-JOB 介绍

1.3.1.概述

（1）XXL-Job 是一个轻量级分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。大众点评目前已接入 XXL-JOB，该系统在内部已调度约 100 万次，表现优异。目前已有多家公司接入 XXL-Job ，包括比较知名的大众点评，京东，优信二手车，360金融 (360)，联想集团，网易等等。

（2）官网地址：https://www.xuxueli.com/xxl-job/

1.3.2.✨系统架构图

XXL-JOB 的系统架构图如下图所示，其主要由以下两部分组成：

  • 调度模块（调度中心）：负责管理调度信息，按照调度配置发出调度请求，自身不承担业务代码。调度系统与任务解耦，提高了系统可用性和稳定性，同时调度系统性能不再受限于任务模块；支持可视化、简单且动态的管理调度信息，包括任务新建，更新，删除，GLUE 开发和任务报警等，所有上述操作都会实时生效，同时支持监控调度结果以及执行日志，支持执行器 Failover。
  • 执行模块（执行器）：负责接收调度请求并执行任务逻辑。任务模块专注于任务的执行等操作，开发和维护更加简单和高效；接收“调度中心”的执行请求、终止请求和日志请求等。

在这里插入图片描述

1.3.3.✨设计思想

XXL-JOB 的设计思想为：

  • 将调度行为抽象形成“调度中心”公共平台，而平台自身并不承担业务逻辑，“调度中心”负责发起调度请求；
  • 将任务抽象成分散的 JobHandler，交由“执行器”统一管理，“执行器”负责接收调度请求并执行对应的 JobHandler 中业务逻辑；
  • 因此，“调度”和“任务”两部分可以相互解耦，提高系统整体稳定性和扩展性；

1.3.4.✨执行流程

XXL-Job 的工作流程如下：

  • 启动调度中心：调度中心是整个 XXL-Job 的核心，负责任务的调度和管理。在启动时，调度中心会加载任务信息并持续运行。
  • 注册执行器：执行器是任务的具体执行者，运行在各个执行节点上。执行器在启动时会根据配置的调度中心地址向调度中心进行注册，并发送心跳以保持与调度中心的连接。
  • 任务调度：调度中心根据任务的配置和调度策略，决定任务的触发时间和执行节点。调度策略可以基于固定时间点触发、固定间隔触发或者基于 Cron 表达式触发。
  • 任务下发：当到达任务的触发时间时，调度中心会将任务下发给执行器。下发的任务包含任务的元数据、执行参数等信息。
  • 任务执行：执行器接收到任务后，根据任务的配置和参数，在执行器内部执行具体的任务逻辑。执行过程中，执行器会记录任务的执行日志。
  • 任务结果回调：任务执行完成后，执行器会将任务的执行结果回调给调度中心。执行结果包括任务的执行状态、执行日志、执行耗时等信息。
  • 调度日志和统计：调度中心接收到执行器的回调结果后，会更新任务的状态和执行日志，并进行相关的统计和监控。
  • 报警和告警：在任务执行过程中，调度中心会根据任务的配置和执行结果，触发相应的报警和告警机制，通知管理员和相关人员。
  • 重复执行：整个流程会循环进行，以实现任务的周期性调度和执行。调度中心会根据预设的调度策略和触发条件，按时触发任务的下发和执行。

2.快速入门

2.1.下载源码

源码下载地址：

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

2.2.初始化调度数据库

请下载项目源码并解压，获取 “调度数据库初始化SQL脚本” 并执行即可。“调度数据库初始化SQL脚本” 位置为：

  1. /xxl-job/doc/db/tables_xxl_job.sql

2.3.编译源码

解压源码，按照 Maven 格式将源码导入 IDE，使用 Maven 进行编译即可，源码结构如下：

在这里插入图片描述

2.4.配置部署调度中心

2.4.1.调度中心配置

修改xxl-job-admin项目的配置文件application.properties，把数据库账号密码配置上：

  1. ### web
  2. server.port=8080
  3. server.servlet.context-path=/xxl-job-admin
  5. ### actuator
  6. management.server.servlet.context-path=/actuator
  7. management.health.mail.enabled=false
  9. ### resources
  10. spring.mvc.servlet.load-on-startup=0
  11. spring.mvc.static-path-pattern=/static/**
  12. spring.resources.static-locations=classpath:/static/
  14. ### freemarker
  15. spring.freemarker.templateLoaderPath=classpath:/templates/
  16. spring.freemarker.suffix=.ftl
  17. spring.freemarker.charset=UTF-8
  18. spring.freemarker.request-context-attribute=request
  19. spring.freemarker.settings.number_format=0.##########
  21. ### mybatis
  22. mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
  23. #mybatis.type-aliases-package=com.xxl.job.admin.core.model
  25. ### xxl-job, datasource
  26. spring.datasource.url=jdbc:mysql://192.168.202.200:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
  27. spring.datasource.username=root
  28. spring.datasource.password=WolfCode_2017
  29. spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
  31. ### datasource-pool
  32. spring.datasource.type=com.zaxxer.hikari.HikariDataSource
  33. spring.datasource.hikari.minimum-idle=10
  34. spring.datasource.hikari.maximum-pool-size=30
  35. spring.datasource.hikari.auto-commit=true
  36. spring.datasource.hikari.idle-timeout=30000
  37. spring.datasource.hikari.pool-name=HikariCP
  38. spring.datasource.hikari.max-lifetime=900000
  39. spring.datasource.hikari.connection-timeout=10000
  40. spring.datasource.hikari.connection-test-query=SELECT 1
  41. spring.datasource.hikari.validation-timeout=1000
  43. ### xxl-job, email
  44. spring.mail.host=smtp.qq.com
  45. spring.mail.port=25
  46. spring.mail.username=xxx@qq.com
  47. spring.mail.from=xxx@qq.com
  48. spring.mail.password=xxx
  49. spring.mail.properties.mail.smtp.auth=true
  50. spring.mail.properties.mail.smtp.starttls.enable=true
  51. spring.mail.properties.mail.smtp.starttls.required=true
  52. spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
  54. ### xxl-job, access token
  55. xxl.job.accessToken=default_token
  57. ### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
  58. xxl.job.i18n=zh_CN
  60. ## xxl-job, triggerpool max size
  61. xxl.job.triggerpool.fast.max=200
  62. xxl.job.triggerpool.slow.max=100
  64. ### xxl-job, log retention days
  65. xxl.job.logretentiondays=30

2.4.2.部署项目

  • 运行XxlJobAdminApplication程序即可。
  • 调度中心访问地址：http://localhost:8080/xxl-job-admin
  • 默认登录账号 “admin/123456”，登录后运行界面如下图所示：
    在这里插入图片描述
  • 至此“调度中心”项目已经部署成功。

2.5.配置部署执行器项目

2.5.1.添加 Maven 依赖

创建 SpringBoot 项目并且添加如下依赖：

  1. <dependency>
  2.     <groupId>com.xuxueli</groupId>
  3.     <artifactId>xxl-job-core</artifactId>
  4.     <version>2.3.1</version>
  5. </dependency>

2.5.2.执行器配置

在配置文件中添加如下配置：

  1. ### 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
  2. xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
  3. ### 执行器通讯TOKEN [选填]：非空时启用；
  4. xxl.job.accessToken=default_token
  5. ### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
  6. xxl.job.executor.appname=xxl-job-executor-sample
  7. ### 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
  8. xxl.job.executor.address=
  9. ### 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
  10. xxl.job.executor.ip=127.0.0.1
  11. ### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
  12. xxl.job.executor.port=9999
  13. ### 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
  14. xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
  15. ### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
  16. xxl.job.executor.logretentiondays=30

2.5.3.添加执行器配置

创建 XxlJobConfig 配置对象：

  1. @Configuration
  2. public class XxlJobConfig {
  4.     @Value("${xxl.job.admin.addresses}")
  5.     private String adminAddresses;
  6.     @Value("${xxl.job.accessToken}")
  7.     private String accessToken;
  8.     @Value("${xxl.job.executor.appname}")
  9.     private String appname;
  10.     @Value("${xxl.job.executor.address}")
  11.     private String address;
  12.     @Value("${xxl.job.executor.ip}")
  13.     private String ip;
  14.     @Value("${xxl.job.executor.port}")
  15.     private int port;
  16.     @Value("${xxl.job.executor.logpath}")
  17.     private String logPath;
  18.     @Value("${xxl.job.executor.logretentiondays}")
  19.     private int logRetentionDays;
  21.     @Bean
  22.     public XxlJobSpringExecutor xxlJobExecutor() {
  24.         XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
  25.         xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
  26.         xxlJobSpringExecutor.setAppname(appname);
  27.         xxlJobSpringExecutor.setAddress(address);
  28.         xxlJobSpringExecutor.setIp(ip);
  29.         xxlJobSpringExecutor.setPort(port);
  30.         xxlJobSpringExecutor.setAccessToken(accessToken);
  31.         xxlJobSpringExecutor.setLogPath(logPath);
  32.         xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
  33.         return xxlJobSpringExecutor;
  34.     }
  35. }

2.5.4.添加任务处理类

添加任务处理类，交给 Spring 容器管理，在处理方法上使用 @XxlJob 注解：

  1. @Component
  2. public class SimpleXxlJob {
  4.     @XxlJob("demoJobHandler")
  5.     public void demoJobHandler() throws Exception {
  7.         System.out.println("执行定时任务,执行时间:"+new Date());
  8.     }
  9. }

2.6.运行 HelloWorld 程序

2.6.1.任务配置 & 触发执行

登录调度中心，在任务管理中新增任务，配置内容如下：

\*\*\[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-KlUBtIsk-1689651567811)(image\\image-20221101100952650.png)\]\*\*

新增后界面如下：

在这里插入图片描述
接着启动定时调度任务：

在这里插入图片描述

2.5.2 查看日志

在调度中心的调度日志中就可以看到，任务的执行结果：

在这里插入图片描述

管控台也可以看到任务的执行信息：

在这里插入图片描述

2.7.GLUE 模式 (Java)

任务以源码方式维护在调度中心，支持通过 Web IDE 在线更新，实时编译和生效，因此不需要指定 JobHandler。“GLUE模式 (Java)” 运行模式的任务实际上是一段继承自 IJobHandler 的 Java 类代码，它在执行器项目中运行，可使用 @Resource/@Autowire 注入执行器里中的其他服务。

添加Service

  1. @Service
  2. public class HelloService {
  4.     public void methodA(){
  6.         System.out.println("执行MethodA的方法");
  7.     }
  8.     public void methodB(){
  10.         System.out.println("执行MethodB的方法");
  11.     }
  12. }

添加任务配置

在这里插入图片描述

通过GLUE IDE在线编辑代码

在这里插入图片描述

编写内容如下:

  1. package com.xxl.job.service.handler;
  3. import cn.wolfcode.xxljobdemo.service.HelloService;
  4. import com.xxl.job.core.handler.IJobHandler;
  5. import org.springframework.beans.factory.annotation.Autowired;
  7. public class DemoGlueJobHandler extends IJobHandler {
  9.     @Autowired
  10.     private HelloService helloService;
  11.     @Override
  12.     public void execute() throws Exception {
  14.         helloService.methodA();
  15.     }
  16. }

启动并执行程序

2.8.执行器集群

2.8.1.集群环境搭建

在 IDEA 中设置 SpringBoot 项目运行开启多个集群：

在这里插入图片描述

启动两个SpringBoot程序,需要修改Tomcat端口和执行器端口

  • Tomcat端口8090程序的命令行参数如下：

    -Dserver.port=8090 -Dxxl.job.executor.port=9998

  • Tomcat 端口 8090 程序的命令行参数如下：

    -Dserver.port=8091 -Dxxl.job.executor.port=9999

  • 在任务管理中，修改路由策略，修改成 轮询：

在这里插入图片描述

  • 重新启动，我们可以看到效果是，定时任务会在这两台机器中进行轮询的执行，8090 端口的控制台日志如下：

在这里插入图片描述

  • 8091端口的控制台日志如下：

在这里插入图片描述

2.8.2.✨调度路由算法讲解

当执行器集群部署时，提供丰富的路由策略，包括：

  • FIRST (第一个)：固定选择第一个机器
  • LAST (最后一个)：固定选择最后一个机器；
  • ROUND (轮询)：依次的选择在线的机器发起调度；
  • RANDOM (随机)：随机选择在线的机器；
  • CONSISTENT_HASH (一致性 HASH)：每个任务按照 Hash 算法固定选择某一台机器，且所有任务均匀散列在不同机器上；
  • LEAST_FREQUENTLY_USED (最不经常使用)：使用频率最低的机器优先被选举；
  • LEAST_RECENTLY_USED (最近最久未使用)：最久未使用的机器优先被选举；
  • FAILOVER (故障转移)：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
  • BUSYOVER (忙碌转移)：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
  • SHARDING_BROADCAST (分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数，可根据分片参数开发分片任务。分片参数包括以下两个：分片序号 shardIndex 和分片总数：shardTotal，每个执行器从数据表取任务时可以让任务 id 模上分片总数，如果等于分片序号则执行此任务；

3.分片功能讲解

3.1.案例需求讲解

需求：我们现在实现这样的需求，在指定节假日，需要给平台的所有用户去发送祝福的短信。

3.1.1.初始化数据

在数据库中导入 xxl_job_demo.sql 数据。

3.1.2 集成 Druid & MyBatis

添加依赖

  1. <!--MyBatis驱动-->
  2. <dependency>
  3.     <groupId>org.mybatis.spring.boot</groupId>
  4.     <artifactId>mybatis-spring-boot-starter</artifactId>
  5.     <version>1.2.0</version>
  6. </dependency>
  7. <!--mysql驱动-->
  8. <dependency>
  9.     <groupId>mysql</groupId>
  10.     <artifactId>mysql-connector-java</artifactId>
  11. </dependency>
  12. <!--lombok依赖-->
  13. <dependency>
  14.     <groupId>org.projectlombok</groupId>
  15.     <artifactId>lombok</artifactId>
  16.     <scope>provided</scope>
  17. </dependency>
  18. <dependency>
  19.     <groupId>com.alibaba</groupId>
  20.     <artifactId>druid</artifactId>
  21.     <version>1.1.10</version>
  22. </dependency>

添加配置

  1. spring.datasource.url=jdbc:mysql://localhost:3306/xxl_job_demo?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=UTF-8
  2. spring.datasource.driverClassName=com.mysql.jdbc.Driver
  3. spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
  4. spring.datasource.username=root
  5. spring.datasource.password=WolfCode_2017

添加实体类

  1. @Setter@Getter
  2. public class UserMobilePlan {
  4.     private Long id;//主键
  5.     private String username;//用户名
  6.     private String nickname;//昵称
  7.     private String phone;//手机号码
  8.     private String info;//备注
  9. }

添加 Mapper 处理类

  1. @Mapper
  2. public interface UserMobilePlanMapper {
  4.     @Select("select * from t_user_mobile_plan")
  5.     List<UserMobilePlan> selectAll();
  6. }

3.1.3.业务功能实现

任务处理方法实现

  1. @XxlJob("sendMsgHandler")
  2. public void sendMsgHandler() throws Exception{
  4.     List<UserMobilePlan> userMobilePlans = userMobilePlanMapper.selectAll();
  5.     System.out.println("任务开始时间: " + new Date() + ",处理任务数量: " + userMobilePlans.size());
  6.     Long startTime = System.currentTimeMillis();
  7.     userMobilePlans.forEach(item->{
  9.         try {
  11.             //模拟发送短信动作
  12.             TimeUnit.MILLISECONDS.sleep(10);
  13.         } catch (InterruptedException e) {
  15.             e.printStackTrace();
  16.         }
  17.     });
  18.     System.out.println("任务结束时间: " + new Date());
  19.     System.out.println("任务耗时: " + (System.currentTimeMillis()-startTime) + " 毫秒");
  20. }

任务配置信息

在这里插入图片描述

3.2.分片概念讲解

比如我们的案例中有 2000+ 条数据，如果不采取分片形式的话，任务只会在一台机器上执行，这样的话需要 20+ 秒才能执行完任务。如果采取分片广播的形式的话，一次任务调度将会广播触发对应集群中所有执行器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；获取分片参数方式如下：

  1. // 可参考 Sample 示例执行器中的示例任务 "ShardingJobHandler"
  2. int shardIndex = XxlJobHelper.getShardIndex();
  3. int shardTotal = XxlJobHelper.getShardTotal();

通过这两个参数，我们可以通过求模取余的方式，分别查询，分别执行，这样的话就可以提高处理的速度。之前 2000+ 条数据只在一台机器上执行需要 20+ 秒才能完成任务，分片后，有两台机器可以共同完成 2000+ 条数据，每台机器处理 1000+ 条数据，这样的话只需要 10+ 秒就能完成任务。

3.3 案例改造成任务分片

Mapper 增加查询方法

  1. @Mapper
  2. public interface UserMobilePlanMapper {
  4.     @Select("select * from t_user_mobile_plan where mod(id,#{shardingTotal})=#{shardingIndex}")
  5.     List<UserMobilePlan> selectByMod(@Param("shardingIndex") Integer shardingIndex,@Param("shardingTotal")Integer shardingTotal);
  6.     @Select("select * from t_user_mobile_plan")
  7.     List<UserMobilePlan> selectAll();
  8. }

任务类方法

  1. @XxlJob("sendMsgShardingHandler")
  2. public void sendMsgShardingHandler() throws Exception{
  4.     System.out.println("任务开始时间: "+new Date());
  5.     int shardTotal = XxlJobHelper.getShardTotal();
  6.     int shardIndex = XxlJobHelper.getShardIndex();
  7.     List<UserMobilePlan> userMobilePlans = null;
  8.     if(shardTotal==1){
  10.         //如果没有分片就直接查询所有数据
  11.         userMobilePlans = userMobilePlanMapper.selectAll();
  12.     }else{
  14.         userMobilePlans = userMobilePlanMapper.selectByMod(shardIndex,shardTotal);
  15.     }
  16.     System.out.println("处理任务数量: " + userMobilePlans.size());
  17.     Long startTime = System.currentTimeMillis();
  18.     userMobilePlans.forEach(item->{
  20.         try {
  22.             TimeUnit.MILLISECONDS.sleep(10);
  23.         } catch (InterruptedException e) {
  25.             e.printStackTrace();
  26.         }
  27.     });
  28.     System.out.println("任务结束时间: " + new Date());
  29.     System.out.println("任务耗时: " + (System.currentTimeMillis()-startTime) + " 毫秒");
  30. }

任务设置

在这里插入图片描述

发表评论

表情：
评论列表 （有 0 条评论，122人围观）

还没有评论，来说两句吧...

相关阅读