SpringBoot结合XXL-JOB实现定时任务

墨蓝 2023-09-23 23:58 45阅读 0赞

《从零打造项目》系列文章

> 工具
> 
>  *  [比MyBatis Generator更强大的代码生成器][MyBatis Generator]
> 
> ORM框架选型
> 
>  *  [SpringBoot项目基础设施搭建][SpringBoot]
>  *  [SpringBoot集成Mybatis项目实操][SpringBoot_Mybatis]
>  *  [SpringBoot集成Mybatis Plus项目实操][SpringBoot_Mybatis Plus]
>  *  [SpringBoot集成Spring Data JPA项目实操][SpringBoot_Spring Data JPA]
> 
> 数据库变更管理
> 
>  *  [数据库变更管理：Liquibase or Flyway][Liquibase or Flyway]
>  *  [SpringBoot结合Liquibase实现数据库变更管理][SpringBoot_Liquibase]
> 
> 定时任务框架
> 
>  *  [Java定时任务技术分析][Java]
>  *  [SpringBoot结合Quartz实现定时任务][SpringBoot_Quartz]
>  *  [SpringBoot结合XXL-JOB实现定时任务][SpringBoot_XXL-JOB]
> 
> 缓存
> 
>  *  [Spring Security结合Redis实现缓存功能][Spring Security_Redis]
> 
> 安全框架
> 
>  *  [Java应用程序安全框架][Java 1]
>  *  [Spring Security系列文章][Spring Security]
>  *  [Spring Security结合JWT实现认证与授权][Spring Security_JWT]
> 
> 开发规范
> 
>  *  [后端必知：遵循Google Java规范并引入checkstyle检查][Google Java_checkstyle]

## 前言 ##

上篇文章我们介绍了 Quartz 的使用，当时实现了两个简单的需求，不过最后我们总结的时候也提到 Quartz 有不少缺点，代码侵入太严重，所以本篇将介绍 xxl-job 这个定时任务框架。

### Quartz的不足 ###

Quartz 的不足：Quartz 作为开源任务调度中的佼佼者，是任务调度的首选。但是在集群环境中，Quartz采用API的方式对任务进行管理，这样存在以下问题：

*  通过调用API的方式操作任务，不人性化。
 *  需要持久化业务的 QuartzJobBean 到底层数据表中，系统侵入性相当严重。
 *  调度逻辑和QuartzJobBean耦合在同一个项目中，这将导致一个问题，在调度任务数量逐渐增多，同时调度任务逻辑逐渐加重的情况下，此时调度系统的性能将大大受限于业务。

### Xxl-job介绍 ###

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

通俗来讲：XXL-JOB 是一个任务调度框架，通过引入 XXL-JOB 相关的依赖，按照相关格式撰写代码后，可在其可视化界面进行任务的启动，执行，中止以及包含了日志记录与查询和任务状态监控。

更多详细介绍推荐阅读[官方文档][Link 1]。

## 项目实践 ##

### Spring Boot集成XXL-JOB ###

Spring Boot 集成 XXL-JOB 主要分为以下两步：

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

xxl-job-admin 可以从源码仓库中下载代码，代码地址有两个：

1.  GitHub：[github.com/xuxueli/xxl…][github.com_xuxueli_xxl]
2.  Gitee：[gitee.com/xuxueli0323…][gitee.com_xuxueli0323]

![image\_d5911b2b.png][image_d5911b2b.png]

下载完之后，在 `doc/db` 目录下有数据库脚本 `tables_xxl_job.sql`，执行下脚本初始化调度数据库 `xxl_job`，如下图所示：

![image\_5db1afcc.png][image_5db1afcc.png]

### 配置调度中心 ###

将下载的源码解压，用 IDEA 打开，我们需要修改一下 xxl-job-admin 中的一些配置。（我这里下载的是最新版 2.3.1）

1、修改 application.properties，主要是配置一下 datasource 以及 email，其他不需要改变。

### 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
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    
    
    ### xxl-job, email
    spring.mail.host=smtp.qq.com
    spring.mail.port=25
    spring.mail.username=1739468244@qq.com
    spring.mail.from=1739468244@qq.com
    # 此处不是邮箱登录密码，而是开启SMTP服务后的授权码
    spring.mail.password=xxxxx

2、修改 logback.xml，配置日志输出路径，我是在解压的 xxl-job-2.3.1 项目包中新建了一个 logs 文件夹。

然后启动项目，正常启动后，访问地址为：[http://localhost:8080/xxl-job-admin，默认的账户为][http_localhost_8080_xxl-job-admin] admin，密码为 123456，访问后台管理系统后台。

这样就表示调度中心已经搞定了，下一步就是创建执行器项目。

### 创建执行器项目 ###

本项目与 Quartz 项目用的业务表和业务逻辑都一样，所以引入的依赖会比较多。

#### 环境配置 ####

1、引入依赖：

<parent>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-parent</artifactId>
      <version>2.6.3</version>
      <relativePath/>
    </parent>
    
    <properties>
      <java.version>1.8</java.version>
      <fastjson.version>1.2.73</fastjson.version>
      <hutool.version>5.5.1</hutool.version>
      <mysql.version>8.0.19</mysql.version>
      <org.mapstruct.version>1.4.2.Final</org.mapstruct.version>
      <org.projectlombok.version>1.18.20</org.projectlombok.version>
      <druid.version>1.1.18</druid.version>
      <springdoc.version>1.6.9</springdoc.version>
    </properties>
    
    <dependencies>
      <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
    
      <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-aop</artifactId>
      </dependency>
      <dependency>
        <groupId>com.xuxueli</groupId>
        <artifactId>xxl-job-core</artifactId>
        <version>2.3.1</version>
      </dependency>
    
      <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.1</version>
      </dependency>
      <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>3.5.1</version>
      </dependency>
      <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector

[MyBatis Generator]: https://juejin.cn/post/6952520736720289805
[SpringBoot]: https://juejin.cn/post/7166760176899325988
[SpringBoot_Mybatis]: https://juejin.cn/post/7168245119022268430
[SpringBoot_Mybatis Plus]: https://juejin.cn/post/7168731998549671967
[SpringBoot_Spring Data JPA]: https://juejin.cn/post/7169472183184719886
[Liquibase or Flyway]: https://juejin.cn/post/7170857098538909732/
[SpringBoot_Liquibase]: https://juejin.cn/post/7171232605478584328/
[Java]: https://juejin.cn/post/7171604341437136909
[SpringBoot_Quartz]: https://juejin.cn/post/7171955839517851678/
[SpringBoot_XXL-JOB]: https://juejin.cn/post/7172325382320816165
[Spring Security_Redis]: https://juejin.cn/post/7177188004677550141
[Java 1]: https://juejin.cn/post/7173443126550822925
[Spring Security]: https://juejin.cn/post/7173833497830752286/
[Spring Security_JWT]: https://juejin.cn/post/7176803095525982269
[Google Java_checkstyle]: https://juejin.cn/post/7178683426852044858/
[Link 1]: https://link.juejin.cn?target=https%3A%2F%2Fwww.xuxueli.com%2Fxxl-job%2F
[github.com_xuxueli_xxl]: https://link.juejin.cn?target=https%3A%2F%2Flink.zhihu.com%2F%3Ftarget%3Dhttps%253A%2F%2Fgithub.com%2Fxuxueli%2Fxxl-job
[gitee.com_xuxueli0323]: https://link.juejin.cn?target=https%3A%2F%2Flink.zhihu.com%2F%3Ftarget%3Dhttp%253A%2F%2Fgitee.com%2Fxuxueli0323%2Fxxl-job
[image_d5911b2b.png]: https://img-blog.csdnimg.cn/img_convert/30e97bdc931a61c266f1654923fc664e.png
[image_5db1afcc.png]: https://img-blog.csdnimg.cn/img_convert/b6ab01d38ebe546900f4f86f42ed77ea.png
[http_localhost_8080_xxl-job-admin]: https://link.juejin.cn?target=http%3A%2F%2Flocalhost%3A8080%2Fxxl-job-admin%25EF%25BC%258C%25E9%25BB%2598%25E8%25AE%25A4%25E7%259A%2584%25E8%25B4%25A6%25E6%2588%25B7%25E4%25B8%25BA