xxl-job与Springboot 项目集成详细步骤

搬砖的泡泡

已于 2024-07-31 21:13:55 修改

阅读量1.3k

点赞数 35

分类专栏：技术融合文章标签： spring boot 后端 java

于 2024-07-31 20:49:39 首次发布

本文链接：https://blog.csdn.net/weixin_51056351/article/details/140829418

版权

技术融合专栏收录该内容

1 篇文章 0 订阅

订阅专栏

1、源码下载
git地址： https://gitee.com/xuxueli0323/xxl-job
github地址： https://github.com/xuxueli/xxl-job

2、运行源码或是jar包方式运行

1、导入SQL 文件目录（doc/db/tables_xxl_job.sql）此步骤自行完成
2、 xxl-job修改配置文件 application.properties

#端口配置（自由配置）
server.port=9090 
#数据库配置(结合实际开发配置) spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_jobuseUnicode=true&characterEncoding=UTF8&autoReconnect=true&serverTimezone=Asia/Shanghai 
spring.datasource.username=root 
spring.datasource.password=root 
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
其他配置按需修改即可

3、完成1 2 步骤启动xxl-job项目

3、主项目中引入xxl-job pom依赖【主项目即所需要使用xxl-job的项目】

    <properties>
		<!-- Job 定时任务相关 -->
		<xxl-job.version>2.3.1</xxl-job.version>
	</properties>
	<dependency>
			<groupId>com.xuxueli</groupId>
			<artifactId>xxl-job-core</artifactId>
			<version>${xxl-job.version}</version>
	</dependency>

4、主项目修改配置文件

spring:
  application:
    name: xxl-job-demo #（喜欢叫什么随意来）

server:
  port: 8081   #（喜欢用多少随意来）

xxl:
  job:
    executor:
      app-name: ${spring.application.name}
      ## 服务模块的名称 即 xxl_job 登录后 `执行器管理`->`新增`->`新增执行器` AppName
      ##执行器运行的端口 （可以自定义）
      port: 9999
      logretentiondays: 30
      # 是否开启调度中心，默认为 true 开启
    enabled: true
    admin:
      # 调度中心部署地址
      addresses: http://127.0.0.1:9090/xxl-job-admin
    access-token: default_token

5、主项目中配置环境变量属性

import lombok.Getter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

/**
 * XXL-Job 配置类
 */
@Getter
@Component
@ConfigurationProperties(prefix = "xxl.job")
public class XxlJobProperties {

    private Executor executor = new Executor();
    private boolean enabled;
    private Admin admin = new Admin();
    private String accessToken;

    public static class Executor {
        private String ip;
        private int port;
        private String appName;
        private String logPath;
        private int logRetentionDays;

        public String getIp() {
            return ip;
        }

        public void setIp(String ip) {
            this.ip = ip;
        }

        public int getPort() {
            return port;
        }

        public void setPort(int port) {
            this.port = port;
        }

        public String getAppName() {
            return appName;
        }

        public void setAppName(String appName) {
            this.appName = appName;
        }

        public String getLogPath() {
            return logPath;
        }

        public void setLogPath(String logPath) {
            this.logPath = logPath;
        }

        public int getLogRetentionDays() {
            return logRetentionDays;
        }

        public void setLogRetentionDays(int logRetentionDays) {
            this.logRetentionDays = logRetentionDays;
        }
    }

    public static class Admin {
        private String addresses;

        public String getAddresses() {
            return addresses;
        }

        public void setAddresses(String addresses) {
            this.addresses = addresses;
        }
    }

    public void setExecutor(Executor executor) {
        this.executor = executor;
    }

    public void setEnabled(boolean enabled) {
        this.enabled = enabled;
    }

    public void setAdmin(Admin admin) {
        this.admin = admin;
    }

    public void setAccessToken(String accessToken) {
        this.accessToken = accessToken;
    }
}

6、配置xxl-job config类

import com.xxl.job.core.executor.XxlJobExecutor;
import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@Slf4j
public class XxlJobConfig {

    @Bean
    @ConditionalOnMissingBean
    public XxlJobExecutor xxlJobExecutor(XxlJobProperties properties) {
        log.info("[xxlJobExecutor][初始化 XXL-Job 执行器的配置]");
        XxlJobProperties.Admin admin = properties.getAdmin();
        XxlJobProperties.Executor executor = properties.getExecutor();

        // 初始化执行器
        XxlJobExecutor xxlJobExecutor = new XxlJobSpringExecutor();
        xxlJobExecutor.setIp(executor.getIp());
        xxlJobExecutor.setPort(executor.getPort());
        xxlJobExecutor.setAppname(executor.getAppName());
        xxlJobExecutor.setLogPath(executor.getLogPath());
        xxlJobExecutor.setLogRetentionDays(executor.getLogRetentionDays());
        xxlJobExecutor.setAdminAddresses(admin.getAddresses());
        xxlJobExecutor.setAccessToken(properties.getAccessToken());
        return xxlJobExecutor;
    }

}