Maven Git Commit ID插件在8.0.0版本后子模块生成空git.properties问题分析

问题背景

Maven Git Commit ID插件是一个广泛使用的Maven插件，用于在构建过程中自动生成包含Git版本信息的属性文件。在8.0.0版本更新后，用户在多模块Maven项目中使用injectAllReactorProjects=true配置时，发现子模块生成的git.properties文件内容为空，仅包含文件头注释。

问题现象

当项目结构包含父POM和多个子模块时，配置如下：

<configuration>
  <injectAllReactorProjects>true</injectAllReactorProjects>
  <generateGitPropertiesFile>true</generateGitPropertiesFile>
  <generateGitPropertiesFilename>${project.build.outputDirectory}/git.properties</generateGitPropertiesFilename>
</configuration>

在8.0.0及以上版本中，父模块能正确生成包含Git信息的properties文件，但所有子模块生成的git.properties文件内容为空。回退到7.0.0版本则问题消失。

技术分析

通过对比7.0.0和8.0.0版本的代码变更，发现问题源于一个关键提交中对Properties对象初始化的修改。在8.0.0版本中，代码从直接使用contextProperties改为：

properties = new Properties(contextProperties);

而7.0.0版本则是：

properties = contextProperties;

深入研究发现，当使用new Properties(contextProperties)构造函数时，虽然设置了默认属性，但在后续操作中这些属性似乎"消失"了。这与Java Properties类的预期行为不符，根据Java文档，这种构造函数应该创建一个包含指定默认值的新属性列表。

解决方案

项目维护者提出了两种修复方案：

1. 回退到直接使用contextProperties的方式
2. 改用以下初始化方式：

properties = new Properties();
properties.putAll(contextProperties);

最终采用了第二种方案，因为它更明确地表达了意图，同时避免了构造函数可能带来的意外行为。

影响版本

该问题影响8.0.0至9.0.0版本。已在9.0.1版本中修复。对于使用Spring Boot的项目需要注意：

• Spring Boot 3.2.x使用插件6.0.0版本
• Spring Boot 3.3.0升级到插件8.0.2版本，因此会受到影响

最佳实践

对于多模块项目，推荐以下配置方式：

1. 在父POM中定义插件配置
2. 使用runOnlyOnce和injectAllReactorProjects优化构建性能
3. 考虑将Git信息生成分为两个阶段：
   • 在validate阶段收集信息
   • 在后续阶段生成properties文件

示例配置：

<execution>
  <id>git-info-collect</id>
  <phase>validate</phase>
  <goals>
    <goal>revision</goal>
  </goals>
  <configuration>
    <runOnlyOnce>true</runOnlyOnce>
  </configuration>
</execution>
<execution>
  <id>git-info-properties</id>
  <goals>
    <goal>revision</goal>
  </goals>
  <configuration>
    <format>properties</format>
    <generateGitPropertiesFile>true</generateGitPropertiesFile>
  </configuration>
</execution>

总结

这个问题展示了即使是看似简单的API使用变更也可能带来意想不到的行为变化。在Java中，Properties类的构造函数行为需要特别注意，特别是在涉及默认属性时。对于Maven插件开发者而言，多模块项目的属性传递机制需要特别小心处理。

用户遇到类似问题时，可以通过创建最小化复现项目、对比版本差异等方式帮助定位问题。同时，及时更新到修复版本(9.0.1+)是推荐的解决方案。