构建与依赖 / 系统课时

使用 effective-pom 查看最终配置

使用 effective-pom 查看最终配置

当父 POM、Super POM、Profile 和当前项目同时参与配置时,直接阅读原始 pom.xml 很容易误判“这个值到底从哪来”。help:effective-pom 会把继承、插值、活动 Profile 和默认模型合并后的结果展开。本课用一个父子项目把来源逐项对上,并给出排查冲突时的阅读顺序。

学习目标

  • 生成当前项目的 effective POM,并把结果保存到文件
  • 从最终模型中区分父 POM、当前 POM、活动 Profile 和默认配置
  • 用 -Dverbose 追踪配置来源,并知道哪些问题应改查 settings.xml

准备一个能看出来源的父子项目

示例按 Maven 3.9.x 编写。把父 POM 放在 <PATH>/effective-pom-demo/pom.xml,子项目放在 <PATH>/effective-pom-demo/app/pom.xml。父 POM 提供坐标和 Java 版本,子 POM 修改最终包名,并准备一个只在 dev Profile 中出现的属性。

父 POM:

xml
<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>effective-parent</artifactId>
  <version>1.0.0</version>
  <packaging>pom</packaging>

  <properties>
    <maven.compiler.release>17</maven.compiler.release>
  </properties>
</project>

子项目 app/pom.xml:

xml
<project>
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>com.example</groupId>
    <artifactId>effective-parent</artifactId>
    <version>1.0.0</version>
  </parent>

  <artifactId>demo-app</artifactId>

  <build>
    <finalName>demo-custom</finalName>
  </build>

  <profiles>
    <profile>
      <id>dev</id>
      <properties>
        <env.name>dev</env.name>
      </properties>
    </profile>
  </profiles>
</project>

这个子 POM 没有写自己的 groupId、version 和 packaging。因此最终模型里,前两项来自父 POM,packaging 使用模型默认值 jar,而 finalName 明确来自当前项目。

生成 effective POM 并保留来源

进入 app 目录后,使用 Maven Help Plugin 3.5.2 的完整坐标可以避免不同机器解析到不同插件版本。-Pdev 激活 Profile,-Dverbose 要求在输出 XML 中尽可能附加来源信息,-Doutput 则把结果写到文件。

bash
mvn org.apache.maven.plugins:maven-help-plugin:3.5.2:effective-pom -Pdev -Dverbose -Doutput=effective-pom.xml

预期输出关键行:

text
[INFO] BUILD SUCCESS

打开 effective-pom.xml 后,应能找到这些稳定值:

xml
<groupId>com.example</groupId>
<artifactId>demo-app</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>
<maven.compiler.release>17</maven.compiler.release>
<env.name>dev</env.name>
<finalName>demo-custom</finalName>

在 Maven 3.9.x 的 JAR 项目中,effective POM 还会展开 Central 仓库和默认生命周期相关的插件执行,例如 default-compile。具体插件版本取决于所用 Maven 发行版,因此排查时应看本机生成的文件,不要照抄别人的 effective POM。

按来源阅读最终模型

不要从第一行开始逐段读整个 XML。先搜你正在排查的键,再根据来源判断应该改哪一层。下面这张表可以直接作为排错顺序。

看到的最终值 本例来源 应该去哪里修改
groupId=com.example 父 POM 父 POM 或取消继承后在子 POM 声明
version=1.0.0 父 POM 父 POM
packaging=jar Maven 模型默认值 子 POM 增加 <packaging>
maven.compiler.release=17 父 POM 属性 父 POM 或子 POM 同名属性覆盖
env.name=dev 已激活的 dev Profile Profile 或激活条件
finalName=demo-custom 当前子 POM 子 POM 的 <build>
default-compile JAR 默认生命周期绑定 检查 packaging 与对应默认绑定

-Dverbose 对追踪父 POM 或当前 POM 中的普通元素很有帮助,但不要把“某个元素没有清楚的来源注释”理解成它一定来自当前 POM。特别是默认生命周期生成的执行,需要结合 packaging 与 Maven 版本判断。

effective-pom 查不到时改查哪里

effective POM 解决的是“项目模型最终长什么样”,并不等于 Maven 运行时所有配置。最常见的误区是拿它排查镜像、代理、私服认证或本地仓库路径;这些主要来自全局或用户级 settings.xml。

如果问题是 Profile 是否真的激活,可以先看 effective POM 中对应属性是否出现;如果问题是镜像、代理、server 凭据或本地仓库,则改用 mvn help:effective-settings。如果问题是依赖最终选中了哪个版本,再使用 mvn dependency:tree。把工具按问题类型分开,通常比在一份 effective POM 里反复搜索更快。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

使用 effective-pom 查看最终配置

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通