Mockito项目中Spotless代码格式化插件的优化实践

在Java项目开发中，代码风格的统一性对团队协作至关重要。Mockito项目近期对其使用的Spotless代码格式化插件进行了两项重要优化：将其改造为约定插件(Convention Plugin)架构，并解决了Google Java Format在JDK 21下的兼容性问题。

约定插件化改造

传统Gradle插件配置方式通常直接在根项目的subprojects块中声明，这种方式虽然简单，但随着项目复杂度增加会带来维护困难。Mockito团队将Spotless配置重构为约定插件，这是一种更模块化的Gradle插件组织方式。

约定插件的优势在于：

1. 配置逻辑被封装在独立模块中
2. 可以通过简单的plugins块应用到子项目
3. 配置变更只需修改一处即可全局生效
4. 更符合Gradle的最佳实践

改造后的结构将Spotless配置从根build.gradle迁移到独立的约定插件脚本中，使项目构建逻辑更加清晰。

JDK 21兼容性问题解决

项目在升级到JDK 21后遇到了Google Java Format的运行时错误，具体表现为访问权限异常。这是由于JDK模块系统对内部API访问的限制导致的。

错误信息显示：

无法访问jdk.compiler模块中的com.sun.tools.javac.parser.Tokens$TokenKind类

根本原因是Google Java Format工具尝试通过反射访问JDK内部API，而JDK 21加强了模块访问控制。解决方案是确保Gradle构建时传递正确的JVM参数：

--add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED

值得注意的是，这个问题可能被用户本地的gradle.properties配置覆盖，因此团队在项目配置中显式声明了这些参数，确保在所有环境中一致运行。

实践建议

对于类似项目，我们建议：

1. 尽早采用约定插件架构组织构建逻辑
2. 对JDK模块化保持敏感，特别是使用涉及反射的工具链
3. 统一管理Gradle属性，避免本地配置干扰
4. 考虑在CI环境中验证不同JDK版本的兼容性

Mockito的这次优化不仅解决了具体技术问题，也为大型Java项目的构建系统优化提供了参考范例。这种架构调整使得代码格式化这一质量门禁更加可靠，为项目的可持续发展奠定了基础。