如何更新 Spring Boot build.gradle 以确保团队中的每个开发人员都使用 google-java-format 以及一些常见问题

Question

我将以下依赖项添加到我的分支中的 build.gradle 文件中。

dependencies {
  implementation 'com.google.googlejavaformat:google-java-format:1.24.0'
}

从这里开始，我很困惑。如何确保代码格式化程序使用 google-java-format 而不是默认的代码格式化程序？是否需要从 Marketplace 安装插件？我正在尽力遵循文档。

文档接着说“您可以通过 formatSource 方法使用格式化程序”并显示一个示例。这是否意味着我每次都必须通过这些方法运行代码才能格式化某些内容？

Answer 1

如果我理解您的问题/意图，您想使用 google-java-format 格式化您的 Spring Boot 代码库/项目。如果是这样，那么您所拥有的内容不正确。您并不打算开发基于 google-java-format 或工具的库，您只是想使用它。

如果这是正确的，那么您可以将一个 Gradle 插件应用到您的构建中，该插件将使用 google-java-format 格式化您的项目：Spotless Gradle 插件。

应用于您的项目并配置为使用 google-java-format:

plugins {
  id("com.diffplug.spotless") version "7.0.0.BETA3"
}


spotless {
  java {
    googleJavaFormat()
  }
}

更多详细信息请参见文档这里。