如何配置Gradle代码风格检查以使用IntelliJ自定义代码风格文件

要实现IntelliJ自定义代码风格（存储在.idea/codeStyles/Project.xml）与Gradle构建时的代码检查共用同一配置文件，Spotless插件是最直接的解决方案——它原生支持导入IntelliJ的代码风格XML，无需额外转换。

步骤1：添加Spotless插件到Gradle配置 #

在你的build.gradle（或build.gradle.kts）中引入Spotless插件：

plugins {
    id 'java'
    id 'com.diffplug.spotless' version '6.25.0' // 建议使用最新稳定版
}

步骤2：配置Spotless使用你的IntelliJ代码风格文件 #

接下来，让Spotless读取你已有的Project.xml文件，并绑定到Java代码风格检查：

spotless {
    java {
        // 指向你的IntelliJ项目级代码风格配置文件
        intelliJ(file("./.idea/codeStyles/Project.xml"))
        
        // 可选：排除不需要检查的文件（比如生成代码）
        exclude '**/generated/**'
        exclude '**/test/resources/**'
    }
}

// 让代码风格检查自动绑定到Gradle的check任务
check.dependsOn spotlessCheck

步骤3：验证配置并使用 #

• 手动运行代码风格检查：执行命令 ./gradlew spotlessCheck，如果代码不符合你的自定义风格，会输出详细的违规信息。
• 自动在构建时检查：现在执行 ./gradlew build 时，Spotless的代码风格检查会自动运行，一旦发现违规，构建会失败。
• 自动格式化代码（可选）：如果需要自动修复风格问题，运行 ./gradlew spotlessApply，插件会按照Project.xml的规则修正代码格式。

确保IntelliJ与Gradle配置同步 #

为了保证单一配置源的一致性：

1. 打开IntelliJ的Settings → Editor → Code Style
2. 在左上角的配置下拉菜单中，确认选中的是Project级别（而非Local或其他）
3. 任何代码风格的修改都会自动保存到.idea/codeStyles/Project.xml，Gradle的Spotless插件会自动读取最新配置

注意事项 #

• Spotless支持IntelliJ代码风格中绝大多数常用规则（缩进、换行、命名、空格等），少数极特殊的IntelliJ独有规则可能不兼容，你可以在Spotless官方文档中查看支持列表。
• 建议将.idea/codeStyles/Project.xml提交到版本控制系统，确保团队成员都使用同一配置。

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