Maven打包过程中排除特定依赖的完整指南

 更新时间:2025年07月09日 09:02:13   作者:超级小忍  
在使用 Maven 构建 Java 项目时,我们常常需要对项目的打包过程进行精细化控制,尤其是希望排除某些特定的依赖库,下面小编就来和大家讲讲具体实现方法吧

前言

在使用 Maven 构建 Java 项目时,我们常常需要对项目的打包过程进行精细化控制,尤其是希望排除某些特定的依赖库。这可能是为了减小最终构建产物的体积、避免版本冲突,或者仅仅是为了满足不同环境下的部署需求。

本文将详细介绍如何在 Maven 打包过程中排除特定依赖,涵盖多种常见插件和配置方式,帮助你灵活控制项目的打包内容。

一、理解 Maven 的依赖作用域(Scope)

在深入讨论排除依赖之前,先了解 Maven 中的依赖作用域是非常重要的。不同的作用域决定了依赖是否会被包含在构建输出中:

Scope描述
compile默认作用域,适用于所有阶段(编译、测试、运行)
provided编译和测试阶段可用,但不会被打包进最终输出(如 Servlet API)
runtime运行和测试阶段需要,但编译不需要(如 JDBC 驱动)
test仅用于测试阶段,不会被打包
system类似于 provided,但必须显式指定本地路径
import仅用于 <dependencyManagement> 中导入其他 POM 的依赖

最佳实践建议:优先使用合适的 scope 来控制依赖是否被打包,而不是通过插件强行剔除。

二、使用 Maven Shade Plugin 排除依赖

如果你使用的是 maven-shade-plugin 来构建一个包含所有依赖的 fat jar(即 uber jar),可以通过 <excludes> 标签来排除特定依赖。

示例配置

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-shade-plugin</artifactId>
    <version>3.5.0</version>
    <executions>
        <execution>
            <phase>package</phase>
            <goals>
                <goal>shade</goal>
            </goals>
            <configuration>
                <excludes>
                    <exclude>com.example:unwanted-library</exclude>
                    <exclude>org.slf4j:slf4j-simple</exclude>
                </excludes>
                <transformers>
                    <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
                        <mainClass>com.example.Main</mainClass>
                    </transformer>
                </transformers>
            </configuration>
        </execution>
    </executions>
</plugin>

说明

  • <exclude> 的格式为 groupId:artifactId,可以精确到版本号。
  • 适合用于构建包含多个模块和依赖的单体 JAR 包。

三、使用 Maven Assembly Plugin 排除依赖

如果你使用 maven-assembly-plugin 来打包一个包含依赖的 zip/jar 包,也可以通过 <excludes> 来排除某些依赖。

示例配置

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-assembly-plugin</artifactId>
    <version>3.6.0</version>
    <configuration>
        <descriptorRefs>
            <descriptorRef>jar-with-dependencies</descriptorRef>
        </descriptorRefs>
        <archive>
            <manifest>
                <mainClass>com.example.Main</mainClass>
            </manifest>
        </archive>
        <excludes>
            <exclude>com.example:unwanted-library</exclude>
            <exclude>org.slf4j:slf4j-api</exclude>
        </excludes>
    </configuration>
    <executions>
        <execution>
            <id>make-assembly</id>
            <phase>package</phase>
            <goals>
                <goal>single</goal>
            </goals>
        </execution>
    </executions>
</plugin>

提示:Assembly 插件还支持自定义 assembly.xml 文件,实现更细粒度的控制。

四、使用 Maven Jar Plugin 排除资源或类文件

默认的 maven-jar-plugin 不会把依赖打进 JAR 包中,但如果你有特殊需求(如手动管理 lib 目录),可以用来排除某些资源或类文件。

示例配置(排除资源)

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-jar-plugin</artifactId>
    <version>3.7.0</version>
    <configuration>
        <excludes>
            <exclude>**/unwanted/**</exclude>
        </excludes>
    </configuration>
</plugin>

五、使用 Maven Dependency Plugin 清理依赖

如果你想在打包前主动清理某些依赖,可以使用 maven-dependency-plugin 来复制依赖并排除部分库。

示例配置

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-dependency-plugin</artifactId>
    <version>3.6.0</version>
    <executions>
        <execution>
            <id>copy-dependencies</id>
            <phase>package</phase>
            <goals>
                <goal>copy-dependencies</goal>
            </goals>
            <configuration>
                <outputDirectory>${project.build.directory}/lib</outputDirectory>
                <overWriteReleases>false</overWriteReleases>
                <overWriteSnapshots>false</overWriteSnapshots>
                <overWriteIfNewer>true</overWriteIfNewer>
                <excludes>
                    <exclude>com.example:unwanted-library</exclude>
                </excludes>
            </configuration>
        </execution>
    </executions>
</plugin>

此方法适合手动构建 lib 目录,并配合 shell 脚本或 Dockerfile 使用。

六、Docker 构建中排除依赖(Maven + Docker)

如果你使用 Maven 构建镜像(如结合 Jib、Dockerfile 等),可以在构建应用 JAR 包时就排除依赖,再将其 COPY 到 Docker 镜像中。

示例(结合 jib-maven-plugin)

<plugin>
    <groupId>com.google.cloud.tools</groupId>
    <artifactId>jib-maven-plugin</artifactId>
    <version>3.3.2</version>
    <configuration>
        <container>
            <entrypoint>
                <arg>java</arg>
                <arg>-cp</arg>
                <arg>/app/resources:/app/classes:/app/libs/*</arg>
                <arg>com.example.Main</arg>
            </entrypoint>
        </container>
        <extraDirectories>
            <paths>
                <path>
                    <from>src/main/resources</from>
                    <into>/app/resources</into>
                </path>
            </paths>
        </extraDirectories>
    </configuration>
</plugin>

在此示例中,你可以先通过其他方式控制哪些依赖被放入 /app/libs/

七、使用<scope>显式排除依赖

最简单且推荐的方式是直接在 pom.xml 中设置依赖的作用域为 testprovided,这样它们就不会被打包进最终输出。

示例

<dependency>
    <groupId>junit</groupId>
    <artifactId>junit</artifactId>
    <version>4.13.2</version>
    <scope>test</scope>
</dependency>

<dependency>
    <groupId>javax.servlet</groupId>
    <artifactId>javax.servlet-api</artifactId>
    <version>4.0.1</version>
    <scope>provided</scope>
</dependency>

Maven 会根据作用域自动决定是否将该依赖包含在构建输出中。

八、使用<optional>标记依赖为可选

如果你开发的是一个库(library),并且某个依赖不是必需的,可以将其标记为 <optional>true</optional>,这样引入你的库的项目可以选择是否包含这个依赖。

示例:

<dependency>
    <groupId>com.example</groupId>
    <artifactId>some-utils</artifactId>
    <version>1.0.0</version>
    <optional>true</optional>
</dependency>

注意:<optional> 不会影响当前项目的打包行为,而是影响下游项目的依赖管理。

九、使用<exclusion>排除传递性依赖

有时你想排除某个依赖的子依赖(transitive dependency),可以使用 <exclusions>

示例:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
        </exclusion>
        <exclusion>
            <groupId>org.slf4j</groupId>
            <artifactId>log4j-over-slf4j</artifactId>
        </exclusion>
    </exclusions>
</dependency>

这种方式非常适合解决依赖冲突或精简依赖树。

十、综合建议与最佳实践

场景推荐做法
测试依赖不打包设置 <scope>test</scope>
容器已提供依赖(如 Tomcat、JDK)设置 <scope>provided</scope>
某些依赖不想被打入最终 JAR/WAR使用 Shade / Assembly 插件配置 <excludes>
排除某个依赖的子依赖使用 <exclusions> 标签
控制依赖是否传递给下游项目使用 <optional>true</optional>
构建 lib 目录时排除某些库使用 maven-dependency-plugin 的 <excludes>
构建 Docker 镜像时排除依赖结合上述方法先处理好 JAR 再 COPY

总结

Maven 提供了多种灵活的方式来排除特定依赖,从简单的 <scope> 到复杂的插件配置,开发者可以根据实际需求选择最合适的方法。合理使用这些技巧不仅可以减小最终包的体积,还能有效避免依赖冲突问题,提高构建效率和部署稳定性。

常见问答

Q:我只想排除某个依赖的一个 jar 文件?

A:可以使用 <exclusion> 排除其子依赖,或者使用插件配置 <excludes>

Q:为什么设置了<scope>provided</scope>依赖仍然被打包?

A:检查是否被其他插件强制引入,例如 maven-shade-plugin

Q:我想在 Spring Boot 项目中排除某些 starter 自带的依赖怎么办?

A:使用 <exclusions> 标签,在对应的 starter 依赖中声明要排除的子依赖。

到此这篇关于Maven打包过程中排除特定依赖的完整指南的文章就介绍到这了,更多相关Maven排除特定依赖内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java中使用map排序的实例讲解

    java中使用map排序的实例讲解

    在本篇文章里小编给大家整理了一篇关于java中使用map排序的实例讲解内容,有兴趣的朋友们可以学习下。
    2020-12-12
  • Java并发编程之对象的共享

    Java并发编程之对象的共享

    这篇文章主要介绍了Java并发编程之对象的共享,介绍如何共享和发布对象,使它们被安全地由多个进程访问。需要的小伙伴可以参考一下
    2022-04-04
  • Java Web开发防止多用户重复登录的完美解决方案

    Java Web开发防止多用户重复登录的完美解决方案

    在web项目开发中,很多情况下都可以让同一个账号信息在不同的登录入口登录很多次,这样子做的不是很完善。一般解决这种情况有两种解决方案,小编呢主要以第二种方式给大家介绍具体的实现方法,对java web 防止多用户重复登录的解决方案感兴趣的朋友一起看看吧
    2016-11-11
  • springboot Interceptor拦截器excludePathPatterns忽略失效

    springboot Interceptor拦截器excludePathPatterns忽略失效

    这篇文章主要介绍了springboot Interceptor拦截器excludePathPatterns忽略失效的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • 关于spring boot使用 jdbc+mysql 连接的问题

    关于spring boot使用 jdbc+mysql 连接的问题

    这篇文章主要介绍了spring boot使用 jdbc+mysql 连接,在这里mysql 8.x版本驱动包,要使用 com.mysql.cj.jdbc.Driver作为驱动类,文中给大家详细介绍,需要的朋友可以参考下
    2022-03-03
  • Spring boot 整合RabbitMQ实现通过RabbitMQ进行项目的连接

    Spring boot 整合RabbitMQ实现通过RabbitMQ进行项目的连接

    RabbitMQ是一个开源的AMQP实现,服务器端用Erlang语言编写,支持多种客户端,这篇文章主要介绍了Spring boot 整合RabbitMQ实现通过RabbitMQ进行项目的连接,需要的朋友可以参考下
    2022-10-10
  • java实现ATM取款项目

    java实现ATM取款项目

    这篇文章主要为大家详细介绍了java实现ATM取款项目的实现代码,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-06-06
  • 解析java中的condition

    解析java中的condition

    Condition 将 Object 监视器方法(wait()、notify()和notifyAll())分解成截然不同的对象,以便通过将这些对象与任意Lock实现组合使用,为每个对象提供多个等待 set(wait-set)
    2021-06-06
  • Spring Boot 2.6.x整合Swagger启动失败报错问题的完美解决办法

    Spring Boot 2.6.x整合Swagger启动失败报错问题的完美解决办法

    这篇文章主要给大家介绍了关于Spring Boot 2.6.x整合Swagger启动失败报错问题的完美解决办法,文中通过实例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2022-03-03
  • Java基础面试题之volatile详解

    Java基础面试题之volatile详解

    Volatile可以看做是轻量级的 Synchronized,它只保证了共享变量的可见性,下面这篇文章主要给大家介绍了关于Java基础面试题之volatile的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-06-06

最新评论