17370845950

Go项目推荐用goimports替代gofmt实现代码格式化与import自动管理，需手动安装goimports并配置PATH，支持命令行批量处理、VS Code保存时自动格式化及Git pre-commit钩子校验。

在 Go 项目中，统一代码风格是团队协作和长期维护的基础。Go 官方推荐使用 gofmt 作为标准格式化工具，而 goimports 则在此基础上自动管理 import 语句（增删、排序、分组）。两者配合使用，能显著提升代码整洁度和开发效率。

安装 goimports

gofmt 随 Go SDK 自带，无需额外安装；goimports 需手动安装：

• 运行 go install golang.org/x/tools/cmd/goimports@latest（Go 1.21+ 推荐方式）
• 确保 $GOPATH/bin 或 $GOBIN 在系统 PATH 中，以便命令行直接调用
• 验证安装：执行 goimports -v 应输出版本信息

命令行快速格式化

可单独或组合使用：

• gofmt -w main.go：格式化单个文件并写回
• gofmt -w ./...：递归格式化当前模块下所有 .go 文件
• goimports -w main.go：格式化 + 自动整理 imports（推荐替代 gofmt）
• goimports -w ./...：批量处理整个项目，更安全高效

集成到编辑器（以 VS Code 为例）

配置保存时自动格式化：

• 安装插件 “Go”（by Go Team at Google）
• 在 settings.json 中添加：

"go.formatTool": "goimports",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
  "source.organizeImports": true
}

这样每次保存文件，VS Code 会自动运行 goimports，完成格式化 + import 整理。

配置 Git 提交前自动格式化（pre-commit hook）

避免不规范代码被提交：

• 在项目根目录创建 .git/hooks/pre-commit
• 写入以下内容并 chmod +x：

#!/bin/sh
goimports -w $(git ls-files '*.go' | grep -v '/vendor/')
if [ -n "$(git status -s)" ]; then
  git add .
fi

该脚本会在每次 commit 前对所有非 vendor 的 Go 文件执行 goimports -w，并自动暂存变更。