当前位置：首页 > article >正文

Maven - 优雅的管理多模块应用的统一版本号

article 2024/12/1 4:15:24

文章目录

概述
一、使用 `versions-maven-plugin` 插件
- - 1. 在主 `pom.xml` 中定义插件
  - 2. 修改版本号
  - 3. 回退修改
  - 4. 提交修改
二、使用占位符统一管理版本号
- - 1. 在主 `pom.xml` 中定义占位符
  - 2. 使用 `flatten-maven-plugin` 插件自动替换占位符
  - 3. 修改版本号
  - 4. 为什么这种方式更方便？
总结

概述

在大型项目中，尤其是涉及多个子模块的Maven项目，统一管理版本号是一个棘手的问题。尤其当项目的子模块多达几十个时，手动修改每个模块的版本号不仅容易出错，还会导致大量的重复工作。如何高效且准确地管理这些版本号，成为了开发中的一大挑战。

一、使用 `versions-maven-plugin` 插件

versions-maven-plugin 是一个非常强大的插件，它能帮助我们轻松管理整个项目中所有模块的版本号。无论是修改依赖版本，还是修改整个项目的版本号，都可以通过这个插件轻松实现。

1. 在主 `pom.xml` 中定义插件

首先，在主 pom.xml 中添加 versions-maven-plugin 插件的配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>versions-maven-plugin</artifactId>
            <version>2.3</version>
        </plugin>
    </plugins>
</build>

2. 修改版本号

如果要修改所有子模块的版本号，只需执行以下命令：

mvn versions:set -DnewVersion=2.0

这条命令会将项目中所有模块的版本号统一更新为 2.0。

3. 回退修改

如果在修改版本号之后后悔了，可以通过以下命令撤销更改：

mvn versions:revert

4. 提交修改

如果一切确认无误，可以通过 versions:commit 命令来提交修改：

mvn versions:commit

这样， pom.xml 中的父模块引用、以及所有子模块中的版本号都会自动被更新，简化了很多手动操作的步骤。

这种方式的优点在于，无论项目中有多少个子模块，只需要执行一次命令就能完成版本号的统一更新，避免了漏改和手动修改的麻烦。

二、使用占位符统一管理版本号

除了 versions-maven-plugin 插件外，还有一种更便捷的方式来管理项目版本号，这种方法通过使用占位符来管理版本号，并结合 flatten-maven-plugin 插件在编译时自动替换占位符值。

1. 在主 `pom.xml` 中定义占位符

在主 pom.xml 中定义一个 ${revision} 占位符：

<properties>
  <revision>1.2.0</revision>
</properties>

在子模块的 pom.xml 中，你可以通过占位符 ${revision} 来引用这个版本号。例如：

<dependency>
  <groupId>com.example</groupId>
  <artifactId>module-a</artifactId>
  <version>${revision}</version>
</dependency>

2. 使用 `flatten-maven-plugin` 插件自动替换占位符

为了让这个占位符能够在编译和打包时自动替换成实际的版本号，需要在主 pom.xml 中添加 flatten-maven-plugin 插件的配置：

<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>flatten-maven-plugin</artifactId>
            <version>1.2.7</version>
            <configuration>
                <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>
</build>