Go / 系统课时
用 gofmt 统一源码格式
用 gofmt 统一源码格式
Go 项目不需要团队自行争论缩进宽度、花括号位置或空格数量。Go 1.27 标准工具链自带 gofmt,可以按统一规则重写源码;配合 go fmt,还能以包为单位完成格式化,适合放进保存、提交和 CI 前的固定流程。
学习目标
- 使用
gofmt检查或直接重写单个 Go 源文件 - 理解
gofmt与go fmt的使用范围差异 - 建立提交代码前可重复执行的格式检查习惯
用 gofmt 重写源码
gofmt 随 Go 工具链一起安装,不需要额外依赖。最直接的写法是 gofmt -w main.go:-w 表示把格式化结果写回原文件。下面的 Bash 示例先创建一份故意写得很紧凑的代码,再让 gofmt 改写并显示结果。
mkdir -p fmt-demo
cd fmt-demo
cat > main.go <<'EOF'
package main
import "fmt"
func main(){name:="Go";fmt.Println("hello,",name)}
EOF
gofmt -w main.go
cat main.go预期输出:
package main
import "fmt"
func main() {
name := "Go"
fmt.Println("hello,", name)
}gofmt 会统一缩进、必要空格、空行和部分源码布局。它不是普通文本美化器,而是理解 Go 语法的格式化工具;团队通常直接接受其结果,而不是维护另一套缩进配置。
先查看差异再决定是否写回
不希望立即修改文件时,可以执行 gofmt -d main.go。-d 输出原文件与格式化结果之间的差异,但不会覆盖磁盘上的源码;检查确认后再运行 gofmt -w main.go。
提交前还可以用 gofmt -l *.go 检查当前目录中的 Go 文件。-l 只列出格式不符合 gofmt 结果的文件名,因此没有输出通常表示这些文件已经符合标准格式。
用 go fmt 处理模块中的包
go fmt 是 go 命令提供的包级入口。位于模块根目录时,常用 go fmt ./... 处理当前模块目录树中匹配到的所有包;相比逐个指定文件,它更适合作为项目级操作。
例如,一个模块包含 cmd/server、internal/httpapi 和 internal/store 三个包时,可以直接在模块根目录执行 go fmt ./...,而不必手工维护文件清单。若某些文件被修改,命令会报告相应格式化动作;已经全部符合格式时通常不会产生需要处理的信息。
实际习惯可以固定为:写代码时由编辑器自动格式化,准备提交时执行 go fmt ./...,代码审查中不再讨论 Tab、空格或花括号风格,把注意力留给程序行为本身。
区分格式化与代码检查
gofmt 只负责源码格式,不会替你发现所有逻辑错误。格式化成功并不代表程序能够编译,也不代表变量一定被正确使用。完成格式化后,至少再运行 go test ./...;没有测试的包也会经过构建检查,从而发现不少编译问题。
因此提交前可以形成明确顺序:先执行 go fmt ./... 统一源码,再执行 go test ./... 验证构建和测试。若 gofmt 反复产生差异,应优先检查编辑器是否使用了其他格式化器,而不是手工把空格重新改回去。