构建与依赖 / 系统课时

设计可复用的企业父 POM

设计可复用的企业父 POM

企业父 POM 的价值是把“必须一致的构建规则”集中管理,而不是把所有依赖都强塞给子项目。本节给出一个可直接落地的父 POM:固定 Java、依赖和插件版本,启用环境门禁,并用子项目验证继承边界。

学习目标

  • 用 dependencyManagement 和 pluginManagement 集中管理版本。
  • 区分“只管理版本”和“强制所有子项目执行”的配置。
  • 通过 Enforcer 与实际命令验证父 POM 是否生效。

先划清继承边界

企业父 POM 通常使用 pom 打包,但不要因为它是父工程就加入 <modules>;可复用父 POM 与多模块聚合器是两个职责。建议把配置分成三层:公共属性、版本管理、强制门禁。

内容 推荐位置 是否自动进入子项目
Java 版本、编码 properties 是
依赖版本 dependencyManagement 只提供版本,子项目仍需声明依赖
插件版本与默认参数 pluginManagement 只提供管理值,通常需在 plugins 中启用
Maven/Java 最低版本门禁 build/plugins 的 Enforcer 是,会在子项目构建中执行

错误做法是在父 POM 的 <dependencies> 中放十几个“可能会用”的库,这会让所有子项目都得到不必要的传递依赖。正确做法是只在 dependencyManagement 锁版本,让真正需要的模块自行声明。

企业父 POM 的继承边界

写一个最小但完整的父 POM

下面示例使用 Java 17、JUnit BOM 5.11.4、Maven Compiler Plugin 3.13.0、Surefire 3.5.2 和 Enforcer 3.5.0。这些都是已发布版本;企业落地时应在升级流程中统一调整,而不是让各项目自行漂移。

xml
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>com.acme.build</groupId>
  <artifactId>acme-parent</artifactId>
  <version>1.0.0</version>
  <packaging>pom</packaging>

  <properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <maven.compiler.release>17</maven.compiler.release>
    <junit.version>5.11.4</junit.version>
    <maven.compiler.plugin.version>3.13.0</maven.compiler.plugin.version>
    <maven.surefire.plugin.version>3.5.2</maven.surefire.plugin.version>
    <maven.enforcer.plugin.version>3.5.0</maven.enforcer.plugin.version>
  </properties>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>org.junit</groupId>
        <artifactId>junit-bom</artifactId>
        <version>${junit.version}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>

  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-compiler-plugin</artifactId>
          <version>${maven.compiler.plugin.version}</version>
        </plugin>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-surefire-plugin</artifactId>
          <version>${maven.surefire.plugin.version}</version>
        </plugin>
      </plugins>
    </pluginManagement>

    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <release>${maven.compiler.release}</release>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-surefire-plugin</artifactId>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-enforcer-plugin</artifactId>
        <version>${maven.enforcer.plugin.version}</version>
        <executions>
          <execution>
            <id>enforce-build-env</id>
            <goals>
              <goal>enforce</goal>
            </goals>
            <configuration>
              <rules>
                <requireMavenVersion>
                  <version>[3.9.0,4.0.0)</version>
                </requireMavenVersion>
                <requireJavaVersion>
                  <version>[17,18)</version>
                </requireJavaVersion>
              </rules>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

这份 POM 会让 Java 17 编译参数、Compiler/Surefire 插件和 Enforcer 在子项目中生效;JUnit 只被管理版本,不会因为父 POM 存在就自动成为子项目依赖。

用子项目验证继承是否正确

先在父 POM 所在目录执行安装,让 com.acme.build:acme-parent:1.0.0 进入本地仓库。

bash
mvn install

预期结果:

text
[INFO] BUILD SUCCESS

然后让子项目只声明真正需要的依赖。<relativePath/> 表示不要从默认的 ../pom.xml 找父 POM,而是按坐标从仓库解析,适合已经发布或已执行本地 install 的企业父 POM。

xml
<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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <parent>
    <groupId>com.acme.build</groupId>
    <artifactId>acme-parent</artifactId>
    <version>1.0.0</version>
    <relativePath/>
  </parent>

  <artifactId>order-service</artifactId>

  <dependencies>
    <dependency>
      <groupId>org.junit.jupiter</groupId>
      <artifactId>junit-jupiter</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>
</project>

在子项目目录读取继承后的编译版本:

bash
mvn -q help:evaluate -Dexpression=maven.compiler.release -DforceStdout

预期输出:

text
17

再执行 mvn validate。使用 Maven 3.9.x 与 Java 17 时预期结果为 BUILD SUCCESS;若改用 Java 21 或 Maven 4.x,当前 Enforcer 规则应让验证失败,这正是质量门禁需要暴露的环境差异。

控制升级方式而不是无限继承

父 POM 发布后应使用不可变版本,例如 1.0.0、1.1.0,不要让所有项目依赖 LATEST 或随意覆盖插件版本。需要升级 Java 或测试框架时,先发布新的父 POM 版本,再由子项目显式修改 <parent><version>。

对子项目确实需要例外的配置,要判断它属于“版本差异”还是“规则例外”。例如某个模块需要额外的 maven-javadoc-plugin,可以在该模块单独启用;如果某项目想跳过 Enforcer,只为绕过错误 JDK,则不应开放一个默认可用的跳过开关。

验收时至少检查三件事:执行 mvn help:effective-pom 后应能在有效 POM 中看到受管版本;执行 mvn validate 时应触发 Enforcer 并在合规环境得到 BUILD SUCCESS;子项目未声明 junit-jupiter 时,依赖树中也不应凭空出现它。满足这三点,父 POM 才同时做到了统一规则和受控继承。

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

目录与阅读设置

阅读设置

17

记录一个想法

设计可复用的企业父 POM

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

登录哪都通