google-java-format

google-java-format是一个重新格式化Java源代码以符合Google Java代码风格的程序。

使用格式化程序

通过命令行

下载格式化程序并使用以下命令运行：

java -jar /path/to/google-java-format-${GJF_VERSION?}-all-deps.jar <选项> [文件...]

格式化程序可以作用于整个文件、特定行（--lines）、特定偏移量（--offset），默认输出到标准输出或就地修改（--replace）。

要重新格式化特定补丁中已更改的行，请使用google-java-format-diff.py。

***注意：***格式化程序的算法不可配置。这是为了统一我们的代码格式而做出的有意设计决策。

IntelliJ、Android Studio和其他JetBrains IDE

插件仓库中提供了google-java-format IntelliJ插件。要安装它，请转到IDE的设置并选择插件类别。点击市场标签，搜索google-java-format插件，然后点击安装按钮。

默认情况下，插件将被禁用。要在当前项目中启用它，请转到文件→设置...→google-java-format设置（在macOS上为IntelliJ IDEA→偏好设置...→其他设置→google-java-format设置），并勾选启用google-java-format复选框。（首次打开项目时会显示一个通知，提供为您执行此操作的选项。）

要在新项目中默认启用它，请使用文件→其他设置→默认设置...。

启用后，它将替换正常的重新格式化代码和优化导入操作。

IntelliJ JRE配置

google-java-format插件使用了一些没有额外配置就无法使用的内部类。要使用该插件，请转到帮助→编辑自定义VM选项...并粘贴以下行：

--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED

完成后，重启IDE。

Eclipse

可以从发布页面下载最新版本的google-java-format Eclipse插件。将其放入Eclipse的drop-ins文件夹以激活插件。

该插件添加了一个google-java-format格式化程序实现，可以在窗口 > 偏好设置 > Java > 代码风格 > 格式化程序 > 格式化程序实现中进行配置。

第三方集成

• Visual Studio Code
  • google-java-format-for-vs-code
• Gradle插件
  • spotless
  • sherter/google-java-format-gradle-plugin
• Apache Maven插件
  • spotless
  • spotify/fmt-maven-plugin
  • talios/googleformatter-maven-plugin
  • Cosium/maven-git-code-format： 一个自动将google-java-format部署为pre-commit git钩子的maven插件。
• SBT插件
  • sbt/sbt-java-formatter
• Github Actions
  • googlejavaformat-action： 当你推送到github时自动格式化你的Java文件

作为库使用

格式化程序可以在生成Java代码的软件中使用，以输出更易读的Java代码。只需在你的maven/gradle等配置中包含该库即可。

google-java-format使用内部javac API来解析Java源代码。由于JEP 396：默认强封装JDK内部，在JDK 16及更新版本上运行时需要以下JVM标志：

--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED

Maven

<dependency>
  <groupId>com.google.googlejavaformat</groupId>
  <artifactId>google-java-format</artifactId>
  <version>${google-java-format.version}</version>
</dependency>

Gradle

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

然后你可以通过formatSource方法使用格式化程序。例如：

String formattedSource = new Formatter().formatSource(sourceString);

或

CharSource source = ...
CharSink output = ...
new Formatter().formatSource(source, output);

你的起点应该是com.google.googlejavaformat.java.Formatter的实例方法。

从源代码构建

mvn install

贡献

请查看贡献者指南了解详情。

许可证

Copyright 2015 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.