SpringBoot工程如何发布第三方Jar

小编在程序开发过程中遇到过一个非常有意思的场景,和大家共享一下。

我们在开发一个单独的springboot工程时,往往会引入很多的maven依赖,在引入后,程序便可以调用依赖的类以及方法,同时,还会调取里面的加载。比如说swagger工程,我们只需要引入依赖,然后做一下简单的配置,便可以集成swagger的接口实现,并且发布出标准的接口文档。那么我们如何将我们开发的程序要发布成第三方spring工程的jar,然后融入进去,让别人依赖调用呢,那么下面由我给大家具体的分享。

首先,我们要将现有的工程进行改造,改造操作分为以下几步:

1、将项目module化,当然,这是我个人习惯,这样项目分层更好管理编辑。

2、要识别主工程,也就是我们要提供给第三方的maven坐标地址,我用starter工程作为maven的主坐标,然后改造

2.1 我先贴如parent工程pom文件的build配置

XML 复制代码
    <build>
        <pluginManagement>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>${spring.boot.version}</version>
                </plugin>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.8.1</version>
                    <configuration>
                        <source>${maven.compiler.source}</source>
                        <target>${maven.compiler.target}</target>
                        <encoding>${project.build.sourceEncoding}</encoding>
                    </configuration>
                </plugin>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-resources-plugin</artifactId>
                    <version>3.2.0</version>
                    <configuration>
                        <encoding>${project.build.sourceEncoding}</encoding>
                    </configuration>
                </plugin>
            </plugins>
        </pluginManagement>
    </build>

2.2 然后starter工程pom如下

XML 复制代码
<parent>
        <groupId>com.inspur.csp.passport</groupId>
        <artifactId>comwechat-parent</artifactId>
        <version>1.0.0</version>
    </parent>

    <artifactId>comwechat-starter</artifactId>
    <packaging>jar</packaging>

    <name>ComWechat Starter</name>
    <description>ComWechat Spring Boot Starter,简化ComWechat功能的集成</description>

    <dependencies>
        <!-- 内部依赖 -->
        <dependency>
            <groupId>com.inspur.csp.passport</groupId>
            <artifactId>comwechat-autoconfigure</artifactId>
        </dependency>
        <dependency>
            <groupId>com.inspur.csp.passport</groupId>
            <artifactId>comwechat-web</artifactId>
        </dependency>
    </dependencies>

2.3 在starter内实现自动配置类(核心)

XML 复制代码
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

/**
 * ComWechat Starter 自动配置类
 * 
 * <p>该类负责扫描Web模块的Controller,确保在引入starter时能够自动发现所有组件。</p>
 * 
 * @author tanxy
 * @date 2025年12月18日
 */
@Configuration
@EnableConfigurationProperties(ComWechatProperties.class) //这个是工程加载配置类,自己写配置类,实现yaml的初始化参数配置
@ConditionalOnProperty(name = "comwechat.enabled", havingValue = "true", matchIfMissing = true)
@ComponentScan(basePackages = {
    "com.inspur.csp.passport.comwechat.controller", //根据真实情况而定
    "com.inspur.csp.passport.comwechat.autoconfigure"//根据真实情况而定
})
public class ComWechatStarterAutoConfiguration {
    
    // 该类主要用于组件扫描,实际的自动配置逻辑在ComWechatAutoConfiguration中
}

2.4 编写spring.factories文件,此文件是让第三方应用识别,自动配置的核心

XML 复制代码
# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.inspur.csp.passport.comwechat.starter.ComWechatStarterAutoConfiguration

3、改造其它的module进行适配,此处不做每一个模块的详细讲解。但是在实操中,我给大家说一下静态界面的集成部分。

模块的截图如下:

在后端集成中,建议严格暴露唯一的api基路径,比如说 /comwechat/******

pom文件信息配置如下:

XML 复制代码
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
         http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>com.inspur.csp.passport</groupId>
        <artifactId>comwechat-parent</artifactId>
        <version>1.0.0</version>
    </parent>

    <artifactId>comwechat-web</artifactId>
    <packaging>jar</packaging>

    <name>ComWechat Web</name>
    <description>ComWechat Web层模块,包含控制器、静态资源和Web相关配置</description>

    <dependencies>
        <!-- 内部依赖 -->
        <dependency>
            <groupId>com.inspur.csp.passport</groupId>
            <artifactId>comwechat-core</artifactId>
        </dependency>
        <dependency>
            <groupId>com.inspur.csp.passport</groupId>
            <artifactId>comwechat-autoconfigure</artifactId>
        </dependency>
        
        <!-- Spring Boot Web依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        
        <!-- Lombok支持 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        
        <!-- 日志依赖 -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-api</artifactId>
        </dependency>
    </dependencies>

</project>

此时,我们基本上是完成了工程改造的必要条件。

那么我们如何集成呢?

首先,先通过原有工程打包到maven仓库,我使用的IDEA进行打包的,大家也可以通过命令行。

先clean,再install

注:在install时,有些小伙伴的maven配置文件做过路径改造,可以改成自己的maven配置文件路径。

开题我们就说了,我们最终的目的是要在另一个Springboot工程里集成该jar包,下面开始讲解如何集成:

1、新建一个Springboot工程并编写pom依赖

pom文件核心配置信息如下:

XML 复制代码
<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.18</version>
        <relativePath/>
    </parent>
    
 <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>
        <dependency>
            <groupId>com.inspur.csp.passport</groupId>
            <artifactId>comwechat-starter</artifactId>
            <version>1.0.0</version>
        </dependency>
    </dependencies>

启动新建的Springboot工程即可,然后访问基路径即可查看是否完成集成。

若小伙伴到到此还没有完成,可以给小编留言,小编看到后逐一回复。

相关推荐
IT_陈寒5 小时前
React Hooks闭包陷阱差点让我加班到凌晨
前端·人工智能·后端
黑马程序员毕设5 小时前
基于Java的医院药品管理系统的优化设计与实现
java·开发语言·spring boot·小程序·架构·课程设计·毕设
码事漫谈6 小时前
本体论,彻底懂
后端
创新技术阁6 小时前
FastapiAdmin 系统日志体系与核心配置参数详解
前端·后端·fastapi
掘金者阿豪6 小时前
SQL Server 迁到金仓,真正麻烦的不是数据,而是这些 T-SQL
后端
xcl09256 小时前
酒馆预约系统开发实战:从需求分析到上线全流程指南
java·spring boot·需求分析
Kyrie_kk6 小时前
Java--IO--Path文件访问
java·后端
wxwx_bscxy3227 小时前
基于springboot宠物领养系统的设计与实现
数据库·spring boot·后端·spring·宠物
苏生Susheng7 小时前
【软件实施】Linux系统Shell脚本教程
linux·运维·服务器·chrome·spring boot·学习·实施
分支预测失败7 小时前
RISC-V AIA 中断架构实战:从 PLIC 到 APLIC 与 IMSIC 的迁移
linux·后端