diffplug/spotless中如何使用checkstyle.xml配置进行格式校验修复

首先明确结论：你可以将自定义checkstyle.xml配置引入2.11.0版本的diffplug/spotless中，但不是所有checkstyle规则都支持spotless:apply自动修复，仅部分可自动修正的规则能被自动修复，剩余不支持自动修复的规则只会在检查阶段抛出违规提示。

具体配置方法（Maven环境） #

你需要在pom.xml的spotless插件配置中新增checkstyle规则引入配置，参考配置示例如下：

<plugin>
  <groupId>com.diffplug.spotless</groupId>
  <artifactId>spotless-maven-plugin</artifactId>
  <version>2.11.0</version>
  <configuration>
    <java>
      <!-- 保留原有google-java-format配置
      <googleJavaFormat/>
      <!-- 引入自定义checkstyle配置 -->
      <checkstyle>
        <configLocation>checkstyle.xml</configLocation>
        <!-- Java 8环境建议搭配8.x系列版本的checkstyle，避免版本兼容性问题 -->
        <version>8.45.1</version>
      </checkstyle>
    </java>
  </configuration>
  <executions>
    <execution>
      <goals>
        <goal>apply</goal>
      </goals>
      <phase>compile</phase>
    </execution>
  </executions>
</plugin>

注意事项 #

• 仅格式类规则支持自动修复，包括缩进、空格、换行、导入排序、多余符号移除等有明确修正方案的规则
• 涉及代码逻辑、命名规范、未使用变量、魔法值等非格式类的checkstyle规则无法自动修复，仅会在spotless:check阶段提示违规，需要手动修改
• 同时启用google-java-format和自定义checkstyle两套规则时，需要提前校验两套规则不存在冲突，避免出现执行spotless:apply后仍然触发checkstyle违规的问题

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