针对分布式任务调度的需求，市场上出现了很多的产品：

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/

特性

  • 简单灵活
    提供Web页面对任务进行管理，管理系统支持用户管理、权限控制；
    支持容器部署；
    支持通过通用HTTP提供跨平台任务调度；
  • 丰富的任务管理功能
    支持页面对任务CRUD操作；
    支持在页面编写脚本任务、命令行任务、Java代码任务并执行；
    支持任务级联编排，父任务执行结束后触发子任务执行；
    支持设置指定任务执行节点路由策略，包括轮询、随机、广播、故障转移、忙碌转移等；
    支持Cron方式、任务依赖、调度中心API接口方式触发任务执行
  • 高性能
    任务调度流程全异步化设计实现，如异步调度、异步运行、异步回调等，有效对密集调度进行流量削峰；
  • 高可用
    任务调度中心、任务执行节点均 集群部署，支持动态扩展、故障转移
    支持任务配置路由故障转移策略，执行器节点不可用是自动转移到其他节点执行
    支持任务超时控制、失败重试配置
    支持任务处理阻塞策略：调度当任务执行节点忙碌时来不及执行任务的处理策略，包括：串行、抛弃、覆盖策略
  • 易于监控运维
    支持设置任务失败邮件告警，预留接口支持短信、钉钉告警；
    支持实时查看任务执行运行数据统计图表、任务进度监控数据、任务完整执行日志；

1. XXL-Job-环境搭建

1.1 调度中心环境要求

  • Maven3+
  • Jdk1.8+
  • Mysql5.7+

1.2 源码仓库地址

源码仓库地址 Release Download
https://github.com/xuxueli/xxl-job Download
http://gitee.com/xuxueli0323/xxl-job Download

也可以使用资料文件夹中的源码

1.3

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

位置：/xxl-job/doc/db/tables_xxl_job.sql 共8张表
image-20210730001433997.png

  1. - xxl_job_lock：任务调度锁表；
  2. - xxl_job_group：执行器信息表，维护任务执行器信息；
  3. - xxl_job_info：调度扩展信息表： 用于保存XXL-JOB调度任务的扩展信息，如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等；
  4. - xxl_job_log：调度日志表： 用于保存XXL-JOB任务调度的历史信息，如调度结果、执行结果、调度入参、调度机器和执行器等等；
  5. - xxl_job_logglue：任务GLUE日志：用于保存GLUE更新历史，用于支持GLUE的版本回溯功能；
  6. - xxl_job_registry：执行器注册表，维护在线的执行器和调度中心机器地址信息；
  7. - xxl_job_user：系统用户表；

调度中心支持集群部署，集群情况下各节点务必连接同一个mysql实例;

如果mysql做主从,调度中心集群节点务必强制走主库;

1.4 编译源码

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

image-20210729230502703.png

1.5 配置部署“调度中心”

调度中心项目：xxl-job-admin

作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。

步骤一：调度中心配置

调度中心配置文件地址：/xxl-job/xxl-job-admin/src/main/resources/application.properties

数据库的连接信息修改为自己的数据库

  1. ### web
  2. server.port=8888
  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://127.0.0.1:3306/xxl_job?Unicode=true&serverTimezone=Asia/Shanghai&characterEncoding=UTF-8
  27. spring.datasource.username=root
  28. spring.datasource.password=root
  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
  42. ### xxl-job, email
  43. spring.mail.host=smtp.qq.com
  44. spring.mail.port=25
  45. spring.mail.username=xxx@qq.com
  46. spring.mail.password=xxx
  47. spring.mail.properties.mail.smtp.auth=true
  48. spring.mail.properties.mail.smtp.starttls.enable=true
  49. spring.mail.properties.mail.smtp.starttls.required=true
  50. spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
  52. ### xxl-job, access token
  53. xxl.job.accessToken=
  55. ### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
  56. xxl.job.i18n=zh_CN
  58. ## xxl-job, triggerpool max size
  59. xxl.job.triggerpool.fast.max=200
  60. xxl.job.triggerpool.slow.max=100
  62. ### xxl-job, log retention days
  63. xxl.job.logretentiondays=30

启动调度中心，默认登录账号 “admin/123456”, 登录后运行界面如下图所示。
image-20210729230630495.png

2. 配置部署调度中心-docker安装

1.创建mysql容器，初始化xxl-job的SQL脚本

  1. docker run -p 3306:3306 --name mysql57 \
  2. -v /opt/mysql/conf:/etc/mysql \
  3. -v /opt/mysql/logs:/var/log/mysql \
  4. -v /opt/mysql/data:/var/lib/mysql \
  5. -e MYSQL_ROOT_PASSWORD=root \
  6. -d mysql:5.7

2.拉取镜像

  1. docker pull xuxueli/xxl-job-admin:2.3.0

3.创建容器

  1. docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://192.168.200.130:3306/xxl_job?Unicode=true&characterEncoding=UTF-8 \
  2. --spring.datasource.username=root \
  3. --spring.datasource.password=root" \
  4. -p 8888:8080 -v /tmp:/data/applogs \
  5. --name xxl-job-admin --restart=always  -d xuxueli/xxl-job-admin:2.3.0

3 xxl-job入门案例编写

3.1 登录调度中心，点击下图所示“新建任务”按钮，新建示例任务

image-20210729232146585.png

3.2 创建xxljob-demo项目，导入依赖

  1. <dependencies>
  2.     <dependency>
  3.         <groupId>org.springframework.boot</groupId>
  4.         <artifactId>spring-boot-starter-web</artifactId>
  5.     </dependency>
  7.     <!--xxl-job-->
  8.     <dependency>
  9.         <groupId>com.xuxueli</groupId>
  10.         <artifactId>xxl-job-core</artifactId>
  11.         <version>2.3.0</version>
  12.     </dependency>
  13. </dependencies>

3.3 application.yml配置

  1. server:
  2.   port: 8881
  5. xxl:
  6.   job:
  7.     admin:
  8.       addresses: http://192.168.200.130:8888/xxl-job-admin
  9.     executor:
  10.       appname: xxl-job-executor-sample
  11.       port: 9999

3.4 新建配置类

  2. import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
  3. import org.slf4j.Logger;
  4. import org.slf4j.LoggerFactory;
  5. import org.springframework.beans.factory.annotation.Value;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  9. /**
  10.  * xxl-job config
  11.  *
  12.  * @author xuxueli 2017-04-28
  13.  */
  14. @Configuration
  15. public class XxlJobConfig {
  16.     private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
  18.     @Value("${xxl.job.admin.addresses}")
  19.     private String adminAddresses;
  21.     @Value("${xxl.job.executor.appname}")
  22.     private String appname;
  24.     @Value("${xxl.job.executor.port}")
  25.     private int port;
  28.     @Bean
  29.     public XxlJobSpringExecutor xxlJobExecutor() {
  30.         logger.info(">>>>>>>>>>> xxl-job config init.");
  31.         XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
  32.         xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
  33.         xxlJobSpringExecutor.setAppname(appname);
  34.         xxlJobSpringExecutor.setPort(port);
  35.         return xxlJobSpringExecutor;
  36.     }
  39. }

3.5 任务代码，重要注解:@XxlJob(“JobHandler”)

  2. import com.xxl.job.core.handler.annotation.XxlJob;
  3. import org.springframework.stereotype.Component;
  5. @Component
  6. public class HelloJob {
  9.     @XxlJob("demoJobHandler")
  10.     public void helloJob(){
  11.         System.out.println("简单任务执行了。。。。");
  13.     }
  14. }

3.6 测试-单节点

  • 启动微服务
  • 在xxl-job的调度中心中启动任务

4. 任务详解-执行器

  • 执行器：任务的绑定的执行器，任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能;
  • 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器

image-20210729232926534.pngimage-20210729232825564.png

以下是执行器的属性说明：

属性名称 说明
AppName 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
名称 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;
排序 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;
注册方式 调度中心获取执行器地址的方式；
机器地址 注册方式为”手动录入”时有效，支持人工维护执行器的地址信息；

自动注册和手动注册的区别和配置
image-20210729233016355.png

5.任务详解-基础配置

image-20210729233926457.png

基础配置

  • 执行器：每个任务必须绑定一个执行器, 方便给任务进行分组
  • 任务描述：任务的描述信息，便于任务管理；
  • 负责人：任务的负责人；
  • 报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔

image-20210729234009010.png
调度配置

  • 调度类型：
    • 无：该类型不会主动触发调度；
    • CRON：该类型将会通过CRON，触发任务调度；
    • 固定速度：该类型将会以固定速度，触发任务调度；按照固定的间隔时间，周期性触发；

image-20210729234114283.png

任务配置

  • 运行模式：

    BEAN模式：任务以JobHandler方式维护在执行器端；需要结合 “JobHandler” 属性匹配执行器中任务；

  • JobHandler：运行模式为 “BEAN模式” 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值；

  • 执行参数：任务执行所需的参数；

image-20210729234219162.png

阻塞处理策略

阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；

  • 单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO(First Input First Output)队列并以串行方式运行；
  • 丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
  • 覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；

image-20210729234256062.png

路由策略

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

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

image-20210729234409132.png

6. 路由策略(轮询)-案例

1.修改任务为轮询
image-20210729234513775.png

2.启动多个微服务

image-20210729234536483.png

修改yml配置文件

  1. server:
  2.   port: ${port:8881}
  5. xxl:
  6.   job:
  7.     admin:
  8.       addresses: http://192.168.200.130:8888/xxl-job-admin
  9.     executor:
  10.       appname: xxl-job-executor-sample
  11.       port: ${executor.port:9999}

3.启动多个微服务

每个微服务轮询的去执行任务

7. 路由策略(分片广播)

7.1 分片逻辑

执行器集群部署时，任务路由策略选择”分片广播”情况下，一次任务调度将会广播触发对应集群中所有执行器执行一次任务

image-20210729234756221.png

执行器集群部署时，任务路由策略选择”分片广播”情况下，一次任务调度将会广播触发对应集群中所有执行器执行一次任务

image-20210729234822935.png

7.2 路由策略(分片广播)-案例

需求：让两个节点同时执行10000个任务，每个节点分别执行5000个任务

①：创建分片执行器
image-20210729234930218.png

②：创建任务，路由策略为分片广播
image-20210729234948571.png

③：分片广播代码

分片参数

  1.  index：当前分片序号(从0开始)，执行器集群列表中当前执行器的序号；
  3.  total：总分片数，执行器集群的总机器数量；

修改yml配置

  1. server:
  2.   port: ${port:8881}
  5. xxl:
  6.   job:
  7.     admin:
  8.       addresses: http://192.168.200.130:8888/xxl-job-admin
  9.     executor:
  10.       appname: xxl-job-sharding-executor
  11.       port: ${executor.port:9999}

代码

  1. package com.heima.xxljob.job;
  3. import com.xxl.job.core.context.XxlJobHelper;
  4. import com.xxl.job.core.handler.annotation.XxlJob;
  5. import org.springframework.beans.factory.annotation.Value;
  6. import org.springframework.stereotype.Component;
  8. import java.util.ArrayList;
  9. import java.util.List;
  11. @Component
  12. public class HelloJob {
  14.     @Value("${server.port}")
  15.     private String port;
  18.     @XxlJob("demoJobHandler")
  19.     public void helloJob(){
  20.         System.out.println("简单任务执行了。。。。"+port);
  22.     }
  24.     @XxlJob("shardingJobHandler")
  25.     public void shardingJobHandler(){
  26.         //分片的参数
  27.         int shardIndex = XxlJobHelper.getShardIndex();
  28.         int shardTotal = XxlJobHelper.getShardTotal();
  30.         //业务逻辑
  31.         List<Integer> list = getList();
  32.         for (Integer integer : list) {
  33.             if(integer % shardTotal == shardIndex){
  34.                 System.out.println("当前第"+shardIndex+"分片执行了，任务项为："+integer);
  35.             }
  36.         }
  37.     }
  39.     public List<Integer> getList(){
  40.         List<Integer> list = new ArrayList<>();
  41.         for (int i = 0; i < 10000; i++) {
  42.             list.add(i);
  43.         }
  44.         return list;
  45.     }
  46. }

④：测试

启动多个微服务测试，一次执行可以执行多个任务