合法的benchmark函数必须以benchmark开头、接收*testing.b参数且无返回值;b.n由框架动态调整,b.resettimer()需在初始化后调用以排除准备开销。

Benchmark 函数必须以 Benchmark 开头,且接收 *testing.B 参数,否则 go test -bench 不会识别。
如何定义一个合法的 Benchmark 函数
Go 的基准测试不是靠命名随意写的,它有严格的签名约束。函数名必须是 BenchmarkXxx 形式(首字母大写),参数类型必须是 *testing.B,返回值不能有。
- ✅ 正确:
func BenchmarkAdd(b *testing.B) { ... } - ❌ 错误:
func benchmarkAdd(b *testing.B) { ... }(小写开头) - ❌ 错误:
func BenchmarkAdd() { ... }(缺参数) - ❌ 错误:
func BenchmarkAdd(b testing.B) { ... }(非指针)
另外,b.N 是框架自动控制的循环次数,你不能手动设初值或重置——它由 go test 根据运行时性能动态调整,目的是让每次测试耗时稳定在约 1 秒左右。
为什么必须在 b.ResetTimer() 前做初始化
基准测试默认从函数入口开始计时,但很多场景下你要先准备数据(比如构造大 slice、打开文件、初始化缓存),这些开销不该计入被测逻辑的耗时。
立即学习“go语言免费学习笔记(深入)”;
- 用
b.ResetTimer()可以重置计时器,把前面的初始化“剔除”出去 - 如果初始化本身很慢(如解码 100MB JSON),不重置会导致
ns/op虚高,失去对比意义 - 注意:不能在循环体内调用
b.ResetTimer(),否则每次迭代都重置,结果归零
示例:
func BenchmarkJSONUnmarshal(b *testing.B) {
data := loadLargeJSONFile() // 初始化,不计时
b.ResetTimer() // 从此开始计时
for i := 0; i < b.N; i++ {
json.Unmarshal(data, &target)
}
}
b.Run() 嵌套子测试时要注意作用域和变量捕获
当你用 b.Run() 分组多个变体(比如不同 buffer size、不同算法)时,闭包里引用的变量容易被意外共享。
- 常见坑:
for size := range sizes { b.Run(fmt.Sprintf("Size-%d", size), func(b *testing.B) { ... }) }—— 如果循环体里用了size变量而没显式拷贝,所有子测试实际跑的都是最后一个size值 - 正确写法:在
Run外部把变量传进去,例如size := size; b.Run(...) -
b.Run()内部也要调用b.ResetTimer(),否则父级计时器持续累积
子测试名不要含空格或斜杠,否则 go test -bench=xxx 过滤会失败;推荐用连字符或下划线。
运行和解读 go test -bench 输出的关键字段
执行 go test -bench=. -benchmem 后,典型输出像这样:
BenchmarkAdd-8 1000000000 0.34 ns/op 0 B/op 0 allocs/op
-
BenchmarkAdd-8:函数名 + GOMAXPROCS 值(这里是 8),说明并行度影响已纳入测量 -
1000000000:本次实际执行了约 10 亿次循环(b.N) -
0.34 ns/op:每次操作平均耗时 0.34 纳秒,这是核心指标 -
0 B/op和0 allocs/op:每次操作分配 0 字节内存、0 次堆分配,对 GC 友好
如果你看到 allocs/op 显著上升,大概率是函数内隐式逃逸到了堆上(比如返回局部 slice、用 fmt.Sprintf、未预分配 map),这时要结合 go tool compile -gcflags="-m" 看逃逸分析。
真正难的不是写完 BenchmarkXxx,而是确保它测的是你想测的那部分逻辑——初始化、GC 干扰、CPU 频率波动、其他进程抢占,都会悄悄污染结果。建议在 CI 中固定 GOMAXPROCS=1、关闭 CPU turbo boost,并多次运行取中位数。










