springboot整合XXL-JOB实行动态定时任务

·  阅读 1354
springboot整合XXL-JOB实行动态定时任务

春才刚到,忽而夏至——南方


前言

定时任务,相信很多人都用过吧?方法无非就是那几种而已,也有很多人写出了各式各样的框架,比如XXL-JOB

XXL-JOB出自大众点评,是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展、开箱即用

官方文档地址:点击此处访问官方文档

下载xxlJob

  • 源码仓库地址
  1. github地址下载地址
  2. gitee地址下载地址
  • 中央仓库地址
 <!-- http://repo1.maven.org/maven2/com/xuxueli/xxl-job-core/ -->
 <dependency>
     <groupId>com.xuxueli</groupId>
     <artifactId>xxl-job-core</artifactId>
     <version>${最新稳定版本}</version>
 </dependency>
  • 运行环境:
  • Maven3+
  • Jdk1.8+
  • Mysql5.7+

部署

  • 下载项目源码并解压至自己电脑的项目文件夹下
  • 初始化数据库,数据库文件位于项目目录的doc/db下,如图所示:

image-20220513205857912

  • 修改配置文件,文件位置:/xxl-job/xxl-job-admin/src/main/resources/application.properties

image-20220513210118830

需要修改配置文件中的数据库账号密码,填写报警邮箱等信息(如果你需要的话...)

  • 此时就可以点击xxl-job-admin模块的main方法进行运行,亦或者打包成jar使用cmd运行

访问地址:http://localhost:8080/xxl-job-admin,默认登录账号 “admin/123456”, 登录后运行界面如下图所示:

image-20220513210601141

至此“调度中心”项目已经部署成功

使用

  • 新建springboot项目,步骤至此省略......如有不会请移步创建第一个SpringBoot项目
  • 引入 “xxl-job-core” 的maven依赖
  • 编写相关配置文件,文件参考地址:/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties

image-20220513211150729

在自己的项目中根据自己的需要,写好相关配置,我就直接使用官方自带的示例代码了......

  • 配置配置文件,文件地址:/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java

即如下图所示:

image-20220513211510913

  • 编写定时任务,如下所示是一个简单的定时任务,嗯...也是扒拉的官方源代码,代码就在controller下
 @Component
 public class SampleXxlJob {
     private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);
 ​
     /**
      * 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);
             System.out.println(i);
             TimeUnit.SECONDS.sleep(2);
         }
     }
 }
  • 启动项目
  • 在上面的调度中心配置我们的定时任务
  1. 新增执行器,即如下图所示,填入相关信息即可

image-20220513212013811

  1. 新增任务,填入定时任务相关信息

注意:JobHandler参数与定时任务上@XxlJob("demoJobHandler")注解的名字要一致,不然找不到定时任务......

image-20220513212125325

  1. 执行任务

如图所示,执行一次我们刚刚编写好的定时任务

image-20220513212644453

控制台会出现如此打印即表示调用成功

image-20220513212900345

  • 注意事项

关于传参的问题,在定时任务的创建和执行一次调用的时候都会有任务参数的填写,这就是我们需要传递到代码中的参数。

关于接收参数的问题,在2.3.0版本及其以上的参数接收发生了改变,用以下方式进行接收参数,且只能传递String类型,如果是其它类型参数,需要自己在代码中进行对应的转换

 String param = XxlJobHelper.getJobParam(); // 接收参数代码

结语

如今各种定时任务管理框架应运而生,我们管理定时任务也越来越简单,只需要简单的配置,简单的点击即可运行,甚至还有各种监控报警,邮件通知功能,再也不需要我们时刻关注了......

分类:
后端
标签:
分类:
后端
标签:
收藏成功!
已添加到「」, 点击更改