Spring Boot 整合 xxl-job 保姆级教程！

news2024/11/25 20:16:17

文章目录

- 介绍
- 使用
- - 初始化“调度数据库”
  - 配置调度中心
  - 配置“执行器项目”
  - 调度任务

介绍

首先我们介绍一下什么是xxl-job，根据官方定义，XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。

xxl-job相对于其他的一些任务调度平台主要有以下特性：

1、简单：支持通过Web页面对任务进行CRUD操作，操作简单，一分钟上手；

2、动态：支持动态修改任务状态、启动/停止任务，以及终止运行中任务，即时生效；

3、调度中心HA（中心式）：调度采用中心式设计，“调度中心”自研调度组件并支持集群部署，可保证调度中心HA；

4、执行器HA（分布式）：任务分布式执行，任务”执行器”支持集群部署，可保证任务执行HA；

5、弹性扩容缩容：一旦有新执行器机器上线或者下线，下次调度时将会重新分配任务；

6、触发策略：提供丰富的任务触发策略，包括：Cron触发、固定间隔触发、固定延时触发、API（事件）触发、人工触发、父子任务触发；

7、调度过期策略：调度中心错过调度时间的补偿处理策略，包括：忽略、立即补偿触发一次等；

8、阻塞处理策略：调度过于密集执行器来不及处理时的处理策略，策略包括：单机串行（默认）、丢弃后续调度、覆盖之前调度；

9、任务超时控制：支持自定义任务超时时间，任务运行超时将会主动中断任务；

10、任务失败重试：支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；其中分片任务支持分片粒度的失败重试；

11、任务失败告警；默认提供邮件方式失败告警，同时预留扩展接口，可方便的扩展短信、钉钉等告警方式；

…

具体的一些特性可以见 xxl-job官方网站

使用

下面来介绍一下在Spring Boot项目中如何使用 xxl-job。

首先我们需要下载xxl-job源码：

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

这里我采用git的方式，克隆源码：

git clone https://github.com/xuxueli/xxl-job.git

下载完成或者克隆完成之后，我们使用idea打开项目。

在这里插入图片描述

我们可以看到，主要有三个模块，其功能分别是

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

下面主要分为三步，来整合xxl-job。

初始化“调度数据库”

在这里插入图片描述

运行doc/db下的sql文件，创建数据库，可以通过Navicat的脚本运行功能进行运行。

配置调度中心

接下来我们打开xxl-job-admin模块，打开/xxl-job/xxl-job-admin/src/main/resources/application.properties配置文件。

主要是更改一下数据库的配置，将数据库的配置信息改为自己的配置信息

在这里插入图片描述

其他的配置可以选择性配置，比如报警邮件，数据库连接池，端口等等，这些配置使用默认也可以，其配置说明如下。

### 调度中心JDBC链接：链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
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.jdbc.Driver
### 报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=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
### 调度中心通讯TOKEN [选填]：非空时启用；
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

配置文件配置完成之后，我们启动该模块的项目。

在这里插入图片描述

找到启动类，直接启动。

然后在浏览器中输入调度中心访问地址：http://localhost:8080/xxl-job-admin (该地址执行器将会使用到，作为回调地址)

默认登录账号 “admin/123456”, 登录后运行界面如下图所示。

在这里插入图片描述

此时调度中心项目就启动成功了，这个调度中心项目可以作为一个独立的项目运行，不用和业务项目在一起。

配置“执行器项目”

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

此时我们新建一个项目，用来当作执行器项目，执行器项目可以集成到业务项目中，我们采用集成到业务项目中的方式。

我们新建一个名为xxl-demo的Spring Boot项目作为我们的业务项目，然后在其中加入执行器。可以参考xxl-job-executor-sample-springboot。具体创建项目的过程就不写了。

我们给自己的项目添加依赖，主要是加入xxl-job的依赖，依赖的仓库地址如下：

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

然后我们将xxl-job-executor-sample-springboot中的代码复制到自己的项目中。

在这里插入图片描述

然后我们打开配置文件进行配置，这里我使用的是yaml格式的配置文件。

server:
  port: 8081
logging:
  config: classpath:logback.xml
xxl:
  job:
    admin:
      addresses: http://127.0.0.1:8080/xxl-job-admin ### 地址填我们的调度中心的地址
    accessToken: default_token
    executor:
      appname: xxl-job-executor-sample ### 这个名称可以自定义，称为执行器的名称
      address:
      ip:
      port: 9999 ### 端口要填，为了调度中心调度使用
      logpath: ./logs/xxl-job-executor-sample
      logretentiondays: 30