Maven使用${revision}实现多模块版本统一管理及注意事项

在 Maven 中，确实可以利用 ${revision} 来实现多模块项目的版本统一管理，尤其是在使用一些高级特性如 Maven Release Plugin 或者是在 CI/CD 流程中动态设置版本时。${revision} 是一个特殊的变量，它允许你在构建时动态地使用或设定项目的版本号，这对于自动化的版本管理和持续集成特别有用。

Maven Release Plugin 与 ${revision}

Maven Release Plugin 支持一种模式，可以在执行 mvn release:prepare 时自动替换 ${revision} 为当前的项目版本号。这在准备发布新版本时非常有用，因为你可以事先在 POM 文件中使用 ${revision}，然后由插件根据实际情况填充正确的版本号。

示例

假设你有一个简单的多模块 Maven 项目结构，希望在不同模块的版本管理上利用 ${revision}。

1. 父 pom.xml 配置:

<project><modelVersion>4.0.0</modelVersion><groupId>com.example</groupId><artifactId>my-parent</artifactId><version>${revision}</version><packaging>pom</packaging><properties><!-- 注意：此处也可以直接使用 ${revision}，但在某些场景下可能不适用 --><revision>1.1.0-dev-SNAPSHOT</revision></properties><modules><module>module-a</module><module>module-b</module></modules><!-- 其他配置... -->
</project>

1. 子模块 pom.xml 配置:

<project><parent><groupId>com.example</groupId><artifactId>my-parent</artifactId><version>${revision}</version></parent><modelVersion>4.0.0</modelVersion><artifactId>module-a</artifactId><!-- 由于继承了父 pom 的 ${revision}，此处不需要单独定义版本 --><!-- 其他配置... -->
</project>

使用 Maven Release Plugin

为了使 ${revision} 能够正确解析并插入实际的版本号，你需要配置 Maven Release Plugin。在你的根 pom.xml 中添加以下插件配置：

<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-release-plugin</artifactId><version>3.0.0-M5</version><configuration><autoVersionSubmodules>true</autoVersionSubmodules><!-- 其他配置选项，比如标签格式、分支策略等 --></configuration></plugin></plugins>
</build>

打包配置

<build><pluginManagement><plugins><!-- maven-surefire-plugin 插件，用于运行单元测试。 --><!-- 注意，需要使用 3.0.X+，因为要支持 Junit 5 版本 --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-surefire-plugin</artifactId><version>${maven-surefire-plugin.version}</version></plugin><!-- maven-compiler-plugin 插件，解决 Lombok + MapStruct 组合 --><!-- https://stackoverflow.com/questions/33483697/re-run-spring-boot-configuration-annotation-processor-to-update-generated-metada --><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-compiler-plugin</artifactId><version>${maven-compiler-plugin.version}</version><configuration><annotationProcessorPaths><path><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId><version>${spring.boot.version}</version></path><path><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>${lombok.version}</version></path><path><groupId>org.mapstruct</groupId><artifactId>mapstruct-processor</artifactId><version>${mapstruct.version}</version></path></annotationProcessorPaths></configuration></plugin></plugins></pluginManagement><plugins><!-- 统一 revision 版本 --><plugin><groupId>org.codehaus.mojo</groupId><artifactId>flatten-maven-plugin</artifactId><version>${flatten-maven-plugin.version}</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><!-- 使用 huawei / aliyun 的 Maven 源，提升下载速度 --><repositories><!--      <repository><id>huaweicloud</id><name>huawei</name><url>https://mirrors.huaweicloud.com/repository/maven/</url></repository>--><repository><id>aliyunmaven</id><name>aliyun</name><url>https://maven.aliyun.com/repository/public</url></repository></repositories>

```

执行流程

• 当你准备好发布项目时，运行 mvn release:prepare。这个命令会自动将 ${revision} 替换为当前的版本号（如从 1.0-SNAPSHOT 到 1.0），并相应地更新所有受影响的 POM 文件。

• 接着，你可以运行 mvn release:perform 完成构建、测试并部署到你的仓库。

注意事项

• 使用 ${revision} 需要谨慎，特别是在与其他插件或功能（如版本号范围）结合使用时，可能会遇到兼容性问题。

• 确保你的 CI/CD 环境支持这种动态版本处理，并且团队成员都理解这一流程。

通过这种方式，Maven 和 ${revision} 可以帮助你高效地管理多模块项目的版本一致性，尤其是在频繁迭代和发布的场景下。

高级应用与最佳实践

动态版本控制策略

在复杂的CI/CD流程中，${revision} 的灵活性尤为显著。通过结合环境变量或CI服务器提供的特性（如GitLab CI/CD的 $CI_COMMIT_REF_NAME 或Jenkins的 $GIT_BRANCH），可以在不同的构建环境下指定或计算出特定的版本后缀，例如区分开发、测试和生产环境的构建。这样，你不仅能够确保版本的一致性，还能精确追踪每个构建产物对应的源代码状态。

自动化版本升级策略

利用 Maven Release Plugin 的同时，可以通过自定义脚本或使用更高级的Maven插件（如 Versions Maven Plugin）来进一步自动化版本管理过程。例如，在预发布阶段自动递增版本号（从 1.0.0 到 1.0.1-SNAPSHOT），或是基于语义化版本控制(SemVer)原则自动调整版本号以反映功能添加、bug修复或重大变更。

版本锁定与依赖管理

在多模块项目中，通过在父POM中统一管理 <dependencyManagement> 部分，可以确保所有子模块使用的依赖版本一致。当依赖的版本也使用 ${revision} 时，需注意这可能会引入依赖解析的不确定性，特别是在跨模块依赖的情况下。因此，对于公共依赖，明确指定版本号或通过属性管理具体版本是一种更为稳健的做法，以避免不必要的构建混乱。

回滚与审计

在使用 ${revision} 实现版本动态管理时，良好的回滚策略和版本审计变得尤为重要。确保每一次版本变更都能被清晰记录，并能迅速回退到之前的稳定版本。Maven的版本控制策略与版本控制系统（如Git）紧密结合，使得版本回溯和审计变得相对直观易行。

结论

综上所述，Maven中的 ${revision} 变量是实现多模块项目版本统一管理的强大工具，特别是在结合CI/CD流程和高级插件配置时。它不仅提升了版本控制的灵活性和自动化程度，还促进了开发团队之间的协作和构建过程的透明度。然而，要充分发挥其效能，还需深入理解其工作原理，谨慎设计版本策略，并确保整个团队对这一机制有共同的认知和操作规范。通过这些综合措施，可以有效提升软件开发的质量与效率，降低因版本管理不当带来的风险。