pluginManagement：管理Maven插件

1年前 (2024-04-27)

Maven 使用 dependencyManagement 对依赖进行管理，与之类似地，Maven 中还提供了一个名为 pluginManagement 的元素，它可以帮助用户管理 Maven 插件。

插件管理

pluginManagement 元素与 dependencyManagement 元素的原理十分相似，在 pluginManagement 元素中可以声明插件及插件配置，但不会发生实际的插件调用行为，只有在 POM 中配置了真正的 plugin 元素，且其 groupId 和 artifactId 与 pluginManagement 元素中配置的插件匹配时，pluginManagement 元素的配置才会影响到实际的插件行为。

例如，在 App-Data-lib 模块中使用 pluginManagement 元素管理 maven-source-plugin 插件，并将其插件目标 jar-no-fork 绑定到 default 生周期的 verify 阶段上，具体配置如下。

<project xmlns="http://maven.apache网站站点" rel="nofollow"  />     
mvn clean install

执行结果如下。

[INFO] Scanning for projects...
[INFO]
[INFO] -------------------< net.biancheng.www:App-Data-lib >-------------------
[INFO] Building App-Data-lib 1.0
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ App-Data-lib ---
[INFO] Deleting D:\eclipse workSpace4\App-Data-lib\target
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ App-Data-lib ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory D:\eclipse workSpace4\App-Data-lib\src\main\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ App-Data-lib ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 1 source file to D:\eclipse workSpace4\App-Data-lib\target\classes
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ App-Data-lib ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory D:\eclipse workSpace4\App-Data-lib\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ App-Data-lib ---
[INFO] Changes detected - recompiling the module!
[INFO] Compiling 1 source file to D:\eclipse workSpace4\App-Data-lib\target\test-classes
[INFO]
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ App-Data-lib ---
[INFO] Surefire report directory: D:\eclipse workSpace4\App-Data-lib\target\surefire-reports
-------------------------------------------------------
T E S T S
-------------------------------------------------------
Running net.biancheng.www.App_Data_lib.AppTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.027 sec
Results :
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ App-Data-lib ---
[INFO] Building jar: D:\eclipse workSpace4\App-Data-lib\target\App-Data-lib-1.0.jar
[INFO]
[INFO] --- maven-install-plugin:2.4:install (default-install) @ App-Data-lib ---
[INFO] Installing D:\eclipse workSpace4\App-Data-lib\target\App-Data-lib-1.0.jar to D:\myRepository\repository\net\bianc
heng\www\App-Data-lib\1.0\App-Data-lib-1.0.jar
[INFO] Installing D:\eclipse workSpace4\App-Data-lib\pom.xml to D:\myRepository\repository\net\biancheng\www\App-Data-li
b\1.0\App-Data-lib-1.0.pom
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  2.469 s
[INFO] Finished at: 2021-04-16T09:23:26+08:00
[INFO] ------------------------------------------------------------------------

通过以上执行结果，我们看到 maven-source-plugin：jar-no-fork 目标并没有被调用。

在 App-Data-lib 的 POM 文件中添加 plugin 元素声明需要调用的插件。

<project>
...
<!--添加插件管理-->
<build>
<pluginManagement>
...
</pluginManagement>
<!-- 声明使用 maven-source-plugin 插件 -->
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>

与依赖管理相似，由于 pluginManagement 元素中已经包含了插件的全部信息，所以当使用 plugins 元素声明插件调用时，只需要声明插件的 groupId 和 artifactId 即可。

再次执行令 mvn clean install，maven-source-plugin：jar-no-fork 目标被成功调用，如图 1 所示。

图1：Maven 插件管理执行结果

继承插件依赖

当项目中的多个模块存在相同的插件时，应当将插件配置移动到父模块的 pluginManagement 元素中。即使各个模块对于同一插件的具体配置不尽相同，也应当在父模块中使用 pluginManagement 元素对插件版本进行统一声明。

我们甚可以将项目中所有插件的版本信息都在父模块的 POM 中声明，子模块中不再配置任何的版本信息，这样不仅可以统一项目的插件版本，还可以避免出现版本冲突或插件不稳定等问题。

例如，我们将 App-Data-lib 中 pluginManagement 元素中的配置内容移动到父模块 Root 的 POM 中，具体配置入下。

<project xmlns="http://maven.apache网站站点" rel="nofollow"  />     
<project xmlns="http://maven.apache网站站点" rel="nofollow"  />    
mvn clean install

执行结果如下图。

图2：Maven 继承插件管理