任务调度中心XXL-JOB小白教程，学习笔记，避免重复调度，作业分片--黑马程序员笔记及自己的见解

1. XXL-JOB介绍

​ XXL-JOB是一个轻量级分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。

官网：https://www.xuxueli.com/xxl-job/

​ XXL-JOB主要有调度中心、执行器、任务：

调度中心

​ 负责管理调度信息，按照调度配置发出调度请求，自身不承担业务代码；

​ 主要职责为执行器管理、任务管理、监控运维、日志管理等

任务执行器

​ 负责接收调度请求并执行任务逻辑；

​ 只要职责是注册服务、任务执行服务（接收到任务后会放入线程池中的任务队列）、执行结果上报、日志服务等

任务执行器

​ 负责接收调度请求并执行任务逻辑；

​ 只要职责是注册服务、任务执行服务（接收到任务后会放入线程池中的任务队列）、执行结果上报、日志服务等

任务

​ 负责执行具体的业务处理

调度中心与执行器之间的工作流程如下：

执行流程

​ 1.任务执行器根据配置的调度中心的地址，自动注册到调度中心

​ 2.达到任务触发条件，调度中心下发任务

​ 3.执行器基于线程池执行任务，并把执行结果放入内存队列中、把执行日志写入日志文件中

​ 4.执行器消费内存队列中的执行结果，主动上报给调度中心

​ 5.当用户在调度中心查看任务日志，调度中心请求任务执行器，任务执行器读取任务日志文件并返回日志详情

2. 搭建XXL-JOB

2.1 调度中心

​ 1. 首先下载XXL-JOB

​ GitHub：https://github.com/xuxueli/xxl-job

​ 码云：https://gitee.com/xuxueli0323/xxl-job

​ 使用IDEA打开解压后的目录

​ xxl-job-admin：调度中心

​ xxl-job-core：公共依赖

​ xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用）可仿照它使用

	1. xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；

	2. xxl-job-executor-sample-frameless：无框架版本；

​ doc :文档资料，包含数据库脚本,中文和英文版的官方使用文档

2. 创建数据库,在doc的db目录下包含sql脚本
   

3. 修改配置文件

   修改xxl-job-admin/src/main/resources下的application.properties文件，主要是修改数据源信息，若需要用到邮件报警功能，需要配置邮箱。

   ### xxl-job, datasource
   spring.datasource.url=jdbc:mysql://localhost:3306/xxl_job_2.3.1?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
   spring.datasource.username=root
   spring.datasource.password=root
   spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
   
   ### xxl-job, email
   # 这里使用腾讯企业邮箱，对应的host为smtp.exmail.qq.com，发送端口号为465
   spring.mail.host=smtp.exmail.qq.com 
   spring.mail.port=465
   spring.mail.username=xxx@qq.com # 用于发送邮件的账号
   spring.mail.from=xxx@qq.com # 邮件发送方的邮箱，一般和username一样
   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
   

4. 启动

   运行xxl-job-admin下的启动类，访问：http://localhost:8088/xxl-job-admin/

   账号和密码：admin/123456

2.2 执行器

​ 下边配置执行器，执行器负责与调度中心通信接收调度中心发起的任务调度请求。

1. 在你要执行任务的springboot模块下添加依赖

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.1</version>
</dependency>

2. 配置xxl-job

   xxl:
     job:
       admin: 
         addresses: http://localhost:8080/xxl-job-admin
       executor:
         appname: xxl-job-executor-sample #执行器的应用名 等会会用到
         address: 
         ip: 
         port: 9999
         logpath: /data/applogs/xxl-job/jobhandler
         logretentiondays: 30
       accessToken: default_token
   

   3. 配置xxl-job的执行器

      将xxl-job工程中XxlJobConfig复制到你springboot的config包下
      

      application.properties 中配置 xxl-job 执行器的相关参数

      ### 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
      xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
      ### 执行器通讯TOKEN [选填]：非空时启用；
      xxl.job.accessToken=
      ### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
      xxl.job.executor.appname=xxl-job-executor
      ### 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”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下边进入调度中心添加执行器
      

3. 下边进入调度中心添加执行器
   

   点击新增，填写执行器信息，appname是前边在配置xxl信息时指定的执行器的应用名。
   

4. 添加成功
   

   启动你的spring boot项目，启动后观察日志，出现下边的日志表示执行器在调度中心注册成功
   

   同时观察调度中心中的执行器界面

   在线机器地址处已显示1个执行器。

2.3 执行任务

​ 下面就以XXL-JOB 自带的xxl-job-executor-sample-springboot工程来举例

​ 在service包下jobhandler存放了一些自带的任务类

/**
     * 1、简单任务示例（Bean模式）
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");

        for (int i = 0; i < 5; i++) {
            XxlJobHelper.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
        // default success
    }

​ 下边在调度中心添加任务，进入任务管理

​ 点击新增，填写任务信息

配置详解：

基础配置：
    - 执行器：任务的绑定的执行器，任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 "执行器管理" 进行设置;
    - 任务描述：任务的描述信息，便于任务管理；
    - 负责人：任务的负责人；
    - 报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；
触发配置：
    - 调度类型：
        无：该类型不会主动触发调度；
        CRON：该类型将会通过CRON，触发任务调度；
        固定速度：该类型将会以固定速度，触发任务调度；按照固定的间隔时间，周期性触发；
        固定延迟：该类型将会以固定延迟，触发任务调度；按照固定的延迟时间，从上次调度结束后开始计算延迟时间，到达延迟时间后触发下次调度；
    - CRON：触发任务执行的Cron表达式；
    - 固定速度：固定速度的时间间隔，单位为秒；
    - 固定延迟：固定延迟的时间间隔，单位为秒；
任务配置：
    - 运行模式：
        BEAN模式：任务以JobHandler方式维护在执行器端；需要结合 "JobHandler" 属性匹配执行器中任务；
        GLUE模式(Java)：任务以源码方式维护在调度中心；该模式的任务实际上是一段继承自IJobHandler的Java类代码并 "groovy" 源码方式维护，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里中的其他服务；
        GLUE模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "shell" 脚本；
        GLUE模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "python" 脚本；
        GLUE模式(PHP)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "php" 脚本；
        GLUE模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "nodejs" 脚本；
        GLUE模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "PowerShell" 脚本；
    - JobHandler：运行模式为 "BEAN模式" 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值；
    - 执行参数：任务执行所需的参数；     
高级配置：
    - 路由策略：当执行器集群部署时，提供丰富的路由策略，包括；
        FIRST（第一个）：固定选择第一个机器；
        LAST（最后一个）：固定选择最后一个机器；
        ROUND（轮询）：；
        RANDOM（随机）：随机选择在线的机器；
        CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。
        LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举；
        LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举；
        FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；
        BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；
        SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；
    - 子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。
    - 调度过期策略：
        - 忽略：调度过期后，忽略过期的任务，从当前时间开始重新计算下次触发时间；
        - 立即执行一次：调度过期后，立即执行一次，并从当前时间开始重新计算下次触发时间；
    - 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
        单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
        丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
        覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
    - 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
    - 失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

​ 高级配置先不管，调度类型选择Cron，并配置Cron表达式设置定时策略。

​ Cron

​ Cron表达式是一个字符串，通过它可以定义调度策略，格式如下：

​ {秒数} {分钟} {小时} {日期} {月份} {星期} {年份(可为空)}

​ xxl-job提供图形界面去配置：

​ 一些例子如下：

​ 30 10 1 * * ? 每天1点10分30秒触发

​ 0/30 * * * * ? 每30秒触发一次

​ * 0/10 * * * ? 每10分钟触发一次

运行模式有BEAN和GLUE，bean模式较常用就是在项目工程中编写执行器的任务代码，GLUE是将任务代码编写在调度中心。

JobHandler任务方法名填写@XxlJob注解中的名称。

添加成功，启动任务

观察执行器方法的执行。

如果要停止任务需要在调度中心操作

任务跑一段时间注意清理日志

3. 分片广播

​ 掌握了xxl-job的基本使用，下边思考如何进行分布式任务处理呢？如下图，我们会启动多个执行器组成一个集群，去执行任务。

​ 执行器在集群部署下调度中心有哪些调度策略呢？

​ 查看xxl-job官方文档，阅读高级配置相关的内容：

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

下边要重点说的是分片广播策略，分片是指是调度中心将集群中的执行器标上序号：0，1，2，3…，广播是指每次调度会向集群中所有执行器发送调度请求，请求中携带分片参数。

如下图：

每个执行器收到调度请求根据分片参数自行决定是否执行任务。

另外xxl-job还支持动态分片，当执行器数量有变更时，调度中心会动态修改分片的数量。

作业分片适用哪些场景呢？

• 分片任务场景：10个执行器的集群来处理10w条数据，每台机器只需要处理1w条数据，耗时降低10倍；
• 广播任务场景：广播执行器同时运行shell脚本、广播集群节点进行缓存更新等。

所以，广播分片方式不仅可以充分发挥每个执行器的能力，并且根据分片参数可以控制任务是否执行，最终灵活控制了执行器集群分布式处理任务。

使用说明：

“分片广播” 和普通任务开发流程一致，不同之处在于可以获取分片参数进行分片业务处理。

Java语言任务获取分片参数方式：

BEAN、GLUE模式(Java)，可参考Sample示例执行器中的示例任务"ShardingJobHandler"：

 /**
     * 2、分片广播任务
     */
    @XxlJob("shardingJobHandler")
    public void shardingJobHandler() throws Exception {

        // 分片参数
         // 分片序号，从0开始
        int shardIndex = XxlJobHelper.getShardIndex();
         // 分片总数
        int shardTotal = XxlJobHelper.getShardTotal();

        XxlJobHelper.log("分片参数：当前分片序号 = {}, 总分片数 = {}", shardIndex, shardTotal);

        // 业务逻辑
        for (int i = 0; i < shardTotal; i++) {
            if (i == shardIndex) {
                XxlJobHelper.log("第 {} 片, 命中分片开始处理", i);
            } else {
                XxlJobHelper.log("第 {} 片, 忽略", i);
            }
        }

    }

1、定义作业分片的任务方法

/**
  * 2、分片广播任务
  */
 @XxlJob("shardingJobHandler")
 public void shardingJobHandler() throws Exception {

  // 分片参数
  int shardIndex = XxlJobHelper.getShardIndex();
  int shardTotal = XxlJobHelper.getShardTotal();

log.info("分片参数：当前分片序号 = {}, 总分片数 = {}", shardIndex, shardTotal);
log.info("开始执行第"+shardIndex+"批任务");

 }

2、在调度中心添加任务

​ 高级配置说明：

  	- 子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度，通过子任务可以实现一个任务执行完成去执行另一个任务。
    - 调度过期策略：
        - 忽略：调度过期后，忽略过期的任务，从当前时间开始重新计算下次触发时间；
        - 立即执行一次：调度过期后，立即执行一次，并从当前时间开始重新计算下次触发时间；
    - 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；
        单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；
        丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
        覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
    - 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
    - 失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

​ 启动任务，观察日志

​ 下边启动两个执行器实例，观察每个实例的执行情况

​ 两个实例的在启动时注意端口不能冲突：

​ 实例1 在VM options处添加：-Dserver.port=63051 -Dxxl.job.executor.port=9998

​ 实例2 在VM options处添加：-Dserver.port=63050 -Dxxl.job.executor.port=9999

​ 例如：

​ 启动两个实例

​ 观察任务调度中心，稍等片刻执行器有两个

​ 观察两个执行实例的日志：

​ 另一实例的日志如下：

​ 从日志可以看每个实例的分片序号不同。

​ 到此作业分片任务调试完成，此时我们可以思考：

​ 当一次分片广播到来，各执行器如何根据分片参数去分布式执行任务，保证执行器之间执行的任务不重复呢？

4. 需求分析

4.1 作业分片方案

​ 任务添加成功后，对于要处理的任务会添加到待处理任务表中，现在启动多个执行器实例去查询这些待处理任务，此时如何保证多个执行器不会重复执行任务？

​ 执行器收到调度请求后各自己查询属于自己的任务，这样就保证了执行器之间不会重复执行任务。

​ xxl-job设计作业分片就是为了分布式执行任务，XXL-JOB并不直接提供数据处理的功能，它只会给执行器分配好分片序号并向执行器传递分片总数、分片序号这些参数，开发者需要自行处理分片项与真实数据的对应关系。

​ 下图表示了多个执行器获取处理任务的结构：

​ 每个执行器收到广播任务有两个参数：分片总数、分片序号。每个执行从数据表取任务时可以让任务id 模上 分片总数，如果等于分片序号则执行此任务。

​ 上边两个执行器实例那么分片总数为2，序号为0、1，从任务1开始，如下：

​ 1 % 2 = 1 执行器2执行

​ 2 % 2 = 0 执行器1执行

​ 3 % 2 = 1 执行器2执行

​ 以此类推.

4.2 保证任务不重复执行

​ 首先配置调度过期策略：

​ 查看文档如下：

 	 - 调度过期策略：
   	 	- 忽略：调度过期后，忽略过期的任务，从当前时间开始重新计算下次触发时间；
    	- 立即执行一次：调度过期后，立即执行一次，并从当前时间开始重新计算下次触发时间；
  	 - 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；

​ 这里我们选择忽略，如果立即执行一次可能会重复调度。

​ 其次，再看阻塞处理策略，阻塞处理策略就是当前执行器正在执行任务还没有结束时调度时间到达到，此时该如何处理。

​ 查看文档如下：

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

这里选择 丢弃后续调度，避免重复调度。

最后，也就是要注意保证任务处理的幂等性，什么是任务的幂等性？任务的幂等性是指：对于数据的操作不论多少次，操作的结果始终是一致的。

什么是幂等性？

​ 它描述了一次和多次请求某一个资源对于资源本身应该具有同样的结果。

​ 幂等性是为了解决重复提交问题，比如：恶意刷单，重复支付等。

解决幂等性常用的方案：

1）数据库约束，比如：唯一索引，主键。

2）乐观锁，常用于数据库，更新数据时根据乐观锁状态去更新。

3）唯一序列号，操作传递一个唯一序列号，操作时判断与该序列号相等则执行。

路由策略：选择 一致性HASH
阻塞处理策略：选择 丢弃后续调度