SpringBoot工具篇--XXL-JOB 分布式任务调度平台

小灰灰 2023-09-27 14:07 146阅读 0赞

**目录**

一、简介

1.1 概述

1.2 社区交流

1.3 特性

1.4 架构设计

1.5、同类型框架对比

1.6 下载

1.7 环境

二、XXL-JOB安装部署

2.1、配置部署“调度中心”

2.2、配置部署“执行器项目”

--------------------

## 一、简介 ##

### 1.1 概述 ###

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

### 1.2 社区交流 ###

官方地址中文版：[http://www.xuxueli.com/xxl-job][http_www.xuxueli.com_xxl-job]

githuab源码： [https://github.com/xuxueli/xxl-job/releases][https_github.com_xuxueli_xxl-job_releases]

码云地址：[https://gitee.com/xuxueli0323/xxl-job][https_gitee.com_xuxueli0323_xxl-job]

XXL开源社区：[分布式任务调度平台XXL-JOB][XXL-JOB]

### 1.3 特性 ###

> 1、简单：支持通过Web页面对任务进行CRUD操作，操作简单，一分钟上手；
> 
> 2、动态：支持动态修改任务状态、启动/停止任务，以及终止运行中任务，即时生效；
> 
> 3、调度中心HA（中心式）：调度采用中心式设计，“调度中心”自研调度组件并支持集群部署，可保证调度中心HA；
> 
> 4、执行器HA（分布式）：任务分布式执行，任务”执行器”支持集群部署，可保证任务执行HA；
> 
> 5、注册中心: 执行器会周期性自动注册任务, 调度中心将会自动发现注册的任务并触发执行。同时，也支持手动录入执行器地址；
> 
> 6、弹性扩容缩容：一旦有新执行器机器上线或者下线，下次调度时将会重新分配任务；
> 
> 7、触发策略：提供丰富的任务触发策略，包括：Cron触发、固定间隔触发、固定延时触发、API（事件）触发、人工触发、父子任务触发；
> 
> 8、调度过期策略：调度中心错过调度时间的补偿处理策略，包括：忽略、立即补偿触发一次等；
> 
> 9、阻塞处理策略：调度过于密集执行器来不及处理时的处理策略，策略包括：单机串行（默认）、丢弃后续调度、覆盖之前调度；
> 
> 10、任务超时控制：支持自定义任务超时时间，任务运行超时将会主动中断任务；
> 
> 11、任务失败重试：支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；其中分片任务支持分片粒度的失败重试；
> 
> 12、任务失败告警；默认提供邮件方式失败告警，同时预留扩展接口，可方便的扩展短信、钉钉等告警方式；
> 
> 13、路由策略：执行器集群部署时提供丰富的路由策略，包括：第一个、最后一个、轮询、随机、一致性HASH、最不经常使用、最近最久未使用、故障转移、忙碌转移等；
> 
> 14、分片广播任务：执行器集群部署时，任务路由策略选择”分片广播”情况下，一次任务调度将会广播触发集群中所有执行器执行一次任务，可根据分片参数开发分片任务；
> 
> 15、动态分片：分片广播任务以执行器为维度进行分片，支持动态扩容执行器集群从而动态增加分片数量，协同进行业务处理；在进行大数据量业务操作时可显著提升任务处理能力和速度。
> 
> 16、故障转移：任务路由策略选择”故障转移”情况下，如果执行器集群中某一台机器故障，将会自动Failover切换到一台正常的执行器发送调度请求。
> 
> 17、任务进度监控：支持实时监控任务进度；
> 
> 18、Rolling实时日志：支持在线查看调度结果，并且支持以Rolling方式实时查看执行器输出的完整的执行日志；
> 
> 19、GLUE：提供Web IDE，支持在线开发任务逻辑代码，动态发布，实时编译生效，省略部署上线的过程。支持30个版本的历史版本回溯。
> 
> 20、脚本任务：支持以GLUE模式开发和运行脚本任务，包括Shell、Python、NodeJS、PHP、PowerShell等类型脚本;
> 
> 21、命令行任务：原生提供通用命令行任务Handler（Bean任务，”CommandJobHandler”）；业务方只需要提供命令行即可；
> 
> 22、任务依赖：支持配置子任务依赖，当父任务执行结束且执行成功后将会主动触发一次子任务的执行, 多个子任务用逗号分隔；
> 
> 23、一致性：“调度中心”通过DB锁保证集群分布式调度的一致性, 一次任务调度只会触发一次执行；
> 
> 24、自定义任务参数：支持在线配置调度任务入参，即时生效；
> 
> 25、调度线程池：调度系统多线程触发调度运行，确保调度精确执行，不被堵塞；
> 
> 26、数据加密：调度中心和执行器之间的通讯进行数据加密，提升调度信息安全性；
> 
> 27、邮件报警：任务失败时支持邮件报警，支持配置多邮件地址群发报警邮件；
> 
> 28、推送maven中央仓库: 将会把最新稳定版推送到maven中央仓库, 方便用户接入和使用;
> 
> 29、运行报表：支持实时查看运行数据，如任务数量、调度次数、执行器数量等；以及调度报表，如调度日期分布图，调度成功分布图等；
> 
> 30、全异步：任务调度流程全异步化设计实现，如异步调度、异步运行、异步回调等，有效对密集调度进行流量削峰，理论上支持任意时长任务的运行；
> 
> 31、跨语言：调度中心与执行器提供语言无关的 RESTful API 服务，第三方任意语言可据此对接调度中心或者实现执行器。除此之外，还提供了 “多任务模式”和“httpJobHandler”等其他跨语言方案；
> 
> 32、国际化：调度中心支持国际化设置，提供中文、英文两种可选语言，默认为中文；
> 
> 33、容器化：提供官方docker镜像，并实时更新推送dockerhub，进一步实现产品开箱即用；
> 
> 34、线程池隔离：调度线程池进行隔离拆分，慢任务自动降级进入”Slow”线程池，避免耗尽调度线程，提高系统稳定性；
> 
> 35、用户管理：支持在线管理系统用户，存在管理员、普通用户两种角色；
> 
> 36、权限控制：执行器维度进行权限控制，管理员拥有全量权限，普通用户需要分配执行器权限后才允许相关操作；

### 1.4 架构设计 ###

![e4846646819d4fc6881472561ed7fced.png][]

#### 1.4.1 设计思想 ####

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

将任务抽象成分散的JobHandler，交由“执行器”统一管理，“执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑。

因此，“调度”和“任务”两部分可以相互解耦，提高系统整体稳定性和扩展性；

#### 1.4.2 系统组成 ####

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

#### 1.4.3 调度模块剖析 ####

**1） quartz的不足**

Quartz作为开源作业调度中的佼佼者，是作业调度的首选。但是集群环境中Quartz采用API的方式对任务进行管理，从而可以避免上述问题，但是同样存在以下问题：

*  问题一：调用API的的方式操作任务，不人性化；
 *  问题二：需要持久化业务QuartzJobBean到底层数据表中，系统侵入性相当严重。
 *  问题三：调度逻辑和QuartzJobBean耦合在同一个项目中，这将导致一个问题，在调度任务数量逐渐增多，同时调度任务逻辑逐渐加重的情况下，此时调度系统的性能将大大受限于业务；
 *  问题四：quartz底层以“抢占式”获取DB锁并由抢占成功节点负责运行任务，会导致节点负载悬殊非常大；而XXL-JOB通过执行器实现“协同分配式”运行任务，充分发挥集群优势，负载各节点均衡。

**XXL-JOB弥补了quartz的上述不足之处。**

### 1.5、同类型框架对比  ###

![bc9141b2af7c404893759bf1c5bf2452.png][]

### 1.6 下载 ###

#### **1.6.1 文档地址** ####

[中文文档][Link 1]

<dependency>
 <groupId>com.xuxueli</groupId>
 <artifactId>xxl-job-core</artifactId>
 <version>${最新稳定版本}</version>
 </dependency>

> maven库：[https://mvnrepository.com/artifact/com.xuxueli/xxl-job-core][https_mvnrepository.com_artifact_com.xuxueli_xxl-job-core]

### 1.7 环境 ###

*  Maven3+
 *  Jdk1.8+
 *  Mysql5.7+

## 2.XXL-JOB安装部署 ##

**项目引入分布式调度中心步骤**  
**1、部署管理后台**  
【1】执行mysql脚本  
【2】配置配置文件：secret key + mysql 地址 + 端口号  
【3】部署启动

**2、执行器引入**  
【1】引入core 依赖  
【2】配置链接后台信息：后台address + secret key + 链接端口号  
【3】编写job类

### 2.1、配置部署“调度中心” ###

#### **1）**从github把源码工程clone到本地 ####

#### [https://github.com/xuxueli/xxl-job][https_github.com_xuxueli_xxl-job] ####

#### **2）**按照maven格式将源码导入IDE，源码结构如下： ####

> xxl-job-admin：调度中心  
> xxl-job-core：公共依赖  
> xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）  
> ：xxl-job-executor-sample-springboot：Springboot版本示例，通过Springboot管理执行器；  
> ：xxl-job-executor-sample-frameless：无框架版本示例；

![88975e15bd2a49f6a2f3c229733ab84e.png][]

#### **3) 执行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：系统用户表

“调度数据库初始化SQL脚本” 位置为：

> doc/db/tables\_xxl\_job.sql

![2402c761d27345b9a8f85fedbf500b73.png][]

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

#### **4）**修改数据库配置文件**application.properties** ####

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

修改数据库连接信息或服务端口

### web
    server.port=30020
    server.servlet.context-path=/xxl-job-admin
    ### 调度中心JDBC链接：链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
    spring.datasource.url=jdbc:mysql://192.168.6.13: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.jdbc.Driver
    
    ### 报警邮箱
    spring.mail.host=smtp.qq.com
    spring.mail.port=25
    spring.mail.username=314569024@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
    ### 调度中心通讯TOKEN [选填]：非空时启用，访问令牌（AccessToken）
    ### 为提升系统安全性，调度中心和执行器进行安全性校验，双方AccessToken匹配才允许通讯；
    ### 调度中心和执行器，可通过配置项 “xxl.job.accessToken” 进行AccessToken的设置。
    ### 调度中心和执行器，如果需要正常通讯，只有两种设置；
    ###     设置一：调度中心和执行器，均不设置AccessToken；关闭安全性校验；
    ###     设置二：调度中心和执行器，设置了相同的AccessToken；；
    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

#### **5）**登录的用户名和密码，根据需求修改 ####

xxl.job.login.username=admin  
xxl.job.login.password=123456

#### **6）**修改logback.xml（非必需） ####

可以默认，也可以自定义路径

#### **7）启动xxl\_job任务调度中心** ####

可以选择直接在开发工具里边启动调度中心，或者打包为jar包启动

> 启动命令：nohup java -jar xxxx.jar >/dev/null 2>&1 &
> 
> 查看进程：ps -ef|grep xxxx.jar

#### **8）访问web** ####

> http://IP或者域名:端口/xxl-job-admin/
> 
> [http://127.0.0.1:30020/xxl-job-admin/][http_127.0.0.1_30020_xxl-job-admin]

![b3309cffe28748038f8819471792249c.png][]

### 2.2、项目集成 ###

> **“执行器”项目：**xxl-job-executor-sample-springboot (提供多种版本执行器供选择，现以 springboot 版本为例，**可直接使用，也可以参考其并将现有项目改造成执行器**)  
> **作用：**负责接收“调度中心”的调度并执行；可直接部署执行器，也可以将执行器集成到现有业务项目中。

**执行器引入步骤：**  
【1】引入core 依赖  
【2】配置链接后台信息：后台address + secret key + 链接端口号  
【3】编写job类

#### **1）引入maven依赖** ####

确认pom文件中引入了 “xxl-job-core” 的maven依赖；

> maven库：[https://mvnrepository.com/artifact/com.xuxueli/xxl-job-core][https_mvnrepository.com_artifact_com.xuxueli_xxl-job-core]

![2c5fd3fb7fab448485bc26fcfcb90a98.png][]

#### **2）执行器配置** ####

**将执行器配置文件内容拷贝到个人项目配置文件中**

![86d1f7353c5c4f04842b12b39edd383e.png][]

执行器配置，配置文件地址：

> /xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties

执行器配置，配置内容说明：

### 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
    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-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

附yml文件

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

**3) 执行器组件配置**

**将执行器组件拷贝到个人项目**

执行器组件，配置文件地址：

> /xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java

执行器组件，配置内容说明：

package com.ykx.data.conf;
 
 /**
 * @ClassName: XxlJobConfig
 * @author: dyt
 * @since: 2023/09/07 上午 9:32
 */
 
 import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
 import com.xxl.job.core.util.IpUtil;
 import lombok.extern.slf4j.Slf4j;
 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
 */
 @Slf4j
 @Configuration
 public class XxlJobConfig {
 
 @Value("${xxl.job.admin.addresses}")
 private String adminAddresses;
 
 @Value("${xxl.job.accessToken}")
 private String accessToken;
 
 @Value("${xxl.job.executor.appname}")
 private String appname;
 
 @Value("${xxl.job.executor.address}")
 private String address;
 
 @Value("${xxl.job.executor.ip}")
 private String ip;
 
 @Value("${xxl.job.executor.port}")
 private int port;
 
 @Value("${xxl.job.executor.logpath}")
 private String logPath;
 
 @Value("${xxl.job.executor.logretentiondays}")
 private int logRetentionDays;
 
 
 @Bean
 public XxlJobSpringExecutor xxlJobExecutor() {
 log.info(">>>>>>>>>>> xxl-job config init.");
 XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
 xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
 xxlJobSpringExecutor.setAppname(appname);
 xxlJobSpringExecutor.setAddress(address);
 xxlJobSpringExecutor.setIp(IpUtil.getIp());
 xxlJobSpringExecutor.setPort(port);
 xxlJobSpringExecutor.setAccessToken(accessToken);
 xxlJobSpringExecutor.setLogPath(logPath);
 xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
 
 return xxlJobSpringExecutor;
 }
 
 /**
 * 针对多网卡、容器内部署等情况，可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP；
 *
 * 1、引入依赖：
 * <dependency>
 * <groupId>org.springframework.cloud</groupId>
 * <artifactId>spring-cloud-commons</artifactId>
 * <version>${version}</version>
 * </dependency>
 *
 * 2、配置文件，或者容器启动变量
 * spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
 *
 * 3、获取IP
 * String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
 */
 
 
 }

#### **4) 编写demo** ####

*  **BEAN模式（类形式）**
    
     *  Bean模式任务，支持基于类的开发方式，每个任务对应一个Java类。
 *  **优点：**
    
     *  不限制项目环境，兼容性好。即使是无框架项目，如main方法直接启动的项目也可以提供支持，可以参考示例项目 “xxl-job-executor-sample-frameless”；
 *  **缺点：**
    
     *  每个任务需要占用一个Java类，造成类的浪费；
     *  不支持自动扫描任务并注入到执行器容器，需要手动注入。

**步骤一：**执行器项目中，开发Job类

开发一个继承自"com.xxl.job.core.handler.IJobHandler"的JobHandler类，实现其中任务方法。
    2、手动通过如下方式注入到执行器容器。
    ```
    XxlJobExecutor.registJobHandler("demoJobHandler", new DemoJobHandler());

**步骤二：**调度中心，新建调度任务

后续步骤和 “BEAN模式（方法形式）”一致，可以前往参考

*  ##### GLUE模式(Java) #####

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

步骤一：调度中心，新建调度任务：

参考下文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “GLUE模式(Java)”；

![89c1e1e1c3571c47ad069bfcbcdd7d5d.png][]

**步骤二：**开发任务代码：

选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发（也可以在IDE中开发完成后，复制粘贴到编辑中）。

版本回溯功能（支持30个版本的版本回溯）：在GLUE任务的Web IDE界面，选择右上角下拉框“版本回溯”，会列出该GLUE的更新历史，选择相应版本即可显示该版本代码，保存后GLUE代码即回退到对应的历史版本；

*  #####  **BEAN模式（方法形式）** #####

Bean模式任务，支持基于方法的开发方式，每个任务对应一个方法。

*  优点：
    
     *  每个任务只需要开发一个方法，并添加”[@XxlJob][XxlJob]”注解即可，更加方便、快速。
     *  支持自动扫描任务并注入到执行器容器。
 *  缺点：要求Spring容器环境；

> 基于方法开发的任务，底层会生成JobHandler代理，和基于类的方式一样，任务也会以JobHandler的形式存在于执行器任务容器中。

**步骤一：**执行器项目中，开发Job方法

1、任务开发：在Spring Bean实例中，开发Job方法；
    2、注解配置：为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")"，注解value值对应的是调度中心新建任务的JobHandler属性的值。
    3、执行日志：需要通过 "XxlJobHelper.log" 打印执行日志；
    4、任务结果：默认任务结果为 "成功" 状态，不需要主动设置；如有诉求，比如设置任务结果为失败，可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果；
    // 可参考Sample示例执行器中的 "com.xxl.job.executor.service.jobhandler.SampleXxlJob" ，如下：
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");
    }

![8f3536de5d0245deb4d7562fe46c7442.png][]

package com.example.demo.demo;
    
    import com.xxl.job.core.context.XxlJobHelper;
    import com.xxl.job.core.handler.annotation.XxlJob;
    import org.springframework.stereotype.Component;
    
    /**
     * @ClassName: demojob
     * @author: dyt
     * @since: 2023/02/06 下午 4:52
     */
    
    @Component
    public class DemoJob  {
        @XxlJob("testQuartz")
        public void testQuartz(){
            String jobParam = XxlJobHelper.getJobParam();  // 获取任务参数
            System.out.println("执行的定时任务");
        }
    }

**步骤二：调度中心，新建调度任务**

**详见后续第六和第七步，本文采用方BEAN模式（方法形式），演示xxl\_job效果**

> **小结：工作中，常用模式就是BEAN模式（方法形式），或者类形式，其他形式参考开源中文手册**

--------------------

#### **5) 部署执行器项目：** ####

如果已经正确进行上述配置，可将执行器项目编译打部署，部署方式如下。

> 启动项目提示： xxl-job remoting server start success, nettype = class com.xxl.job.core.server.EmbedServer, port = 9999，则代表集成成功

![60ff49cad95e48cf8e489efaa10339f3.png][]

**至此“执行器”项目已经部署结束。**

#### **6) 配置执行器** ####

**Appname:**与项目配置文件xxl.job.executor.appname保持一致。

**名称：**自定义；

**注册方式：**自动注册，也可手动填写

![e79bcb3ba86c424e9cd59483cb2c8d14.png][]

![1b0350bed37148c89994aabb72a4c841.png][]

>  由于系统初始化默认存在示例执行器，在引入个人项目时，若未修改配置文件中示例执行器名称，则在启动项目后，登录任务调度中心，进入执行器管理模块，看到存在一个示例执行器，且online机器地址可以查看，代表个人集成xxl\_job示例项目demo3自动注册成功

集成项目启动后，自动注册执行器到调度中心，此时，可查看执行器机器地址：

![1050c7507ad74bb2adc42d2a5d9d30d1.png][]

#### **7）**调度中心，新建调度任务 ####

**本文使用的bean模式，所以运行模式选择 BEAN**

*  **BEAN模式**

参考下文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “BEAN模式”，JobHandler属性填写任务注解“[@XxlJob][XxlJob]”中定义的值；

![c5599b5691354e1eb1481f90159739b3.png][]

*   **GLUE模式(Java)**

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

**步骤一：调度中心，新建调度任务：**

参考上文“配置属性详细说明”对新建的任务进行参数配置，运行模式选中 “GLUE模式(Java)”；

**步骤二：开发任务代码：**

![a8665f10cebb41bd8998af8559ab592d.png][]

**1.执行器**

建立的项目执行器，下拉选择

**2.任务描述：**  
自定义描述内容

**3.Cron表达式：**  
这个参数表示你要多久，什么时候去调用这个任务，调用时间可根据需求自定义

xxl-job的表达式由7个部分组成，各个位置的取值范围

> **秒数 分钟 小时 日期 月份 星期 年份(可为空)\}  
> \*/5 \* \* \* \* ?**
> 
> 秒 0-59 , - \* 
> 
> 分 0-59 , - \* /
> 
> 小时 0-23 , - \* /
> 
> 日期 1-31 , - \* ? / L W C
> 
> 月份 1-12 或者 JAN-DEC , - \* / 可以用0-11 或用字符串 “JAN, FEB, MAR, APR, MAY,  
> JUN, JUL, AUG, SEP, OCT, NOV and DEC” 表示
> 
> 星期 1-7 或者 SUN-SAT , - \* ? / L C \# 可以用数字1-7表示（1 ＝ 星期日）或用字符口串“SUN, MON,  
> TUE, WED, THU, FRI and SAT”表示
> 
> 年（可选） 留空, 1970-2099 , - \* /

也可以通过cron在线表达式生成器直接生成：[在线Cron表达式生成器][Cron]

**4.JobHandler：**  
这个参数就是代码里面定义的任务唯一标识，与测试demo类中， 注解@XxlJob("testQuartz")中名称一致

![1f8d7833f10046ddb0893c3acbe14a2c.png][]

**5.任务参数：**  
传递给后台代码的参数值

**6.子任务ID：**

当有任务需要相互依赖时使用，比如在对账业务里，下载对账文件任务成功之后，才开始对账。那么，可以把这几个任务当成一个大任务来串行处理，即在一个任务的末尾触发另一个任务。

如果我们需要在本任务执行结束并且执行成功的时候触发另外一个任务，那么就可以把另外的任务作为本任务的子任务运行，就只需要在本任务里填入另外一个任务的jobId即可(可以在任务列表查看JobId)

#### 配置属性详细说明： ####

触发配置：
        - 调度类型：
            无：该类型不会主动触发调度；
            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队列并以串行方式运行；
            丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；
            覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；
        - 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务；
        - 失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

#### **8）执行一次任务** ####

**选择操作，执行一次，查看测试项目控制台以及调度日志**

![9884e731c4c3440ebe9a639eb2b51d44.png][]

![d4554fdd4b69452d9676794e3d4febaa.png][]

执行成功：![9356b4af6fe74b44a8e9a69ca2aa13bd.png][]

## 3.通讯模块剖析 ##

### 3.1 一次完整的任务调度通讯流程 ###

> 1.  `- 1、“调度中心”向“执行器”发送http调度请求: “执行器”中接收请求的服务，实际上是一台内嵌Server，默认端口9999;`
> 2.  `- 2、“执行器”执行任务逻辑；`
> 3.  `- 3、“执行器”http回调“调度中心”调度结果: “调度中心”中接收回调的服务，是针对执行器开放一套API服务;`

### 3.2、任务注册, 任务自动发现 ###

自v1.5版本之后, 任务取消了”任务执行机器”属性, 改为通过任务注册和自动发现的方式, 动态获取远程执行器地址并执行。

> 1.  `AppName: 每个执行器机器集群的唯一标示, 任务注册以 "执行器" 为最小粒度进行注册; 每个任务通过其绑定的执行器可感知对应的执行器机器列表;`
> 2.  `注册表: 见"xxl_job_registry"表, "执行器" 在进行任务注册时将会周期性维护一条注册记录，即机器地址和AppName的绑定关系; "调度中心" 从而可以动态感知每个AppName在线的机器列表;`
> 3.  `执行器注册: 任务注册Beat周期默认30s; 执行器以一倍Beat进行执行器注册, 调度中心以一倍Beat进行动态任务发现; 注册信息的失效时间为三倍Beat;`
> 4.  `执行器注册摘除：执行器销毁时，将会主动上报调度中心并摘除对应的执行器机器信息，提高心跳注册的实时性；`

### 3.3、访问令牌（AccessToken） ###

为提升系统安全性，调度中心和执行器进行安全性校验，双方AccessToken匹配才允许通讯；

调度中心和执行器，可通过配置项 “xxl.job.accessToken” 进行AccessToken的设置。

调度中心和执行器，如果需要正常通讯，只有两种设置；

*  设置一：调度中心和执行器，均不设置AccessToken；关闭安全性校验；
 *  设置二：调度中心和执行器，设置了相同的AccessToken

### 3.4、任务超时控制 ###

支持设置任务超时时间，任务运行超时的情况下，将会主动中断任务；

需要注意的是，任务超时中断时与任务终止机制（可查看“4.9 终止运行中的任务”）类似，也是通过 “interrupt” 中断任务，因此业务代码需要将 “InterruptedException” 外抛，否则功能不可用。

### 3.5、任务失败告警 ###

默认提供邮件失败告警，可扩展短信、钉钉等方式。如果需要新增一种告警方式，只需要新增一个实现 “com.xxl.job.admin.core.alarm.JobAlarm” 接口的告警实现即可。可以参考默认提供邮箱告警实现 “EmailJobAlarm”。

### 3.6、避免任务重复执行 ###

调度密集或者耗时任务可能会导致任务阻塞，集群情况下调度组件小概率情况下会重复触发；  
针对上述情况，可以通过结合 “单机路由策略（如：第一台、一致性哈希）” + “阻塞策略（如：单机串行、丢弃后续调度）” 来规避，最终避免任务重复执行。

### 3.7、日志自动清理 ###

XXL-JOB日志主要包含如下两部分，均支持日志自动清理，说明如下：

*  调度中心日志表数据：可借助配置项 “xxl.job.logretentiondays” 设置日志表数据保存天数，过期日志自动清理；详情可查看上文配置说明；
 *  执行器日志文件数据：可借助配置项 “xxl.job.executor.logretentiondays” 设置日志文件数据保存天数，过期日志自动清理；详情可查看上文配置说明；

## 常用邮箱SMTP服务器地址及端口 ##

<table> 
 <tbody> 
 <tr> 
 <td>常用邮箱</td> 
 <td>SMTP服务器地址及端口</td> 
 <td>POP3服务器地址及端口</td> 
 </tr> 
 <tr> 
 <td>QQ邮箱</td> 
 <td>smtp.qq.com（端口：25）</td> 
 <td>pop.qq.com（端口：110）</td> 
 </tr> 
 <tr> 
 <td>QQ企业邮箱</td> 
 <td>pop.exmail.qq.com&nbsp;（SSL启用 端口：995）</td> 
 <td>smtp.exmail.qq.com（SSL启用 端口：587/465）</td> 
 </tr> 
 <tr> 
 <td>126邮箱</td> 
 <td>pop.126.com（端口：110）</td> 
 <td>smtp.126.com（端口：25）</td> 
 </tr> 
 </tbody> 
</table>

> 报警邮件配置(发送者),需要在对应邮箱设置中开启SMTP获取授权码

[http_www.xuxueli.com_xxl-job]: https://links.jianshu.com/go?to=http%3A%2F%2Fwww.xuxueli.com%2Fxxl-job
[https_github.com_xuxueli_xxl-job_releases]: https://links.jianshu.com/go?to=https%3A%2F%2Fgithub.com%2Fxuxueli%2Fxxl-job%2Freleases
[https_gitee.com_xuxueli0323_xxl-job]: https://gitee.com/xuxueli0323/xxl-job
[XXL-JOB]: https://www.xuxueli.com/xxl-job/#%E3%80%8A%E5%88%86%E5%B8%83%E5%BC%8F%E4%BB%BB%E5%8A%A1%E8%B0%83%E5%BA%A6%E5%B9%B3%E5%8F%B0XXL-JOB%E3%80%8B
[e4846646819d4fc6881472561ed7fced.png]: https://img-blog.csdnimg.cn/e4846646819d4fc6881472561ed7fced.png
[bc9141b2af7c404893759bf1c5bf2452.png]: https://img-blog.csdnimg.cn/bc9141b2af7c404893759bf1c5bf2452.png
[Link 1]: https://www.xuxueli.com/xxl-job/
[https_mvnrepository.com_artifact_com.xuxueli_xxl-job-core]: https://mvnrepository.com/artifact/com.xuxueli/xxl-job-core
[https_github.com_xuxueli_xxl-job]: https://github.com/xuxueli/xxl-job
[88975e15bd2a49f6a2f3c229733ab84e.png]: https://img-blog.csdnimg.cn/88975e15bd2a49f6a2f3c229733ab84e.png
[2402c761d27345b9a8f85fedbf500b73.png]: https://img-blog.csdnimg.cn/2402c761d27345b9a8f85fedbf500b73.png
[http_127.0.0.1_30020_xxl-job-admin]: http://127.0.0.1:30020/xxl-job-admin/
[b3309cffe28748038f8819471792249c.png]: https://img-blog.csdnimg.cn/b3309cffe28748038f8819471792249c.png
[2c5fd3fb7fab448485bc26fcfcb90a98.png]: https://img-blog.csdnimg.cn/2c5fd3fb7fab448485bc26fcfcb90a98.png
[86d1f7353c5c4f04842b12b39edd383e.png]: https://img-blog.csdnimg.cn/86d1f7353c5c4f04842b12b39edd383e.png
[89c1e1e1c3571c47ad069bfcbcdd7d5d.png]: https://img-blog.csdnimg.cn/img_convert/89c1e1e1c3571c47ad069bfcbcdd7d5d.png
[XxlJob]: https://github.com/XxlJob
[8f3536de5d0245deb4d7562fe46c7442.png]: https://img-blog.csdnimg.cn/8f3536de5d0245deb4d7562fe46c7442.png
[60ff49cad95e48cf8e489efaa10339f3.png]: https://img-blog.csdnimg.cn/60ff49cad95e48cf8e489efaa10339f3.png
[e79bcb3ba86c424e9cd59483cb2c8d14.png]: https://img-blog.csdnimg.cn/e79bcb3ba86c424e9cd59483cb2c8d14.png
[1b0350bed37148c89994aabb72a4c841.png]: https://img-blog.csdnimg.cn/1b0350bed37148c89994aabb72a4c841.png
[1050c7507ad74bb2adc42d2a5d9d30d1.png]: https://img-blog.csdnimg.cn/1050c7507ad74bb2adc42d2a5d9d30d1.png
[c5599b5691354e1eb1481f90159739b3.png]: https://img-blog.csdnimg.cn/c5599b5691354e1eb1481f90159739b3.png
[a8665f10cebb41bd8998af8559ab592d.png]: https://img-blog.csdnimg.cn/a8665f10cebb41bd8998af8559ab592d.png
[Cron]: https://cron.qqe2.com/
[1f8d7833f10046ddb0893c3acbe14a2c.png]: https://img-blog.csdnimg.cn/1f8d7833f10046ddb0893c3acbe14a2c.png
[9884e731c4c3440ebe9a639eb2b51d44.png]: https://img-blog.csdnimg.cn/9884e731c4c3440ebe9a639eb2b51d44.png
[d4554fdd4b69452d9676794e3d4febaa.png]: https://img-blog.csdnimg.cn/d4554fdd4b69452d9676794e3d4febaa.png
[9356b4af6fe74b44a8e9a69ca2aa13bd.png]: https://img-blog.csdnimg.cn/9356b4af6fe74b44a8e9a69ca2aa13bd.png