springboot整合 xxl-job

Spring Boot整合XXL-JOB实现定时任务

在现代应用开发中，定时任务是非常常见的需求。它可以用于数据清理、定时报告、定时数据同步等场景。XXL-JOB是一个轻量级的 Java 分布式任务调度框架，支持简单易用的任务管理和监控，并且能够很好地与Spring Boot整合。本文将介绍如何在Spring Boot项目中整合XXL-JOB，并实现一个简单的定时任务。

1. Maven依赖

首先，在Spring Boot项目的pom.xml中添加XXL-JOB的依赖。请注意替换版本号为最新的稳定版本。

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

2. 配置XXL-JOB

在application.yml配置文件中，添加XXL-JOB的相关配置。

xxl:
  job:
    admin:
      addresses: http://localhost:8080/xxl-job-admin # XXL-JOB admin 地址
    executor:
      appname: xxl-job-executor-sample  # 执行器名称
      address: http://localhost:9999/xxl-job-executor-sample  # 执行器地址
      ip: 127.0.0.1   # 执行器IP
      port: 9999      # 执行器端口
      logpath: /data/applogs/xxl-job    # 执行器日志路径
      logretentiondays: 30               # 日志保存天数

3. 创建XXL-JOB执行器

接着，我们需要创建一个执行器类，该类将包含我们的定时任务逻辑。我们可以通过实现XXLJob接口来创建任务。

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

@Component
public class MyJobHandler {

    @XxlJob("myJobHandler")
    public void execute() {
        // 任务的具体逻辑
        System.out.println("执行定时任务...");
        // 这里可以加入具体的业务逻辑，比如数据清理等
    }
}

4. 调整Spring Boot启动类

为了确保XXL-JOB能够正常工作，我们需要在Spring Boot的启动类上添加注解。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.JobHandler;

@SpringBootApplication
public class MyApplication {

    public static void main(String[] args) {
        SpringApplication.run(MyApplication.class, args);
    }

    @Bean
    public IJobHandler myJobHandler() {
        return new MyJobHandler();
    }
}

5. 启动XXL-JOB Admin

在我们测试定时任务之前，需要启动XXL-JOB Admin。可以从XXL-JOB GitHub页面下载并启动Admin的Spring Boot项目。

6. 在Admin控制台配置定时任务

1. 登录 XXl-JOB Admin 控制台（默认为 http://localhost:8080/xxl-job-admin）。
2. 创建新的任务，填写任务名称、执行器（选择我们刚才创建的xxl-job-executor-sample）、执行器任务handler（填写myJobHandler），设置 CRON 表达式以指定任务执行频率。
3. 保存并启动任务。

7. 观察任务执行

在控制台上，你可以看到任务的执行情况与日志输出。定时任务将按照你设置的频率自动执行。

总结

通过以上步骤，我们成功地将XXL-JOB与Spring Boot整合，实现了一个简单的定时任务。XXL-JOB的强大之处在于它不仅简化了定时任务的管理与监控，还提供了丰富的功能和灵活的调度策略，适合各类项目的需求。希望本文能够帮助你更好地理解如何在Spring Boot项目中使用XXL-JOB，实现高效的定时任务管理。