Go / 系统课时
编写基础单元测试
编写基础单元测试
本节用一个可直接运行的加法函数测试,演示如何用 testing.T 组织输入、调用被测代码、比较结果并报告失败。完成后,你会得到一个能被 go test 自动发现的最小测试,并理解测试文件、函数命名和失败信息各自承担什么职责。
学习目标
- 编写符合 Go 约定、可被
go test自动发现的测试函数 - 使用
testing.T比较实际结果与期望结果,并输出有诊断价值的失败信息 - 通过
go test -v运行测试并判断测试是否真正执行
认识 Go 单元测试的最小结构
Go 的测试能力由标准库 testing 和 go test 命令提供,不需要额外测试框架。测试文件必须以 _test.go 结尾;测试函数通常命名为 TestXxx,参数必须是 t *testing.T。go test 会编译当前包及测试代码,再执行符合约定的测试函数。
一个可靠的基础测试可以按四步组织:准备输入和期望值,调用被测函数,比较实际结果,发现差异时通过 t.Fatalf 或 t.Errorf 报告。失败信息应同时给出 got 与 want,否则测试失败后还需要再次调试才能知道差异。
写出第一个可执行测试
下面是完整项目中的文件内容(片段示例)。三个文件共同组成一个最小可运行示例,单个文件不能独立验证,需要放在同一目录后统一运行测试。
go.mod:
module example.com/calc
go 1.24该文件声明模块路径;验证时以当前安装的 Go 工具链实际支持的 go 版本为准。
calc.go:
package calc
func Add(a, b int) int {
return a + b
}calc_test.go:
package calc
import "testing"
func TestAdd(t *testing.T) {
a, b := 2, 3
want := 5
// 测试只通过公开行为判断结果,不复制被测函数的实现逻辑。
got := Add(a, b)
if got != want {
t.Fatalf("Add(%d, %d) = %d; want %d", a, b, got, want)
}
}这里使用 t.Fatalf,因为当前断言失败后没有继续执行的价值;它会记录失败并立即结束当前测试函数。对于仍值得继续检查其他独立断言的场景,可以改用 t.Errorf。
运行并核对结果
在上述文件所在目录执行:
go test -v预期输出:
=== RUN TestAdd
--- PASS: TestAdd (<TIME>)
PASS
ok example.com/calc <TIME><TIME> 由机器性能和缓存状态决定,实际值可能不同。关键不是耗时,而是出现 TestAdd、PASS,并且包级结果为 ok。如果测试函数没有出现在 -v 输出中,应先检查文件名是否以 _test.go 结尾,以及函数签名是否为 func TestXxx(t *testing.T)。
让失败信息能直接定位问题
测试的价值不仅是“红或绿”,还包括失败时能否快速解释哪里不一致。把 want 写成固定期望值,并在错误消息中打印输入、实际值和期望值,可以避免测试与实现同时犯同一种错误。
例如,不要为了计算期望值而再次调用与生产代码相同的算法;那会让测试失去独立判断能力。基础单元测试应尽量小:一次验证一个明确行为,不依赖网络、数据库或当前时间。这样失败时,原因通常就集中在被测函数和测试输入之间。
当这个最小结构稳定后,再扩展到多个输入、错误分支或子测试会更自然;但无论测试规模多大,核心仍是明确输入、独立期望、可诊断失败和可重复执行。