轻松掌握SpringBoot集成XXL-Job，助你搞定定时任务！

2023-12-15 06:32:05

利用 XXL-Job 在 SpringBoot 中无缝调度任务

在现代软件开发中，定时任务是自动化重复性任务和提高工作效率的关键。Spring Boot 是一个广受欢迎的 Java 框架，而 XXL-Job 则是一个强大的分布式任务调度框架。通过将 XXL-Job 集成到 Spring Boot 中，您可以解锁各种优势，例如分布式任务调度、任务执行报告和监控。

集成 XXL-Job 到 SpringBoot

集成 XXL-Job 到 SpringBoot 只需几个简单的步骤：

添加依赖项：

<dependency>
    <groupId>com.xxl.job</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.4.0</version>
</dependency>
<dependency>
    <groupId>com.xxl.job</groupId>
    <artifactId>xxl-job-executor</artifactId>
    <version>2.4.0</version>
</dependency>

配置 XXL-Job：

在 application.yml 中添加以下配置：

xxl:
  job:
    admin:
      addresses: http://127.0.0.1:8080/xxl-job-admin
    executor:
      appname: xxl-job-executor
      address: http://127.0.0.1:9999
      ip: 127.0.0.1
      port: 9999
      logpath: /data/applogs/xxl-job/jobhandler
      logretentiondays: 30

创建定时任务类：

创建一个继承自 com.xxl.job.core.handler.IJobHandler 接口并实现 execute 方法的定时任务类。execute 方法是定时任务的核心，用于编写要执行的任务代码。

public class MyJobHandler implements IJobHandler {

    @Override
    public ReturnT<String> execute(String param) throws Exception {
        // 在这里编写定时任务要执行的代码
        System.out.println("定时任务执行成功！");
        return ReturnT.SUCCESS;
    }
}

注册定时任务：

在 SpringBoot 应用程序启动时，通过 @PostConstruct 方法注册定时任务：

@PostConstruct
public void init() {
    JobInfo jobInfo = new JobInfo();
    jobInfo.setJobGroup(1);
    jobInfo.setJobCron("0/5 * * * * ?");
    jobInfo.setJobDescription("我的定时任务");
    jobInfo.setExecutorHandler("myJobHandler");
    XXLJobRegistrar.registerJob(jobInfo);
}

示例演示

下面是一个使用 XXL-Job 调度定时任务的示例：

启动 SpringBoot 应用程序：
```
mvn spring-boot:run
```
访问 XXL-Job 管理界面：

在浏览器中访问 http://127.0.0.1:8080/xxl-job-admin 以进入 XXL-Job 管理界面。
创建定时任务：

点击 "任务管理" 菜单，然后点击 "添加任务" 按钮。填写定时任务详细信息，例如任务组、任务名称、任务、CRON 表达式和任务执行器名称。
启动定时任务：

创建任务后，点击 "启动" 按钮启动定时任务。
查看执行结果：

点击 "任务列表" 菜单查看所有定时任务的执行结果。