Maven打包過(guò)程中排除特定依賴(lài)的完整指南
前言
在使用 Maven 構(gòu)建 Java 項(xiàng)目時(shí),我們常常需要對(duì)項(xiàng)目的打包過(guò)程進(jìn)行精細(xì)化控制,尤其是希望排除某些特定的依賴(lài)庫(kù)。這可能是為了減小最終構(gòu)建產(chǎn)物的體積、避免版本沖突,或者僅僅是為了滿(mǎn)足不同環(huán)境下的部署需求。
本文將詳細(xì)介紹如何在 Maven 打包過(guò)程中排除特定依賴(lài),涵蓋多種常見(jiàn)插件和配置方式,幫助你靈活控制項(xiàng)目的打包內(nèi)容。
一、理解 Maven 的依賴(lài)作用域(Scope)
在深入討論排除依賴(lài)之前,先了解 Maven 中的依賴(lài)作用域是非常重要的。不同的作用域決定了依賴(lài)是否會(huì)被包含在構(gòu)建輸出中:
| Scope | 描述 |
|---|---|
| compile | 默認(rèn)作用域,適用于所有階段(編譯、測(cè)試、運(yùn)行) |
| provided | 編譯和測(cè)試階段可用,但不會(huì)被打包進(jìn)最終輸出(如 Servlet API) |
| runtime | 運(yùn)行和測(cè)試階段需要,但編譯不需要(如 JDBC 驅(qū)動(dòng)) |
| test | 僅用于測(cè)試階段,不會(huì)被打包 |
| system | 類(lèi)似于 provided,但必須顯式指定本地路徑 |
| import | 僅用于 <dependencyManagement> 中導(dǎo)入其他 POM 的依賴(lài) |
最佳實(shí)踐建議:優(yōu)先使用合適的 scope 來(lái)控制依賴(lài)是否被打包,而不是通過(guò)插件強(qiáng)行剔除。
二、使用 Maven Shade Plugin 排除依賴(lài)
如果你使用的是 maven-shade-plugin 來(lái)構(gòu)建一個(gè)包含所有依賴(lài)的 fat jar(即 uber jar),可以通過(guò) <excludes> 標(biāo)簽來(lái)排除特定依賴(lài)。
示例配置
<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>
說(shuō)明:
<exclude>的格式為groupId:artifactId,可以精確到版本號(hào)。- 適合用于構(gòu)建包含多個(gè)模塊和依賴(lài)的單體 JAR 包。
三、使用 Maven Assembly Plugin 排除依賴(lài)
如果你使用 maven-assembly-plugin 來(lái)打包一個(gè)包含依賴(lài)的 zip/jar 包,也可以通過(guò) <excludes> 來(lái)排除某些依賴(lài)。
示例配置
<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 文件,實(shí)現(xiàn)更細(xì)粒度的控制。
四、使用 Maven Jar Plugin 排除資源或類(lèi)文件
默認(rèn)的 maven-jar-plugin 不會(huì)把依賴(lài)打進(jìn) JAR 包中,但如果你有特殊需求(如手動(dòng)管理 lib 目錄),可以用來(lái)排除某些資源或類(lèi)文件。
示例配置(排除資源)
<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 清理依賴(lài)
如果你想在打包前主動(dòng)清理某些依賴(lài),可以使用 maven-dependency-plugin 來(lái)復(fù)制依賴(lài)并排除部分庫(kù)。
示例配置
<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>
此方法適合手動(dòng)構(gòu)建 lib 目錄,并配合 shell 腳本或 Dockerfile 使用。
六、Docker 構(gòu)建中排除依賴(lài)(Maven + Docker)
如果你使用 Maven 構(gòu)建鏡像(如結(jié)合 Jib、Dockerfile 等),可以在構(gòu)建應(yīng)用 JAR 包時(shí)就排除依賴(lài),再將其 COPY 到 Docker 鏡像中。
示例(結(jié)合 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>
在此示例中,你可以先通過(guò)其他方式控制哪些依賴(lài)被放入 /app/libs/。
七、使用<scope>顯式排除依賴(lài)
最簡(jiǎn)單且推薦的方式是直接在 pom.xml 中設(shè)置依賴(lài)的作用域?yàn)?test 或 provided,這樣它們就不會(huì)被打包進(jìn)最終輸出。
示例
<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 會(huì)根據(jù)作用域自動(dòng)決定是否將該依賴(lài)包含在構(gòu)建輸出中。
八、使用<optional>標(biāo)記依賴(lài)為可選
如果你開(kāi)發(fā)的是一個(gè)庫(kù)(library),并且某個(gè)依賴(lài)不是必需的,可以將其標(biāo)記為 <optional>true</optional>,這樣引入你的庫(kù)的項(xiàng)目可以選擇是否包含這個(gè)依賴(lài)。
示例:
<dependency>
<groupId>com.example</groupId>
<artifactId>some-utils</artifactId>
<version>1.0.0</version>
<optional>true</optional>
</dependency>
注意:<optional> 不會(huì)影響當(dāng)前項(xiàng)目的打包行為,而是影響下游項(xiàng)目的依賴(lài)管理。
九、使用<exclusion>排除傳遞性依賴(lài)
有時(shí)你想排除某個(gè)依賴(lài)的子依賴(lài)(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>
這種方式非常適合解決依賴(lài)沖突或精簡(jiǎn)依賴(lài)樹(shù)。
十、綜合建議與最佳實(shí)踐
| 場(chǎng)景 | 推薦做法 |
|---|---|
| 測(cè)試依賴(lài)不打包 | 設(shè)置 <scope>test</scope> |
| 容器已提供依賴(lài)(如 Tomcat、JDK) | 設(shè)置 <scope>provided</scope> |
| 某些依賴(lài)不想被打入最終 JAR/WAR | 使用 Shade / Assembly 插件配置 <excludes> |
| 排除某個(gè)依賴(lài)的子依賴(lài) | 使用 <exclusions> 標(biāo)簽 |
| 控制依賴(lài)是否傳遞給下游項(xiàng)目 | 使用 <optional>true</optional> |
| 構(gòu)建 lib 目錄時(shí)排除某些庫(kù) | 使用 maven-dependency-plugin 的 <excludes> |
| 構(gòu)建 Docker 鏡像時(shí)排除依賴(lài) | 結(jié)合上述方法先處理好 JAR 再 COPY |
總結(jié)
Maven 提供了多種靈活的方式來(lái)排除特定依賴(lài),從簡(jiǎn)單的 <scope> 到復(fù)雜的插件配置,開(kāi)發(fā)者可以根據(jù)實(shí)際需求選擇最合適的方法。合理使用這些技巧不僅可以減小最終包的體積,還能有效避免依賴(lài)沖突問(wèn)題,提高構(gòu)建效率和部署穩(wěn)定性。
常見(jiàn)問(wèn)答
Q:我只想排除某個(gè)依賴(lài)的一個(gè) jar 文件?
A:可以使用 <exclusion> 排除其子依賴(lài),或者使用插件配置 <excludes>。
Q:為什么設(shè)置了<scope>provided</scope>依賴(lài)仍然被打包?
A:檢查是否被其他插件強(qiáng)制引入,例如 maven-shade-plugin。
Q:我想在 Spring Boot 項(xiàng)目中排除某些 starter 自帶的依賴(lài)怎么辦?
A:使用 <exclusions> 標(biāo)簽,在對(duì)應(yīng)的 starter 依賴(lài)中聲明要排除的子依賴(lài)。
到此這篇關(guān)于Maven打包過(guò)程中排除特定依賴(lài)的完整指南的文章就介紹到這了,更多相關(guān)Maven排除特定依賴(lài)內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java自動(dòng)化讀取Excel文件(XLS/XLSX)的完整指南
這篇文章詳細(xì)介紹了如何使用該庫(kù)讀取XLS和XLSX格式的Excel文件,包括提取單元格數(shù)據(jù)、公式計(jì)算結(jié)果以及圖像等內(nèi)容,希望可以幫助大家快速實(shí)現(xiàn)Excel文檔的自動(dòng)化處理與集成2025-09-09
詳解java集成支付寶支付接口(JSP+支付寶20160912)
本篇文章主要介紹了java集成支付寶支付接口,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2016-12-12
Spring Data Neo4j Cypher查詢(xún)使用
本文介紹了Spring Data Neo4j Cypher查詢(xún)使用的幾種方法,包括使用Repository接口、動(dòng)態(tài)查詢(xún)、服務(wù)層組合、外部查詢(xún)文件和圖形化查詢(xún)構(gòu)建器, 感興趣的可以了解一下2024-11-11
idea2020安裝MybatisCodeHelper插件的圖文教程
這篇文章主要介紹了idea2020安裝MybatisCodeHelper插件的方法,本文通過(guò)圖文并茂的形式給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-09-09
使用Java8?Stream流的skip?+?limit實(shí)現(xiàn)批處理的方法
Stream 作為 Java 8 的一大亮點(diǎn),它與 java.io 包里的 InputStream 和 OutputStream 是完全不同的概念這篇文章主要介紹了使用Java8?Stream流的skip?+?limit實(shí)現(xiàn)批處理,需要的朋友可以參考下2022-07-07
java?HttpURLConnection類(lèi)的disconnect方法與http長(zhǎng)連接詳解
這篇文章主要介紹了java?HttpURLConnection類(lèi)的disconnect方法與http長(zhǎng)連接,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-04-04
Java 字符數(shù)組轉(zhuǎn)字符串的常用方法
文章總結(jié)了在Java中將字符數(shù)組轉(zhuǎn)換為字符串的幾種常用方法,包括使用String構(gòu)造函數(shù)、String.valueOf()方法、StringBuilder以及Arrays.toString()方法,每種方法都有其適用的場(chǎng)景和性能特點(diǎn),感興趣的朋友跟隨小編一起看看吧2025-01-01

