项目中使用SpringBoot项目集成xxljob学习记录

最新推荐文章于 2024-10-04 11:32:14 发布

admin78

最新推荐文章于 2024-10-04 11:32:14 发布

阅读量100

点赞数

文章标签： spring boot 学习 java

本文链接：https://blog.csdn.net/admin78/article/details/128384389

版权

XXL-JOB是一个轻量级的分布式任务调度平台，具备易用、扩展性强等特点。本文介绍了如何在项目中配置XXL-JOB，包括引入依赖、配置文件设置、编写配置类以及创建和编写业务Job代码。通过这些步骤，可以快速集成并使用XXL-JOB进行任务调度。

摘要由CSDN通过智能技术生成

xxljob

xxljob介绍

XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。

xxljob地址

    https://www.xuxueli.com/page/projects.html

xxljob优点特性如下：

在这里插入图片描述

代码配置过程

1.引入xxl-job的依赖

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

2.编写配置文件

xxl:
  job:
    admin:
      addresses: http://d-xxljob.dmsd.tech:8081/job-admin-dev  #xxljob调度中心部署  例如：http://127.0.0.1:8080/xxl-job-admin
    executor:
      appname: testJob #xxljob配置的执行器名称，
      ip:             #执行器IP，默认为空表示自动获取IP
      port: 9999 #xxljob配置的端口号，默认为9999
      logpath: /data/xxl-job/jobhandler  #执行器运行日志文件存储磁盘路径
      logretentiondays: -1  #调度中心日志表数据保存天数，过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能
    accessToken: #调度中心通讯TOKEN [选填]：非空时启用

3. 编写配置类

@Configuration
@ComponentScan(basePackages = "com.dmsdbj.integral.zentao.provider.job")//配置需要扫描的job类
@Slf4j
public class XxlJobConfig {
 
    @Value("${xxl.job.admin.addresses}")
    private String adminAddresses;
 
    @Value("${xxl.job.executor.appname}")
    private String appName;
 
    @Value("${xxl.job.executor.ip}")
    private String ip;
 
    @Value("${xxl.job.executor.port}")
    private int port;
 
    @Value("${xxl.job.accessToken}")
    private String accessToken;
 
    @Value("${xxl.job.executor.logpath}")
    private String logPath;
 
    @Value("${xxl.job.executor.logretentiondays}")
    private int logRetentionDays;
 
 
 
    @Bean(initMethod = "start", destroyMethod = "destroy")
    public XxlJobSpringExecutor xxlJobExecutor() {
        log.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
        xxlJobSpringExecutor.setAppName(appName);
        xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
 
        return xxlJobSpringExecutor;
    }
 
}

4.新建Job文件夹,将类放到此文件夹下

在这里插入图片描述

5. 编写业务代码


```java
package com.dmsdbj.integral.zentao.provider.job;
 
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.JobHandler;
import com.xxl.job.core.log.XxlJobLogger;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
 
/**
 * XXLJob的测试类，需要继承IJobHandler类
 */
@Slf4j
@Component
@JobHandler(value = "TestJob") //与xxl-job上的jobHandler做对应
public class TestJob extends IJobHandler {
    /**
     * execute handler, invoked when executor receives a scheduling request
     *
     * @param param
     * @return
     * @throws Exception
     */
    @Override
    public ReturnT<String> execute(String param)  {
        XxlJobLogger.log(this.getClass().getSimpleName() + "--start");
        try {
            System.out.println("业务1");
            System.out.println("业务2");
            System.out.println("业务3");
            System.out.println("业务4");
            System.out.println("业务5");
        } catch (Exception e) {
            log.error(e.getMessage(), e);
            throw e;
        }
        XxlJobLogger.log(this.getClass().getSimpleName() + "--end");
        return ReturnT.SUCCESS;
    }
}