讲师中心 微信公众号

工具推荐

视频效率加速
AniShort
AniShort

AI短剧协同制作平台

剧云
剧云

中文短剧剧本制作平台

Laper
Laper

剧本策划到成片协作

Seko
Seko

AI短剧一键生成成片

Spring Boot项目作为可导入依赖JAR包的构建指南

阿明大大_3482

阿明大大_3482

发布时间:2025-11-20 15:13:00

|

459人浏览过

|

来源于php中文网

原创

Spring Boot项目作为可导入依赖JAR包的构建指南

本文旨在解决spring boot项目在作为其他项目的依赖库时,默认打包方式(含boot-inf目录)不兼容的问题。通过结合使用maven assembly插件生成包含所有依赖的jar包,并巧妙配置spring boot maven插件以跳过其默认行为,我们将指导您构建一个标准、自包含且可被其他项目轻松导入的jar文件,同时提供详细的配置示例和注意事项。

引言:Spring Boot项目作为库的挑战

Spring Boot项目通常使用spring-boot-maven-plugin来打包成可执行的“胖JAR”(Fat JAR)。这种JAR包包含所有项目代码、资源以及其所有依赖,并具有一个特殊的BOOT-INF目录结构,其中包含了应用程序的类和依赖库。这种结构非常适合独立运行的应用程序,但当您尝试将此类JAR作为另一个Maven或Gradle项目的依赖项导入时,通常会遇到问题,因为其内部结构不符合标准的库JAR规范,导致类加载或依赖解析失败。

为了解决这个问题,开发者有时会尝试使用maven-assembly-plugin并配置jar-with-dependencies描述符。然而,如果spring-boot-maven-plugin仍然处于活跃状态,它可能会干扰Assembly插件的输出,导致生成两个JAR包:一个不包含依赖的标准JAR,以及一个仍然带有BOOT-INF结构的JAR,或者一个虽然包含依赖但结构不理想的JAR。本教程将展示如何正确配置,以生成一个单一的、自包含且可导入的库JAR。

核心策略:生成自包含的依赖JAR

要成功地将Spring Boot项目打包为可导入的依赖库,核心策略是:利用Maven Assembly插件来聚合所有依赖,同时禁用或跳过Spring Boot Maven插件的默认打包行为。

1. 配置Maven Assembly插件

maven-assembly-plugin是Maven社区中用于创建自定义打包文件的强大工具。通过使用jar-with-dependencies描述符,它可以将项目的所有编译类和其所有运行时依赖项打包到一个单一的JAR文件中。

在项目的pom.xml文件中,添加以下配置:

<build>
    <plugins>
        <plugin>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>3.4.2</version> <!-- 建议使用最新稳定版本 -->
            <configuration>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
                <archive>
                    <manifest>
                        <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
                        <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
                    </manifest>
                </archive>
            </configuration>
            <executions>
                <execution>
                    <id>make-assembly</id>
                    <phase>package</phase>
                    <goals>
                        <goal>single</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

解释:

  • jar-with-dependencies:这是关键部分,它告诉Assembly插件使用预定义的jar-with-dependencies策略来打包,即将所有依赖项包含在最终的JAR中。
  • ...:可选配置,用于在JAR的MANIFEST.MF文件中添加实现和规范信息,有助于识别库版本。
  • :配置插件在Maven生命周期的package阶段执行single目标,从而生成Assembly JAR。

2. 跳过Spring Boot Maven插件

spring-boot-maven-plugin是Spring Boot项目默认用于构建可执行JAR的插件。它的默认行为会生成带有BOOT-INF目录的JAR,这正是我们作为库使用时需要避免的。为了防止它干扰Assembly插件或生成不必要的额外JAR,我们需要明确地跳过它的执行。

在pom.xml的部分,找到spring-boot-maven-plugin的配置(如果它存在,通常由Spring Boot Starter Parent引入),并添加true:

Springboot Vue Builder
Springboot Vue Builder

从零开始编排 SpringBoot+Vue 全栈项目工作流,适用于新建全栈项目或完整脚手架请求,触发后依次调用 product‑spec‑builder(需求调研)等模块。

下载
<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <skip>true</skip> <!-- 关键:跳过Spring Boot Maven插件的执行 -->
            </configuration>
        </plugin>
        <!-- 其他插件,如maven-assembly-plugin -->
    </plugins>
</build>

解释:

  • true:这个配置项指示spring-boot-maven-plugin在Maven构建过程中不执行其任何目标,从而避免生成可执行的Spring Boot JAR及其特有的BOOT-INF结构。

3. 移除不必要的Spring Boot启动类

当项目被用作一个库时,它不再需要一个main方法来启动自身。因此,包含@SpringBootApplication注解和SpringApplication.run()调用的启动类变得多余。移除这些代码可以使项目更纯粹地作为库存在,并避免潜在的混淆。

例如,如果您的项目中有一个类似以下的类:

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

您可以安全地将其删除,或者至少移除main方法和@SpringBootApplication注解,将其转换为一个普通的配置类或组件类,如果它承载了其他业务逻辑。

完整的pom.xml配置示例

结合上述所有更改,您的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>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.18</version> <!-- 根据您的项目版本调整 -->
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.example</groupId>
    <artifactId>my-spring-boot-library</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging> <!-- 确保打包类型为jar -->

    <properties>
        <java.version>11</java.version>
    </properties>

    <dependencies>
        <!-- 您的项目依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- 其他Spring Boot starters或自定义依赖 -->
    </dependencies>

    <build>
        <plugins>
            <!-- 配置Maven Assembly插件来生成包含所有依赖的JAR -->
            <plugin>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>3.4.2</version> <!-- 建议使用最新稳定版本 -->
                <configuration>
                    <descriptorRefs>
                        <descriptorRef>jar-with-dependencies</descriptorRef>
                    </descriptorRefs>
                    <archive>
                        <manifest>
                            <addDefaultImplementationEntries>true</addDefaultImplementationEntries>
                            <addDefaultSpecificationEntries>true</addDefaultSpecificationEntries>
                        </manifest>
                    </archive>
                </configuration>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

            <!-- 跳过Spring Boot Maven插件的执行,避免生成可执行JAR和BOOT-INF结构 -->
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <skip>true</skip>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

构建与验证

完成pom.xml的修改后,您可以通过以下Maven命令进行构建:

mvn clean package

执行此命令后,在项目的target目录下,您将找到一个名为my-spring-boot-library-0.0.1-SNAPSHOT-jar-with-dependencies.jar(名称会根据您的artifactId和version变化)的JAR文件。这个JAR文件将包含您项目的所有编译类以及其所有传递性依赖,并且没有BOOT-INF目录结构,可以直接作为普通库依赖导入到其他项目中。

注意事项

  • 适用场景:此方法主要适用于将Spring Boot项目作为“库”而不是独立“应用程序”来发布和使用。如果您需要同时发布一个可执行JAR和一个库JAR,您可能需要更复杂的Maven配置文件,例如使用Maven Profiles来区分构建目标。
  • 依赖冲突:尽管jar-with-dependencies会把所有依赖打包进去,但在消费此库的项目中,仍然需要注意潜在的依赖版本冲突。如果消费项目和库项目依赖了同一个库的不同版本,可能会导致运行时问题。
  • 瘦JAR与胖JAR:此方法生成的JAR是一个“胖JAR”,它包含了所有项目依赖。在某些情况下,如果消费项目已经包含了大部分共享依赖,您可能希望生成一个“瘦JAR”(只包含项目自身的类),然后让消费项目来管理所有依赖。这可以通过移除maven-assembly-plugin并确保packaging为jar,但要手动在消费项目中声明所有传递性依赖来实现。然而,对于希望简单导入一个自包含库的场景,胖JAR通常更方便。

总结

通过本教程,您应该已经掌握了如何将一个Spring Boot项目成功打包成一个标准的、包含所有依赖的JAR文件,使其能够作为其他项目的依赖库来使用。关键在于理解spring-boot-maven-plugin的默认行为,并通过maven-assembly-plugin来生成目标JAR,同时禁用Spring Boot插件的打包过程。遵循这些步骤,将有助于您更灵活地管理和重用Spring Boot模块。

热门AI工具

更多
WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

SoundView
SoundView Hot

SoundView是一款面向跨境电商的视频翻译、配音和本地化 AI 创作平台。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2971

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

517

2026.01.26

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

731

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

1455

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

5806

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

436

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

680

2025.12.24

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

405

2026.02.11

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

20

2026.11.12

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn