Maven多模块版本统一管理

Maven多模块版本统一管理

遇到的问题

​ 在开发一些工具包或者平常微服务代码编辑的时候分了很多模块,类似下图:

​ 其中kcommon是父级模块,kcommon-aop、kcommon-auth、kcommon-common、kcommon-constant、kcommon-crypt、kcommon-file是子级模块。

​ 这么多子级模块,就会存在一个比较麻烦的问题：更新父级版本号的时候，如果想让子级模块的版本号与父级模块的版本号保持一致，每次改动版本号都要手动去更改每一个子模块的版本号，非常的不方便，所以：

解决问题

方案1：

​ 在父级模块kcommon的pom.xml中标签中定义一个变量“version-control”,然后在子级模块中的标签中指定该变量,如下图:

​ 这样做确实可以做到,修改“version-control”中的版本号就能修改所有子级模块的版本号,打包也没有问题,但是有个小细节,子模块的标签中的引用该变量会报错,如下图:

​ 如果不修改parent的版本号,新版本号的子集模块依赖的还是旧的父级模块,还是需要去手动修改每一个子集模块的父级模块的版本号,非常的不方便。

弥补方案1的方案2:

​ 要解决子集模块的父级模块版本号使用动态变量指定的问题，从 Maven 3.5.0-beta-1 开始，你可以在 Maven POM 文件中使用以下几种变量作为版本占位符，全局通用，且可以动态变更版本号：

1. ${revision}：这个变量用于表示项目的版本号，可以在 POM 文件中定义，并在其他地方使用。
2. ${changelist}：这个变量用于表示构建的 SVN、Git 或 Mercurial 修订号或提交号。需要使用相应的插件来生成它。
3. ${sha1}：这个变量用于表示构建的 Git 或 Mercurial SHA-1 哈希值。同样，需要使用相应的插件来生成它。
4. ${changelist.base}：这个变量与 ${changelist} 类似，但它表示基准版本的修订号或提交号

注意:只能命名成这4种固定的占位符,不可以命名成其他的字符，否则会飘红无效

占位符使用演示

注意：老版本的Idea下使用${revision}定义Parent版本时会提示错误“Reports that usage of properties in modules parent definition is prohibited”，但并不影响使用，只是Idea不支持这种写法而已,升级IDea版本也可以解决

父模块:

在父模块的pom.xml文件的标签中定义标签,这里定义的版本号为1.4.1-SNAPSHOT

	<artifactId>kcommon</artifactId>
    <version>${revision}</version>
    <packaging>pom</packaging>

	<properties>
        <!-- 全局版本控制,如果要修改版本号，修改此处即可-->
        <revision>1.4.1-SNAPSHOT</revision>
    </properties>

子模块

可以直接使用${revision}指定父模块的版本号：

 <parent>
        <artifactId>kcommon</artifactId>
        <groupId>com.xxxx.xxxx</groupId>
        <version>${revision}</version>
        <relativePath>../pom.xml</relativePath>
   </parent>

也可以指定子级模块本身的版本号：

    <modelVersion>4.0.0</modelVersion>
    <version>${revision}</version>
    <artifactId>kcommon-file</artifactId>

也可以在dependency标签中，指定依赖的其他子模块的版本号：

        <dependency>
            <groupId>com.xxxxx.xxxxx</groupId>
            <artifactId>kcommon-aop</artifactId>
            <version>${revision}</version>
        </dependency>

install或者depoy

​ 按照以上操作,是可以成功install或者depoy的,但是如果别人的工程中引用了你的包,然后打包的时候就会提示:${revision}占位符出错：

​ 这是因为，你打的包，把占位符也原封不动打上去了，应该要把占位符替换成具体的版本号再depoy到远程仓库。

如何解决:

可以使用插件flatten-maven-plugin来解决:

<plugins> 
		<plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>flatten-maven-plugin</artifactId>
                <version>1.1.0</version>
                <configuration>
                    <!-- 是否更新pom文件，此处还有更高级的用法 -->
                    <updatePomFile>true</updatePomFile>
                    <flattenMode>resolveCiFriendliesOnly</flattenMode>
                </configuration>
                <executions>
                    <execution>
                        <id>flatten</id>
                        <phase>process-resources</phase>
                        <goals>
                            <goal>flatten</goal>
                        </goals>
                    </execution>
                    <execution>
                        <id>flatten.clean</id>
                        <phase>clean</phase>
                        <goals>
                            <goal>clean</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>