如何实施一致的Java代码格式？

Question

null

spotless {
  java {
    toggleOffOn()
    eclipse().configFile("${project.rootDir}/tools/eclipse-java-formatter.xml")
    indentWithSpaces()
    removeUnusedImports()
  }
}

这种方法满足了除2.2之外的所有要求，即IntelliJ生成的任何代码在符合格式化规则之前必须重新格式化。另一个问题是，当代码重新格式化时，导入似乎被任意重新排序。这会产生大量虚假的更改，从而使请求更难检查。

是否有其他方法（例如CheckStyle）没有这些缺点？

Answer 1

您可以使用Google Java格式，该格式具有用于上述IDE的插件（IntelliJ IDEA、Eclipse)，它提供了与Maven、Gradle或SBT等工具的集成，并提供了作为提交前钩子或在使用Github操作将代码推送到Github时运行格式化程序的方法。

在他们的自述文件中，他们还提到了导入问题以及如何为IntelliJ IDEA解决这个问题，并提供了更多的见解，例如：如何在Spotless Gradle插件上处理这个问题，在使用Maven Spotless插件时，或者在Github操作中处理这个问题。

对于您的具体情况来说，一个缺点可能是该工具强制执行Google Java style guide，正如Oracle Java Magazine中所描述的，Oracle Java团队称赞并推荐了Google Java style guide。它还提供了使用AOSP代码样式的选项。

spotless {
    java {
        importOrder() // standard import order
        importOrder('java', 'javax', 'com.acme', '') // or importOrderFile
        // You probably want an empty string at the end - all of the
        // imports you didn't specify explicitly will go there.

        removeUnusedImports()

        googleJavaFormat() // has its own section below
        eclipse()          // has its own section below
        prettier()         // has its own section below
        clangFormat()      // has its own section below

        licenseHeader '/* (C) $YEAR */' // or licenseHeaderFile
    }
}