构建与依赖 / 系统课时

pluginManagement 统一插件配置

pluginManagement 统一插件配置

多模块项目里最容易失控的是插件版本和公共参数散落在各个子模块。把这些默认值放进父 POM 的 pluginManagement,再让真正需要插件的子模块显式引用,可以同时做到统一版本、减少重复配置,并避免插件被所有模块无条件执行。

学习目标

  • 区分 pluginManagement 的“提供默认配置”和 build/plugins 的“参与当前构建”。
  • 在父 POM 统一维护插件版本、执行阶段和公共规则。
  • 用 help:effective-pom 与实际生命周期命令确认子模块最终拿到的配置。

先区分统一定义与实际启用

可以把 pluginManagement 理解成插件配置的默认模板:它能保存 groupId、artifactId、版本、configuration 和 executions,子模块引用同一插件时会继承这些内容。对于并非生命周期默认绑定的插件,如果子模块不在 build/plugins 中引用它,仅放在父 POM 的 pluginManagement 不会让该插件执行。

位置 作用 适合场景
父 POM build/pluginManagement 统一版本和默认配置 多模块共享插件规范
子模块 build/plugins 让插件参与该模块构建 某些模块按需启用
父 POM build/plugins 默认让继承它的子模块也获得该插件配置 所有模块都必须执行

这里用 Maven Enforcer Plugin 演示,因为它不是 jar 项目默认生命周期绑定的插件,“定义”和“启用”的区别很清楚。

在父 POM 集中声明版本和规则

假设项目要求启用 Enforcer 的模块必须使用 JDK 17 或更高版本。父 POM 只维护插件版本 3.6.3、validate 阶段和 requireJavaVersion 规则,不直接启用插件。

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.example</groupId>
  <artifactId>demo-parent</artifactId>
  <version>1.0.0</version>
  <packaging>pom</packaging>

  <modules>
    <module>app</module>
  </modules>

  <build>
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-enforcer-plugin</artifactId>
          <version>3.6.3</version>
          <executions>
            <execution>
              <id>enforce-java</id>
              <phase>validate</phase>
              <goals>
                <goal>enforce</goal>
              </goals>
              <configuration>
                <rules>
                  <requireJavaVersion>
                    <version>[17,)</version>
                  </requireJavaVersion>
                </rules>
              </configuration>
            </execution>
          </executions>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>
</project>

生效行为是:父 POM 已经定义好 Enforcer 的版本和执行规则,但仅靠这段配置不会让 app 自动执行 enforcer:enforce。[17,) 表示允许 Java 17 及更高版本。

在子模块按需启用

需要执行规则的 app/pom.xml 只声明插件坐标,不再重复版本、阶段、goal 和规则。Maven 会把父 POM pluginManagement 中同一坐标的配置合并进子模块的有效 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.example</groupId>
    <artifactId>demo-parent</artifactId>
    <version>1.0.0</version>
    <relativePath>../pom.xml</relativePath>
  </parent>

  <artifactId>app</artifactId>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-enforcer-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
</project>

如果另一个模块不需要这条规则,就不要在它的 build/plugins 中加入 Enforcer。这样父 POM 仍然集中维护一份标准配置,但启用范围由各子模块决定。

用 effective POM 和 validate 验证

在 app 目录执行下面两条命令。第一条把继承和合并后的 POM 写入文件,第二条真正执行 validate 阶段。

bash
mvn help:effective-pom -Doutput=effective-pom.xml
mvn validate

预期输出(关键结果):

text
[INFO] BUILD SUCCESS

实际日志中的耗时和时间戳会不同。打开 effective-pom.xml,搜索 maven-enforcer-plugin,应能同时看到版本 3.6.3、执行 ID enforce-java 和 <version>[17,)</version>。若用 JDK 17 以下版本执行 mvn validate,构建应在 Enforcer 校验处失败,这正好证明规则已经启用。

什么时候不要放进 pluginManagement

如果某个插件必须对所有继承父 POM 的模块执行,例如公司要求每个模块都执行同一套强制检查,可以直接放到父 POM 的 build/plugins。如果只想统一默认值、允许模块选择是否启用,则放到 pluginManagement 更合适。

常见错误是“为了统一版本”把插件直接塞进父 POM 的 build/plugins,结果原本不需要该插件的模块也开始执行。正确做法是先判断启用范围:全员执行用 build/plugins,按需执行用 pluginManagement 加子模块引用。

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

目录与阅读设置

阅读设置

17

记录一个想法

pluginManagement 统一插件配置

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

登录哪都通