如何让IntelliJ与Maven的Google Java格式化效果一致？

我希望在IntelliJ中使用Google Java格式化（借助google-java-format插件），同时通过Maven在GitHub工作流等场景下检查代码格式合规性。尝试了Spotless插件后，两者格式化结果（如导入顺序、方法参数等）差异明显，但双方均配置为AOSP风格、4空格缩进。我的Spotless配置如下：

<plugin>
    <groupId>com.diffplug.spotless</groupId>
    <artifactId>spotless-maven-plugin</artifactId>
    <version>2.30.0</version>
    <executions>
        <execution>
            <goals>
                <goal>check</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <java>
            <googleJavaFormat>
                <version>1.7</version>
                <style>AOSP</style>
            </googleJavaFormat>
            <removeUnusedImports />
            <licenseHeader>
                <file>../license-header</file>
            </licenseHeader>
        </java>
    </configuration>
</plugin>

请问：

1. 是否遗漏了某些配置？为何基于相同Google格式会有差异？
2. 如何验证IntelliJ确实应用了google-java-format插件，而非其他代码风格配置（已勾选“Enable google-java-format”）？

差异原因与配置调整方案 #

1. 版本不匹配是核心问题 #

你Spotless配置中指定的googleJavaFormat版本是1.7，而IntelliJ的google-java-format插件大概率是更高版本。不同版本的google-java-format对导入排序、方法参数换行等规则的处理会有细微调整，这是最常见的差异来源。

解决：
把Spotless里的<version>1.7</version>改成和IntelliJ插件一致的版本。可以在IntelliJ插件市场查看google-java-format插件的当前版本（比如最新稳定版为1.20.0），同步版本后再测试。

2. Spotless额外规则的影响 #

你的Spotless配置包含<removeUnusedImports />和licenseHeader处理，但IntelliJ的google-java-format插件默认不会自动移除未使用导入，也不处理license头，这会导致格式差异。

解决：

• 在IntelliJ中开启Settings → Editor → General → Auto Import下的Optimize Imports on the Fly，同时确保导入规则和google-java-format对齐（google-java-format的导入排序逻辑是：java.*组 → javax.*组 → 其他组，每组内部按字母排序）。
• 让IntelliJ的license头配置和Spotless保持一致，或者将license头处理从Spotless的格式化流程中拆分出来，避免干扰核心格式化逻辑。

3. IntelliJ原生配置的优先级冲突 #

即使勾选了“Enable google-java-format”，如果IntelliJ原生的Java代码风格配置有自定义规则，可能会覆盖插件行为，比如换行、缩进规则被原生配置修改。

解决：
打开Settings → Editor → Code Style → Java，点击右上角的Set from...，选择google-java-format（插件安装正确时会显示该选项），点击Apply后可确保原生配置与插件规则对齐。

验证IntelliJ是否生效google-java-format插件 #

方法1：直接对比格式化结果 #

• 找一段存在格式争议的代码（比如多参数方法、复杂导入），手动打乱格式。
• 用IntelliJ的Ctrl+Alt+L（Reformat Code）格式化后保存到临时文件。
• 用Spotless命令mvn spotless:apply格式化同一段代码，对比两个文件的内容。如果完全一致，说明插件已生效；若不一致，再排查配置细节。

方法2：查看格式化日志 #

• 打开IntelliJ的Help → Diagnostic Tools → Debug Log Settings，添加日志项：com.google.googlejavaformat.intellij。
• 执行Reformat Code操作，然后通过Help → Show Log in Explorer打开日志文件，搜索Applying google-java-format关键字，出现该内容则说明插件正在工作。

方法3：检查代码风格配置 #

• 打开Settings → Editor → Code Style → Java，查看顶部的配置名称，如果显示为google-java-format，则说明插件已接管代码格式化逻辑；若显示为其他名称，需重新选择google-java-format配置。

内容的提问来源于stack exchange，提问作者Jerome VDL