Google Java Format Plugin

一个简洁的VS Code扩展，用于运行Google Java Format工具格式化Java代码。支持Google Style和AOSP (Android Open Source Project) 格式之间的快速切换。

特性

✅ 简洁直接: 直接调用系统中的google-java-format工具
✅ 双重风格: 支持Google Style和AOSP格式
✅ 一键切换: 右键菜单快速切换格式风格
✅ 范围格式化: 支持格式化选中的代码片段
✅ 轻量级: 无需下载，依赖系统安装的工具

前置要求

需要在系统中安装google-java-format工具。推荐使用包管理器安装：

macOS (Homebrew)

brew install google-java-format

Ubuntu/Debian

sudo apt-get install google-java-format

手动安装

从 Google Java Format Releases 下载jar文件，并创建启动脚本。

Java版本兼容性问题

⚠️ 重要提示: Google Java Format需要Java 11或更高版本运行，如果你的系统只有Java 8，请参考以下解决方案：

🚀 快速安装脚本（推荐）

我们提供了一个自动安装脚本，可以自动检测和安装Java以及Google Java Format：

# 下载并运行安装脚本
curl -fsSL https://raw.githubusercontent.com/rongwoxiangxiang/google-format-plugin/main/install-google-java-format.sh | bash

# 或者克隆仓库后运行
git clone https://github.com/rongwoxiangxiang/google-format-plugin.git
cd google-format-plugin
./install-google-java-format.sh

脚本功能:

自动检测当前Java版本
如果需要，安装Java 11
安装Google Java Format
配置环境变量
验证安装结果

方案1: 安装Java 11（推荐）

macOS

# 使用Homebrew安装OpenJDK 11
brew install openjdk@11

# 添加到PATH（添加到 ~/.zshrc 或 ~/.bash_profile）
export PATH="/usr/local/opt/openjdk@11/bin:$PATH"

# 设置JAVA_HOME（添加到 ~/.zshrc 或 ~/.bash_profile）
export JAVA_HOME=$(/usr/libexec/java_home -v 11)

# 重新加载配置
source ~/.zshrc

Ubuntu/Debian

# 安装OpenJDK 11
sudo apt update
sudo apt install openjdk-11-jdk

# 设置默认Java版本
sudo update-alternatives --config java

方案2: 多Java版本管理

使用SDKMAN（推荐）

# 安装SDKMAN
curl -s "https://get.sdkman.io" | bash
source ~/.sdkman/bin/sdkman-init.sh

# 安装Java 11
sdk install java 11.0.19-tem

# 临时切换到Java 11
sdk use java 11.0.19-tem

# 设为默认版本
sdk default java 11.0.19-tem

手动切换Java版本

# macOS - 创建Java版本切换脚本
echo 'alias java8="export JAVA_HOME=$(/usr/libexec/java_home -v 1.8)"' >> ~/.zshrc
echo 'alias java11="export JAVA_HOME=$(/usr/libexec/java_home -v 11)"' >> ~/.zshrc

# 使用方法
java11  # 切换到Java 11
google-java-format --version  # 现在可以正常使用
java8   # 切回Java 8（如需要）

方案3: 使用旧版本Google Java Format（Java 8兼容）

如果必须使用Java 8，可以下载兼容Java 8的旧版本：

# 创建工具目录
mkdir -p ~/tools/google-java-format
cd ~/tools/google-java-format

# 下载兼容Java 8的版本（如1.7版本）
wget https://github.com/google/google-java-format/releases/download/v1.7/google-java-format-1.7-all-deps.jar

# 创建启动脚本
cat > google-java-format << 'EOF'
#!/bin/bash
java -jar ~/tools/google-java-format/google-java-format-1.7-all-deps.jar "$@"
EOF

# 添加执行权限
chmod +x google-java-format

# 添加到PATH
export PATH="$HOME/tools/google-java-format:$PATH"

方案4: VS Code插件配置

如果使用了自定义路径或jar文件，在VS Code中配置：

{
  "google-java-format.executable-path": "/path/to/your/google-java-format",
  // 或者直接使用jar文件
  "google-java-format.executable-path": "java -jar /path/to/google-java-format.jar"
}

验证安装

# 检查Java版本
java -version
javac -version

# 检查Google Java Format
google-java-format --version

# 测试格式化
echo "class Test{public static void main(String[]args){System.out.println(\"Hello\");}}" | google-java-format -

使用方法

设置为默认格式化工具

在VS Code设置中添加：

{
  "[java]": {
    "editor.defaultFormatter": "google-java-format.google-java-format-plugin"
  }
}

格式化代码

整个文件: Shift + Alt + F (Windows/Linux) 或 Shift + Option + F (macOS)
选中代码: 选择代码后使用相同快捷键
右键菜单: 右键选择"格式化文档"或"格式化选择"

切换格式风格

方法1: 右键菜单 → "切换格式化风格（Google/AOSP）"
方法2: 命令面板 (Ctrl+Shift+P) → "切换格式化风格（Google/AOSP）"

配置选项

在VS Code设置中搜索 "google-java-format" 可以找到以下选项：

`google-java-format.executable-path`

类型: string
默认值: "google-java-format"
描述: Google Java Format可执行文件路径。如果工具已添加到PATH，使用默认值即可

`google-java-format.style`

类型: string
可选值: "google", "aosp"
默认值: "google"
描述: 代码格式化风格

`google-java-format.extra-args`

类型: string
默认值: ""
描述: 传递给Google Java Format的额外命令行参数

配置示例

{
  "google-java-format.executable-path": "/usr/local/bin/google-java-format",
  "google-java-format.style": "aosp",
  "google-java-format.extra-args": "--skip-sorting-imports"
}

格式风格对比

Google Style (默认)

class Example {
  void method() {
    if (condition) {
      doSomething();
    }
  }
}

AOSP Style

class Example {
    void method() {
        if (condition) {
            doSomething();
        }
    }
}

故障排除

常见问题

问题: 提示"无法启动Google Java Format" 解决:

确保已安装google-java-format工具
检查executable-path配置是否正确
验证工具是否在PATH中：which google-java-format
检查Java版本：java -version（需要Java 11+）

问题: 格式化没有效果解决:

检查代码是否有语法错误
查看VS Code输出面板的错误信息
尝试在终端手动运行工具测试

问题: "UnsupportedClassVersionError" 或 Java版本不兼容解决:

检查当前Java版本：java -version
确保使用Java 11或更高版本
参考上面的"Java版本兼容性问题"章节切换Java版本
或下载兼容Java 8的旧版本Google Java Format

问题: macOS上Homebrew安装失败解决:

# 先安装Java 11
brew install openjdk@11

# 设置环境变量
export JAVA_HOME=/usr/local/opt/openjdk@11

# 再安装google-java-format
brew install google-java-format

问题: 在VS Code中配置jar文件路径解决:

{
  "google-java-format.executable-path": "java -jar /full/path/to/google-java-format-x.x.x-all-deps.jar"
}

验证安装

在终端运行以下命令验证安装：

google-java-format --version

开发

本地开发

git clone https://github.com/rongwoxiangxiang/google-format-plugin.git
cd google-format-plugin
npm install
npm run compile

调试插件

方式1: 开发模式（推荐）

在VS Code中打开插件项目目录
确保已编译：npm run compile
按 F5 启动扩展开发主机
会打开一个新的VS Code窗口（标题显示"[扩展开发主机]"）
在新窗口中打开test/Example.java文件测试

方式2: 打包安装

# 安装打包工具
npm install -g vsce

# 打包扩展
vsce package

# 会生成 google-java-format-plugin-1.0.0.vsix 文件
# 在VS Code中: Extensions → Install from VSIX → 选择生成的.vsix文件

方式3: 本地符号链接安装

# macOS/Linux
ln -s "$(pwd)" ~/.vscode/extensions/google-java-format-plugin

# Windows
mklink /D "%USERPROFILE%\.vscode\extensions\google-java-format-plugin" "$(pwd)"

测试步骤

打开test/Example.java文件（格式混乱的Java代码）
使用 Shift + Alt + F 格式化
测试切换格式风格：右键 → "切换格式化风格（Google/AOSP）"
再次格式化，观察风格变化

调试技巧

查看输出面板: View → Output → 选择"Google Java Format"
使用开发者工具: Help → Toggle Developer Tools
设置断点: 在src/extension.ts中设置断点进行调试

致谢

本项目参考了以下开源项目：

ilkka/vscode-google-java-format - 简洁的实现思路
JoseVSeb/google-java-format-for-vs-code - 功能特性参考
Google Java Format - 核心格式化工具

许可证

本项目使用 Apache License 2.0 许可证。

详细许可证内容请查看 LICENSE.md 文件。

享受使用！ 🚀

Google Java Format Plugin