SpringBoot整合xxl-job实现定时任务

一口酥Hac

已于 2025-02-25 21:43:44 修改

阅读量2.1k

点赞数 45

分类专栏： java 文章标签： spring boot 后端 java

于 2024-05-19 14:23:51 首次发布

本文链接：https://blog.csdn.net/m0_64289188/article/details/139040904

版权

java 专栏收录该内容

53 篇文章

订阅专栏

文章目录

概要

XXL-Job 是一个分布式任务调度平台，它提供了可视化的任务管理界面和强大的任务调度功能。XXL-Job 可以用于管理和调度各种定时任务、数据处理任务等。

XXL-Job 与 Spring Task 的区别和优势：

分布式支持：相比于 Spring Task，XXL-JOB具有更强的分布式支持和可扩展性。它适用于复杂的分布式系统和大规模任务管理场景。
可视化管理：XXL-JOB提供了任务的可视化管理界面，方便配置和监控。
动态修改任务状态：XXL-JOB支持动态修改任务状态、启动/停止任务，以及终止运行中的任务，即时生效。
执行器HA（分布式）：XXL-JOB支持任务分布式执行，执行器支持集群部署，可保证任务执行的高可用性。
注册中心：执行器会周期性自动注册任务，调度中心将自动发现注册的任务并触发执行。

配置启动xxl-job-admin项目

下载xxl-job: 官方GitHub地址

第一步：从 GitHub 上下载 XXL-Job 项目，用IDEA打开，配置xxl-job-admin，修改配置文件 application.properties(配置数据库连接信息)
在这里插入图片描述

第二步：启动xxl-job-admin项目

游览器访问：http://localhost:8080/xxl-job-admin

在这里插入图片描述

SpringBoot 中整合 XXL-Job

一、引入依赖

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

二、application.yml配置 XXL-Job 的相关信息

注意 application.yml 中

xxl:
  job:
    accessToken: default_token

要和 \xxl-job-admin\src\main\resources\application.properties 这个配置文件中的保持一致
在这里插入图片描述

server:
  port: 8888

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://192.168.113.231:3306/order?useUnicode=true&characterEncoding=utf8&autoReconnect=true&allowMultiQueries=true&useSSL=false
    username: root
    password: root

xxl:
  job:
    accessToken: default_token
    admin:  # 管理后台的配置
      addresses: http://127.0.0.1:8080/xxl-job-admin

    executor:  # 执行器相关的配置
      address: ''
      appname: appname-hac
      ip: ''
      logpath: /data/applogs/xxl-job/jobhandler
      logretentiondays: 30
      port: 9999

在这个 XXL-Job 的配置中，address 和 port 是 Executor【执行器】的配置项，用于指定 Executor 的地址和端口号。

address: ''：
这里的空字符串表示 Executor 的地址为空，意味着 Executor 将会使用本机的 IP 地址。这通常是指定 Executor 与 XXL-Job Admin 的通信地址。如果你希望 Executor 使用本机的 IP 地址，则可以保留这个配置为空字符串。如果要指定特定的 IP 地址，可以在 address 中填写相应的 IP 地址。

port: 9999：
这个配置项指定了 Executor 的监听端口号，即 Executor 启动后会监听的端口。在这个例子中，Executor 将会监听 9999 端口。这个端口号通常用于 Executor 提供的 HTTP API 接口，用于接收 XXL-Job Admin 分配的任务并执行。在 XXL-Job Admin 中配置的执行器的地址和端口号需要与 Executor 的配置保持一致，以确保 Admin 能够正确地与 Executor 通信。

总之，address 和 port 的配置是用于指定 Executor 与 xxl-job-admin 之间通信的地址和端口信息。

三、编写配置类

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

四、编写定时任务

@Component
public class TestTask {
    public static int i=0;
    @XxlJob(value = "test")
    public void test(){
        System.out.println("定时任务:"+(i++));
    }
}