flatten-maven-plugin 统一版本管理插件

需要解决的问题

在一般的多模块父子项目中，会在父项目中定义许多的配置项、依赖的版本给子模块使用，达到统一管理版本的作用。但实际上，子模块打包后生成的 pom 中引用父项目定义的属性的占位符不会被解析为实际定义的属性值。那么假如该子模块是一个 bom 这样的可以单独提供服务的模块，打包后推到了远端，其他人在引入后刷新依赖就会发生 Non-resolvable POM 异常。

问题复现

没使用 flatten-maven-plugin 插件前对一个 bom 模块进行打包，生成的 pom 如下（注意 revision 占位符）：

<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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<parent>
	  <groupId>com.cname.pj</groupId>
	  <artifactId>biz-dev-quickly-v1</artifactId>
	  <version>${revision}</version>
	</parent>
	
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.cname.pj</groupId>
	<artifactId>quickly-dependencies</artifactId>
	<version>${revision}</version>
	<packaging>pom</packaging>
	
	<name>quickly-dependencies</name>
	<description>依赖统一管理</description>
	
	...
</project>

在另一个子模块中引入该 bom，并执行 package：

引入 flatten-maven-plugin 解决

引入 flatten 插件后在打包后看一下 bom 模块生成的 pom 内容：

<?xml version="1.0" encoding="UTF-8"?>
<project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	 <modelVersion>4.0.0</modelVersion>
	 <parent>
	   <groupId>com.cname.pj</groupId>
	   <artifactId>biz-dev-quickly-v1</artifactId>
	   <version>0.0.1-jdk17-SNAPSHOT</version>
	 </parent>
	 <groupId>com.cname.pj</groupId>
	 <artifactId>quickly-dependencies</artifactId>
	 <version>0.0.1-jdk17-SNAPSHOT</version>
	 <packaging>pom</packaging>
	 <name>quickly-dependencies</name>
	 <description>依赖统一管理</description>

	 ...
</project>

占位符已经被替换为了实际的定义值。在对引入该 bom 模块的其他模块进行打包：

配置 flatten-maven-plugin

在父 pom 中配置：

<build>
	<plugins>
		<plugin>
          <groupId>org.codehaus.mojo</groupId>
            <artifactId>flatten-maven-plugin</artifactId>
            <version>1.5.0</version>
            <configuration>
                <flattenMode>resolveCiFriendliesOnly</flattenMode>
                <updatePomFile>true</updatePomFile>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>flatten</goal>
                    </goals>
                    <id>flatten</id>
                    <phase>process-resources</phase>
                </execution>
                <execution>
                    <goals>
                        <goal>clean</goal>
                    </goals>
                    <id>flatten.clean</id>
                    <phase>clean</phase>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

这样，当执行 install / deploy 后就会将符号占用替换为实际值。更多的配置，可见官网。

插件的实现原理

默认的插件会生成一个简版的 pom.xml 文件.flattened-pom.xml，然后在 install、deploy 阶段使用压缩后的 .flattened-pom.xml 文件，替换原来的pom.xml文件。

需要注意的点

1. 不是所有的引用符都可以被替换为实际的值，自 Maven 3.5.0-beta-1 开始，可以使用 ${revision}、${sha1}、${changelist} 这样的变量作为版本占位符，只有这样的引用符才可以被替换。