深入理解ruoyi-vue-pro项目中的flatten-maven-plugin配置优化

在基于Maven的多模块Java项目中，版本管理和依赖处理是一个需要特别注意的技术点。本文将以ruoyi-vue-pro项目为例，深入分析flatten-maven-plugin插件的使用方式及其优化方案。

flatten-maven-plugin插件的作用

flatten-maven-plugin是Maven生态中一个重要的插件，主要用于生成"扁平化"的POM文件。在多模块项目中，原始POM可能包含变量、父POM引用等动态内容，而扁平化POM则将这些内容解析为具体的值，便于发布到Maven仓库后被其他项目正确引用。

原配置的问题分析

ruoyi-vue-pro项目原先使用的是resolveCiFriendliesOnly模式：

<flattenMode>resolveCiFriendliesOnly</flattenMode>

这种模式下，插件只会解析CI友好的变量（如${revision}、${sha1}等），但不会替换依赖中的版本变量。这会导致生成的POM中依赖版本仍保留变量形式：

<dependency>
  <groupId>cn.iocoder.boot</groupId>
  <artifactId>yudao-module-system-api</artifactId>
  <version>${revision}</version>
</dependency>

当其他项目引用这些模块时，由于无法正确解析${revision}变量，会导致依赖无法下载的问题。

优化方案探讨

方案一：使用oss或ossrh模式

将flattenMode改为oss或ossrh模式：

<flattenMode>oss</flattenMode>

这种模式专为开源项目设计，会完全解析所有变量，生成包含具体版本号的POM：

<dependency>
  <groupId>cn.iocoder.boot</groupId>
  <artifactId>yudao-module-system-api</artifactId>
  <version>2.1.0-jdk8-snapshot</version>
  <scope>compile</scope>
</dependency>

这种方式的优点是简单直接，生成的POM文件可以被任何项目直接引用。缺点是如果项目内部模块间有大量相互依赖，版本更新时需要同步修改多处。

方案二：分离版本变量

另一种更精细的控制方案是分离版本变量的使用：

1. 在根POM中定义两个版本属性：

<properties>
    <revision>2.1.0-jdk8-snapshot</revision>
    <yudao.version>${revision}</yudao.version>
</properties>

2. 在子模块中，parent块使用${revision}：

<parent>
    <groupId>cn.iocoder.boot</groupId>
    <artifactId>yudao-module-infra</artifactId>
    <version>${revision}</version>
</parent>

3. 依赖声明中使用${yudao.version}：

<dependency>
    <groupId>cn.iocoder.boot</groupId>
    <artifactId>yudao-module-system-api</artifactId>
    <version>${yudao.version}</version>
</dependency>

这种方式的优点是：

• 保持了版本号的集中管理
• 允许其他项目使用自己的${revision}变量
• 生成的POM中依赖版本会被正确解析

最佳实践建议

对于类似ruoyi-vue-pro这样的开源多模块项目，推荐采用以下策略：

1. 使用oss或ossrh模式的flatten-maven-plugin配置，确保发布的POM文件完全解析所有变量。

2. 对于项目内部模块间的依赖，可以考虑使用项目级别的版本属性（如${yudao.version}）而非直接使用${revision}，提高灵活性。

3. 在持续集成环境中，确保版本号能够被正确替换，可以使用Maven的release插件或CI脚本自动设置版本号。

ruoyi-vue-pro项目最终采用了第一种优化方案，将flattenMode改为oss模式，这是一个合理的选择，特别适合需要频繁发布到中央仓库的开源项目。这种配置确保了项目模块在被其他项目引用时，所有依赖都能被正确解析，提高了项目的可用性和易用性。