vandmo/google-java-format

google-java-format

镜像概述

本镜像为https://github.com/google/google-java-format%E5%B7%A5%E5%85%B7%E7%9A%84Docker%E5%8C%96%E7%89%88%E6%9C%AC%E3%80%82google-java-format%E6%98%AFGoogle%E5%BC%80%E5%8F%91%E7%9A%84Java%E4%BB%A3%E7%A0%81%E6%A0%BC%E5%BC%8F%E5%8C%96%E5%B7%A5%E5%85%B7%EF%BC%8C%E9%81%B5%E5%BE%AAGoogle Java风格指南，可自动格式化Java代码，确保代码风格统一。通过Docker镜像形式提供，无需在本地安装JDK或工具本身，简化环境配置，方便跨平台使用。

核心功能和特性

• 代码格式化：支持按照Google Java风格指南格式化Java代码，修复缩进、空格、换行等格式问题
• Docker化优势：无需本地安装依赖（JDK、google-java-format工具），直接通过容器运行
• 跨平台兼容：可在任何支持Docker的操作系统（Linux、macOS、Windows）上使用
• 原生参数支持：完全支持google-java-format工具的所有原生命令行参数，灵活配置格式化行为

使用场景

• 团队协作：统一团队Java代码风格，避免因格式差异导致的代码评审冲突
• 个人开发：快速格式化Java文件，遵循行业通用的Google Java风格
• CI/CD集成：在代码提交或构建流程中自动格式化代码，确保提交代码符合风格要求
• 临时环境：无需在临时工作环境中安装工具，通过Docker即可快速使用格式化功能

使用方法和配置说明

基本使用方式

通过docker run命令运行容器，需将本地Java文件所在目录挂载到容器内，工具通过容器内路径访问文件并执行格式化。

关键配置说明

• 挂载目录：必须挂载本地目录到容器内（推荐挂载到/local），格式为-v 本地目录:/local
• 工具命令：容器内可直接执行google-java-format命令，支持该工具的所有原生参数
• 常用参数：
  • -i：原地修改文件（直接修改输入文件，而非输出到标准输出）
  • 其他参数请参考https://github.com/google/google-java-format

使用示例

示例1：格式化单个Java文件

格式化当前工作目录下的SomeFile.java文件：

sh
docker run --rm -v ${PWD}:/local vandmo/google-java-format google-java-format -i /local/SomeFile.java

说明：

• --rm：容器运行结束后自动删除，避免残留容器文件
• ${PWD}：当前工作目录（本地目录）
• /local/SomeFile.java：容器内的文件路径（对应本地./SomeFile.java）
• -i：原地修改文件，执行后本地SomeFile.java将被格式化

示例2：批量格式化目录下所有Java文件

格式化当前工作目录及其子目录下的所有.java文件：

sh
docker run --rm -v ${PWD}:/local vandmo/google-java-format find /local/ -name '*.java' -exec google-java-format -i {} \;

说明：

• find /local/ -name '*.java'：查找容器内/local目录下所有.java文件
• -exec google-java-format -i {} \;：对每个找到的文件执行格式化命令（{}表示文件路径）
• 执行后当前目录下所有Java文件将被批量格式化