Spring Boot 分布式任务 XXL-JOB

分布式任务 XXL-JOB

文档：https://www.xuxueli.com/xxl-job

代码：https://gitee.com/Don212/learning

一、简介

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

文档：文档地址

源码：Gitee 地址

源码：Github 地址

Maven 仓库地址：

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

二、快速入门

Spring Boot 集成 XXL-JOB 分为两步：

1. 配置运行调度中心 xxl-job-admin
2. 配置运行执行器项目 xxl-job-executor

下载项目源码并解压：

• xxl-job-admin：调度中心
• xxl-job-core：公共依赖
• xxl-job-executor-samples：执行器 Sample 示例
  • xxl-job-executor-sample-springboot：SpringBoot 版本，通过 SpringBoot 管理执行器，推荐
  • xxl-job-executor-sample-frameless：无框架版本

2.1 初始化调度数据库

执行脚本初始化调度数据库 xxl_job：

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

结果如下：

2.2 配置运行调度中心

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

2.2.1 配置调度中心

修改调度中心配置文件：

xxl-job-2.3.0\xxl-job-admin\src\main\resources\application.properties

调度中心配置文件:

### web
server.port=8080
server.servlet.context-path=/xxl-job-admin

### actuator
management.server.servlet.context-path=/actuator
management.health.mail.enabled=false

### resources
spring.mvc.servlet.load-on-startup=0
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/

### freemarker
spring.freemarker.templateLoaderPath=classpath:/templates/
spring.freemarker.suffix=.ftl
spring.freemarker.charset=UTF-8
spring.freemarker.request-context-attribute=request
spring.freemarker.settings.number_format=0.##########

### mybatis
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
#mybatis.type-aliases-package=com.xxl.job.admin.core.model

### xxl-job, datasource
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.cj.jdbc.Driver

### datasource-pool
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.maximum-pool-size=30
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.max-lifetime=900000
spring.datasource.hikari.connection-timeout=10000
spring.datasource.hikari.connection-test-query=SELECT 1
spring.datasource.hikari.validation-timeout=1000

### xxl-job, email 报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.from=xxx@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

### xxl-job, access token 调度中心通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=

### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
xxl.job.i18n=zh_CN

## xxl-job, triggerpool max size 调度线程池最大线程配置【必填】
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

### xxl-job, log retention days 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
xxl.job.logretentiondays=30

主要是修改数据源信息，若需要用到邮件报警功能，需要配置邮箱。

2.2.2 运行调度中心

配置完成后，启动项目！

调度中心访问地址：http://localhost:8080/xxl-job-admin （该地址执行器将会使用到，作为回调地址）

默认登录账号 admin/123456 ，登录界面如下：

到此为止，第一阶段调度中心的部署就完成啦！！

2.2.3 调度中心集群（可选）

调度中心支持集群部署，提升调度系统容灾和可用性。

调度中心集群部署时，几点要求和建议：

• DB配置保持一致；
• 集群机器时钟保持一致（单机集群忽视）；
• 建议：推荐通过 nginx 为调度中心集群做负载均衡，分配域名。调度中心访问、执行器回调配置、调用API服务等操作均通过该域名进行。

2.3 配置运行执行器项目

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

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

2.3.1 引入 Maven 依赖

<!-- XXL-JOB 分布式任务调度平台 -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.0</version>
</dependency>

注意：此处版本要与 xxl-job-admin 中版本保持一致！！

2.3.2 配置执行器

配置文件 application.yml 中配置 xxl-job 执行器的相关参数！！

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

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

2.3.3 配置执行器组件

创建 XxlJobConfiguration 配置类，会从配置文件中读取到对应的参数，接着申明一个 xxlJobExecutor 方法，返回的是一个 XxlJobSpringExecutor，这个方法主要是如何初始化并创建一个 XxlJobSpringExecutor。

/**
 * XXL-JOB 分布式任务调度 配置
 *
 * @author Don
 * @date 2022/05/18
 */
@Configuration
public class XxlJobConfig {
    private final Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);

    @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() {
        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;
    }

}

2.3.4 运行执行器项目

项目编译打包成 Spring Boot 类型的可执行 JAR 包，命令启动即可~

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

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

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

2.4 编写定时任务 JobHandler

定时任务有多种写法，参考文档！！

2.4.1 BEAN 模式（方法形式）

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

优点：

• 每个任务只需要开发一个方法，并添加 @XxlJob 注解即可，更加方便、快速。
• 支持自动扫描任务并注入到执行器容器。

缺点：

• 要求 Spring 容器环境

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

1、任务开发：在 Spring Bean 实例中，开发 Job 方法

2、注解配置：为 Job 方法添加注解，注解 value 值对应的是调度中心新建任务的 JobHandler 属性的值

@XxlJob(value="自定义jobhandler名称", init="初始化方法", destroy="销毁方法")

3、执行日志：需要通过 XxlJobHelper.log 打印执行日志

4、任务结果：默认任务结果为 “成功” 状态，不需要主动设置；如有诉求，比如设置任务结果为失败，可以通过 XxlJobHelper.handleFail/handleSuccess 自主设置任务结果

示例：

import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;


/**
 * bean方法模式 JobHandler
 *
 * @author Don
 * @date 2022/05/18
 */
@Component
public class BeanMethodJobHandler {

    @XxlJob("beanMethodJobHandler")
    public void beanMethodJobHandler() {

        XxlJobHelper.log("beanMethodJobHandler begin ..");

        String jobParam = XxlJobHelper.getJobParam();

        System.out.println("jobParam : " + jobParam);
        System.out.println("Hello XXL-JOB");

        XxlJobHelper.log("beanMethodJobHandler end ..");
    }

}

启动程序。再回到 admin 管理页配置调度任务！！

启动项目后，可以在调度中心看到自动注册了执行器：

2.4.2 调度中心配置调度任务

新建的任务进行参数配置，运行模式选中 “BEAN模式”，JobHandler 属性填写任务注解 @XxlJob 中定义的值：

配置完成如下：

操作执行一次 ，在调度日志中查看到执行的历史：

查看控制台打印：

文档：https://www.xuxueli.com/xxl-job

代码：https://gitee.com/Don212/learning