【xxl-job】本地部署并接入xxl-job到项目中

最新推荐文章于 2025-03-19 23:49:46 发布

Ez4Sterben

最新推荐文章于 2025-03-19 23:49:46 发布

阅读量4.1k

点赞数 6

分类专栏：项目整理文章标签： java xxl-job 定时任务分布式调度本地部署

本文链接：https://blog.csdn.net/qq_51383106/article/details/131668825

版权

项目整理专栏收录该内容

31 篇文章

订阅专栏

本地部署并接入xxl-job到项目中

一、xxl-job简介

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

什么是分布式任务调度

通常任务调度的程序是集成在应用中的，比如：优惠卷服务中包括了定时发放优惠卷的的调度程序，结算服务中包括了定期生成报表的任务调度程序，由于采用分布式架构，一个服务往往会部署多个冗余实例来运行我们的业务，在这种分布式系统环境下运行任务调度，我们称之为分布式任务调度

二、本地部署xxl-job

1、拉取项目

gitee地址：https://gitee.com/xuxueli0323/xxl-job

将项目克隆到本地后打开项目

在这里插入图片描述

xxl-job-admin
admin模块是xxl-job的调度中心，主要负责统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。
xxl-job-core
core模块存放的是xxl-job中的执行器，如果有项目需要接入xxl-job，那么就需要引入xxl-job-core依赖
xxl-job-executor-samples
这里面存放了demo实例可以参考部署

2、初始化数据库

sql文件位置：/doc/db

在这里插入图片描述

执行该sql文件后效果如下

在这里插入图片描述

3、修改配置文件

首先在admin模块中找到配置文件
在这里插入图片描述

修改数据库链接

在这里插入图片描述

修改端口号以及访问地址

在这里插入图片描述

4、启动项目

启动调度中心

在这里插入图片描述
访问

在这里插入图片描述
默认账号密码
admin
123456

在这里插入图片描述

三、在自己的项目中接入xxl-job

1、引入依赖

在本地项目的maven中引入依赖

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

2、编写配置类

package com.example.springboot.config;

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

/**
 * xxl-job config
 *
 * @author xuxueli 2017-04-28
 */
@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();
     */


}

3、修改配置文件

xxl:
  job:
    admin:
      addresses: http://127.0.0.1:8089/xxl-job-admin
    accessToken: default_token
    executor:
      appname: spring-boot
      address:
      ip:
      port: 6666
      logpath: /data/applogs/xxl-job/jobhandler
      logretentiondays: 30

4、在调度中心中录入项目

进入调度中心的执行器管理
在这里插入图片描述
新增本地项目

![在这里插入图片描述](https://img-blog.csdnimg.cn/2f5e52e6fbb34d8188e3c12e1ef8a070.png

四、如何在本地项目中使用

1、测试案例

package com.example.springboot.job;

import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;

@Component
public class XxlJobDemo {

    @XxlJob("test")
    public void xxlJobTest(){

        XxlJobHelper.log("输出日志");
        // 参数
        System.out.println(XxlJobHelper.getJobParam());
        // 多少台机器
        System.out.println(XxlJobHelper.getShardTotal());
        // 现在是第几台机器
        System.out.println(XxlJobHelper.getShardIndex());
    }

}