gofmt 仅作基础格式化底线,需配合 golines 处理长行、revive 检查风格,并通过 pre-commit 脚本自动执行以确保团队统一;注意 go.mod 需额外 tidy,CI 应使用统一 Docker 镜像避免环境差异。

用 gofmt 做基础格式化,但别只靠它
gofmt 是 Go 官方自带的格式化工具,能自动处理缩进、括号、空格等基础风格问题。但它不支持自定义规则(比如函数参数换行策略、import 分组顺序),也不能检查命名规范或错误处理习惯。团队真正需要的不是“能格式化”,而是“格式化后大家一眼认出是同一套规则”。所以 gofmt 只能当底线,不能当终点。
常见错误现象:gofmt -w . 后 CI 仍报风格不一致——往往是因为本地没跑完整流程,或有人手动改了 go.mod 后忘记格式化。
- 始终用
-s标志启用简化模式(如a[b]→a[b:]) - 在
Makefile或pre-commit脚本里统一调用gofmt -s -w .,避免各人命令不一致 - 注意:
gofmt不处理go.mod文件,得额外加go mod tidy -v
用 golines 处理长行与函数签名换行
Go 官方不强制行宽限制,但团队协作中过长的函数签名、struct 字段或 if 条件会显著降低可读性。gofmt 对此无能为力,而 golines 可以按语义拆分长行,且支持保留注释对齐、跳过特定标记(如 // golines:ignore)。
使用场景:API handler 函数参数多、SQL 查询拼接、测试用例中的 struct 初始化。
立即学习“go语言免费学习笔记(深入)”;
- 安装:
go install github.com/segmentio/golines@latest - 推荐命令:
golines -m 100 -s -d ./...(最大行宽 100,启用简化,仅显示差异) - 注意:不要全局
-w,先人工 review 差异,尤其关注嵌套 map 和 slice 字面量是否被意外拆开
用 revive 替代 golint 做静态风格检查
golint 已归档,revive 是目前最活跃的 Go 风格 linter,支持 YAML 配置、自定义规则、以及与 gopls / pre-commit 集成。它能捕获 gofmt 无法覆盖的问题:比如变量名是否含下划线、error 是否被忽略、context 是否传递到子调用。
关键配置项(.revive.toml):
[rule] name = "var-naming" disabled = false [rule] name = "error-return" disabled = false [rule] name = "empty-block" disabled = true # 团队接受空 if body 做占位
- CI 中建议用
revive -config .revive.toml -exclude "**/mocks/**" ./... - 避免开启所有规则——比如
exported规则在内部 SDK 项目中常误报,需按包路径 exclude - 和
gopls配合时,确保 VS Code 的"gopls": { "analyses": { "STRICT": true } }开启,否则部分 revive 规则不生效
把格式化变成 Git 提交前的自动步骤
靠人执行 gofmt + golines + revive 容易遗漏。真正的统一,是让这些工具在 git commit 前自动运行并阻断不合规代码。
推荐用 pre-commit(Python 生态)或 husky(Node 生态)管理钩子,但 Go 项目更轻量的做法是直接写 shell 脚本:
#!/bin/sh set -e gofmt -s -w . golines -m 100 -w ./... go mod tidy -v revive -config .revive.toml ./... || (echo "revive check failed"; exit 1)
- 把这个脚本存为
scripts/format.sh,并在.git/hooks/pre-commit中调用 - 务必加
set -e,任一命令失败即中断提交,避免 “只跑了 gofmt 没跑 revive” - 团队新成员容易忽略的是:
pre-commit脚本不自动安装,得在 README 明确写 “运行chmod +x .git/hooks/pre-commit”
最常被忽略的一点:不同操作系统对换行符、文件权限的处理不一致,Mac 和 Linux 下 golines 输出可能微小差异。建议在 CI 中用相同 Docker 镜像(如 golang:1.22-alpine)复现格式化过程,而不是只依赖本地结果。










