maven:maven-shade-plugin插件被误解的参数 keepDependenciesWithProvidedScope

一、问题的诞生:官方文档的模糊描述

maven-shade-plugin 的官方文档中,关于keepDependenciesWithProvidedScope 参数的描述仅有简单一句[1](#1)

keepDependenciesWithProvidedScope

When true, dependencies are kept in the pom but with scope 'provided'; when false, the dependency is removed.

这导致许多开发者(包括我)产生误解,认为该参数可以强制将 provided 作用域的依赖打包到最终 JAR 中。实际上,这是一个错误认知。


二、源码揭秘:参数的真实作用

通过分析 org.apache.maven.plugins.shade.mojo.ShadeMojo 源码[2](#2),我们发现:

1. 生效条件

java 复制代码
if (createDependencyReducedPom) {
    // 当且仅当 createDependencyReducedPom=true 时
    createDependencyReducedPom(artifactIds);
}

keepDependenciesWithProvidedScope 仅在 createDependencyReducedPom=true 时生效


2. 实际行为

在生成 dependency-reduced-pom.xml 文件时,插件会执行以下逻辑:

java 复制代码
private void createDependencyReducedPom(Set<String> artifactsToRemove){
    // 源码片段简化
    if (!keepDependenciesWithProvidedScope) {
        // 移除所有 provided 作用域的依赖
        dependencies.removeIf(d -> "provided".equals(d.getScope()));
    }
}

这意味着:

  • keepDependenciesWithProvidedScope=true :保留 provided 依赖在精简 POM 中
  • keepDependenciesWithProvidedScope=false(默认) :从精简 POM 中移除 provided 依赖

三、配置示例:眼见为实

场景描述

假设项目依赖如下:

xml 复制代码
<dependency>
    <groupId>org.example</groupId>
    <artifactId>lib-d</artifactId>
    <version>1.0</version>
    <scope>provided</scope>
</dependency>

配置对比

配置项 生成的 dependency-reduced-pom.xml
createDependencyReducedPom=true keepDependenciesWithProvidedScope=false 默认 移除 lib-d 依赖
createDependencyReducedPom=true keepDependenciesWithProvidedScope=true 特殊需求 保留 lib-d 依赖

四、常见误解澄清

误解 1:控制 JAR 打包内容

真相 :该参数 不控制依赖是否被打包到 JAR ,仅影响 dependency-reduced-pom.xml 的内容。 provided 依赖不会被shade插件打包到JAR。

误解 2:与 minimizeJar 相关

真相 :与 minimizeJar 参数无关。两者分别控制:

  • minimizeJar:优化 JAR 文件大小
  • keepDependenciesWithProvidedScope:控制精简 POM 的依赖范围

五、正确使用姿势

适用场景

当你的项目需要:

  1. 生成 dependency-reduced-pom.xml
  2. 保留 provided 依赖在精简 POM 中(例如:下游项目需要知道这些依赖的存在)

配置模板

xml 复制代码
<configuration>
    <createDependencyReducedPom>true</createDependencyReducedPom>
    <keepDependenciesWithProvidedScope>true</keepDependenciesWithProvidedScope>
    <!-- 其他配置 -->
</configuration>

六、总结

keepDependenciesWithProvidedScope 是一个典型的 "文档描述 < 源码真相" 案例。其核心要点:

  1. 仅当 createDependencyReducedPom=true 时生效
  2. 仅影响生成的 POM 文件,不控制 JAR 打包
  3. 用于保留 provided 依赖在精简 POM 中的元数据

下次遇到这个参数时,请记住:它只是 POM 文件的管家,不是 JAR 打包的搬运工。


参考资料


  1. 《keepDependenciesWithProvidedScope》 ↩︎

  2. ShadeMojo.java ↩︎

相关推荐
菠萝催学1235 小时前
日志配置Slf4j
java·数据库·spring·tomcat·maven·intellij-idea
ahauedu6 小时前
Apache POI 依赖版本冲突导致 NoSuchFieldError: Factory 报错
java·maven·apache
Lil Jan1 天前
03-Web后端基础(Maven基础)
java·前端·maven
工作log2 天前
自己动手造轮子:如何创建JAR并通过Maven在Spring Boot中引用
spring boot·maven·jar
kokouya3 天前
macOS配置maven及报错处理:zsh: permission denied: mvn
maven
南洋十三郎3 天前
JavaWeb学习打卡05(在IDEA中创建并使用MavenWeb项目详解、POM.XML文件)
学习·maven·intellij-idea
橘子编程3 天前
Docker详解及实战
java·开发语言·mysql·spring·docker·maven
wsj__WSJ3 天前
IntelliJ IDEA (2024.3.1)优雅导入 Maven 项目的两种方式详解
java·maven·intellij-idea
jacGJ3 天前
记录解决问题--使用maven help插件一次性上传所有依赖到离线环境,spring-boot-starter-undertow离线环境缺少依赖
java·数据库·maven
一叶知秋963 天前
idea部署新项目时,用自定义的maven出现的问题解决
java·maven·intellij-idea