Springboot整合xxl-job 胎教

第一步

gitee xxl-job地址

第二步 : 运行xxl-job sql脚本

第三步 : 修改配置文件

第四步 : 打包运行或者直接启动 xxl-job-admin 模块

启动后访问地址

第五步 : 创建springboot项目引入所需jar包

<!--    xxljob     -->
        <dependency>
            <groupId>com.xuxueli</groupId>
            <artifactId>xxl-job-core</artifactId>
            <version>2.2.0</version>
        </dependency>

项目结构

第六步 : application配置

# xxl-job配置
xxl:
  job:
    admin:
      # 之前启动的xxl-job访问地址
      addresses: http://127.0.0.1:8080/xxl-job-admin
    executor:
      # 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
      address:
      # 执行器管理AppName
      appname: xxl-job-executor-sample
      # 执行器IP [选填]：默认不填 
      ip:
      # 执行器端口号 [选填]：默认端口为9999
      port: 9999
      # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
      logpath: /Users/luoyu/Documents/log/xxl-job/jobhandler
      # 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
      logretentiondays: 15
    # 执行器通讯TOKEN [选填]：非空时启用；
    accessToken:

第七步 : config配置类

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

/**
 * TODO
 *
 * @author Csy
 * @version 1.0
 * @date 2022/1/24 11:15
 */
@Slf4j
@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() {
        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;
    }
}

第八步 : 编写测试类和启动类

import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import com.xxl.job.core.log.XxlJobLogger;
import groovy.util.logging.Slf4j;
import org.springframework.stereotype.Component;

/**
 * TODO
 *
 * @author Csy
 * @version 1.0
 * @date 2022/1/24 11:43
 */
@Slf4j
@Component
public class XxlJobService {

    @XxlJob("testJobHandler")
    public ReturnT<String> demoJobHandler(String param) {
        XxlJobLogger.log("demoJobHandler，开始执行...");
        for (int i = 0; i < 10; i++) {
            XxlJobLogger.log("demoJobHandler，执行中 {} ...", i);
        }
        XxlJobLogger.log("demoJobHandler，执行结束...");
        return ReturnT.SUCCESS;
    }

}

启动类别写好即可启动

第九步 : 创建定时调度任务

打开之前启动的xxl-job页面

第十步 : 执行器管理获取ONLine地址

如果保存后没有显示地址则手动录入
手动录入内容 本机IP:9999
9999就之前配置文件中的

第十步 : 运行定时任务