SpringBoot 整合 xxl-job

2024-09-30后端2 分钟218 次阅读
AI 摘要salmon-ai

本文介绍了如何将 xxl-job 与 SpringBoot 整合,

前言

在微服务和分布式系统中,任务调度是一个重要的功能。无论是定时任务、批处理任务,还是分布式任务,如何高效、稳定地调度和管理任务对于系统的性能和扩展性至关重要。xxl-job 作为一款轻量级的分布式任务调度平台,具有简单易用、支持分布式、丰富的任务管理功能,成为越来越多开发者的首选。

官方文档:https://www.xuxueli.com/xxl-job/

接下来我将通过整合 xxl-job 与 SpringBoot,展示如何快速搭建并使用一个支持分布式的任务调度系统,帮助你更高效地管理和调度任务。

本地环境准备

部署 xxl-job,可以参考官方文档或者我的文章:https://blog.salmonedu.ltd/articles/458

依赖

xml 复制代码
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.4.0</version>
</dependency>

配置文件

application.yml

yml 复制代码
# xxl-job 定时任务配置
xxl:
  job:
    admin:
      # 多个地址使用,分割
      addresses: ${xxl.admin_address}
    accessToken: default_token
    executor:
      appName: xxl-job-executor-${spring.application.name}
      address: ${xxl.address}
      ip: ${xxl.ip}
      port: ${xxl.port}
      logPath: ${xxl.logPath}
      logRetentionDays: 30

application-dev.yml

yml 复制代码
# xxl-job 配置
xxl:
  admin_address: http://192.168.2.69:8181/xxl-job-admin
  address: null
  ip: 192.168.2.69
  port: 9999
  logPath: ./xxl/logs/xxl-job/handler

application-prod.yml

yml 复制代码
# xxl-job 配置
xxl:
  admin_address: http://xxxxxx:8181/xxl-job-admin
  address: null
  ip: xxxxxx
  port: xxxxxx
  logPath: ./xxl/logs/xxl-job/handler

注意:地址不能为127.0.0.1,必须为当前主机的网络地址,如:192.168.2.69,下面是踩坑记录:image.png

自动装配配置

java 复制代码
package com.salmon.wallpaper.config.xxl;


import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import lombok.Data;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * xxl-job 配置
 *
 * @author Salmon
 * @since 2024-09-30
 */
@Configuration
@Slf4j
@Data
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 Integer port;

    @Value("${xxl.job.executor.logPath}")
    private String logPath;

    @Value("${xxl.job.executor.logRetentionDays}")
    private Integer logRetentionDays;

    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        log.info(">>>>>>>>>>> xxl-job config init.");
        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;
    }

}

执行器注册查看

启动 SpringBoot 工程之后,前往调度中心查看执行器注册结果,这里我的没有自动注册(大概率是网络环境的问题),我手动注册下:
image.png

定时任务测试

添加测试任务

在项目中添加名为 demoJobHandler 的任务处理器(Bean模式)

java 复制代码
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

/**
 * xxl-job 测试
 *
 * @author Salmon
 * @since 2024-09-30
 */
@Component
@Slf4j
public class XxlJobSampleHandler {

    @XxlJob("demoJobHandler")
    public void demoJobHandler() {
        log.info("XXL-JOB, Hello World.");
    }
}

配置定时任务

调度中心新增测试任务,运行模式为 BEAN , 任务处理器为 demoJobHandler
image.png

启动定时任务

image.png

测试结果

查看运行日志,可以看到成功执行,频率为1s执行一次
image.png
这是在线日志查看
image.png
这是生成的日志目录
image.png

觉得有用就点个赞,不用登录也能读

评论

0 条
登录 之后才能评论
—
还没有评论,来说第一句