SpringBoot集成XXL-JOB

news2024/10/7 16:21:22

一、调度中心

首先下载XXL-JOB

GitHub：https://github.com/xuxueli/xxl-job
GitEE：https://gitee.com/xuxueli0323/xxl-job 项目使用2.3.1版本：
https://github.com/xuxueli/xxl-job/releases/tag/2.3.1

使用IDEA打开项目

xxl-job-admin：调度中心 xxl-job-core：公共依赖
xxj-job-executor-samples：执行器Sample示例
xxl-job-executor-sample-springboot：SpringBoot版本，通过SpringBoot管理执行器
xxl-job-executor-sample-frameless：无框架版本

根据数据库脚本创建数据库，修改数据库连接信息和端口，启动xxl-job-admin，访问http://192.168.101.65:8088/xxl-job-admin/ 账号密码：admin/123456
在这里插入图片描述

二、执行器

下面配置执行器，执行器负责与调度中心通信，接收调度中心发起的任务调度请求

1.首先在media-service工程中添加依赖（父工程中完成了版本控制，这里的版本是2.3.1）

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

2. 在nacos下的media-service-dev.yaml下配置xxl-job

       注意这里配置的appname是执行器的应用名，稍后会在调度中心配置执行器的时候使用

xxl:
  job:
    admin:
      addresses: http://192.168.101.65:8088/xxl-job-admin/
    executor:
      appname: media-process-service
      address:
      ip:
      port: 9999
      logpath: /data/applogs/xxl-job-jobhandler
      logretentiondays: 30
    accessToken: default_token

3.配置xxl-job的执行器

  将示例工程下的配置类拷贝到media-service工程的config路径下，该类中的属性就是获取配置文件中的配置得到的，同时提供了一个执行器的Bean

@Configuration
public class XxlJobConfig {
    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
    @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() {
        logger.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;
    }
    /**
    * 针对多网卡、容器内部署等情况，可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP；
    *
    *      1、引入依赖：
    *          <dependency>
    *             <groupId>org.springframework.cloud</groupId>
    *             <artifactId>spring-cloud-commons</artifactId>
    *             <version>${version}</version>
    *         </dependency>
    *
    *      2、配置文件，或者容器启动变量
    *          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
    *
    *      3、获取IP
    *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
    */
    
}

在这里插入图片描述

4. 进入调度中心，添加执行器

在这里插入图片描述

5. 重启媒资管理服务模块，可以看到执行器在调入中心注册成功

在这里插入图片描述

三、执行任务

在media-service下新建包com.xuecheng.media.service.jobhandler，在该包下定义我们的任务类（创建任务类，编写任务方法）

package com.xuecheng.media.jobhandler;
import com.xxl.job.core.handler.annotation.XxlJob;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
/**
 * @author layman
 * @version 1.0
 * @description TODO
 * @date 2023/6/1 16:57
 */
@Slf4j
@Component
public class SimpleJob {
    @XxlJob("testJob")
    public void testJob() {
        log.debug("开始执行.......");
    }
}