Go 中如何捕获并持久化基准测试结果

本文介绍如何在 go 中通过 `testing.benchmark` 函数显式运行基准测试，获取 `testing.benchmarkresult` 结构体，并将其序列化保存至文件，从而脱离命令行输出、实现结果的程序化处理与长期存储。

在标准 Go 测试流程中，我们通常使用 go test -bench=. 自动发现并执行以 Benchmark* 命名的函数，其结果由 testing 包内部格式化后直接打印到终端。但若需进一步分析、比对版本差异、生成报告或集成 CI/CD 流水线，则必须将结果以结构化形式捕获——此时 testing.Benchmark 函数就是关键入口。

testing.Benchmark 是一个导出函数，接收一个 func(*testing.B) 类型的基准函数，并同步执行该基准测试，最终返回 testing.BenchmarkResult 实例。该结构体包含全部核心指标：

type BenchmarkResult struct {
    N         int           // 实际执行的迭代次数 b.N
    T         time.Duration // 总耗时（纳秒）
    Bytes     int           // 每次操作处理的字节数（常用于内存密集型场景）
    MemAllocs uint64        // 总内存分配次数
    MemBytes  uint64        // 总分配字节数
    Extra     map[string]float64 // 用户自定义指标（需在基准函数中调用 b.ReportMetric 手动设置）
}

以下是一个完整可运行示例，演示如何捕获结果并写入 JSON 文件：

package main

import (
    "encoding/json"
    "fmt"
    "os"
    "testing"
    "time"
)

func Add(a, b int) int {
    time.Sleep(10 * time.Microsecond) // 模拟实际开销
    return a + b
}

func BenchAdd(b *testing.B) {
    for i := 0; i < b.N; i++ {
        _ = Add(1, 2)
    }
}

func main() {
    // 显式运行基准测试
    result := testing.Benchmark(BenchAdd)

    // 打印人类可读摘要（与 go test 输出风格一致）
    fmt.Printf("%d\t%v/op\n", result.N, time.Duration(result.T/int64(result.N)))

    // 序列化为 JSON 并写入文件
    data, err := json.MarshalIndent(result, "", "  ")
    if err != nil {
        panic("JSON marshal failed: " + err.Error())
    }

    if err := os.WriteFile("benchmark_result.json", data, 0644); err != nil {
        panic("Write file failed: " + err.Error())
    }

    fmt.Println("✅ Benchmark result saved to benchmark_result.json")
}

运行该程序后，你将得到类似如下 JSON 文件内容：

{
  "N": 120000,
  "T": 1200000000,
  "Bytes": 0,
  "MemAllocs": 0,
  "MemBytes": 0,
  "Extra": {}
}

⚠️ 重要注意事项：

• testing.Benchmark 仅在非测试上下文中可用（即 main 包中），它会绕过 go test 的调度机制，因此无法自动识别 Benchmark* 函数；你必须显式传入函数值。
• 该方式不支持 -benchmem 或 -benchmem 等 go test 标志——内存统计需依赖 runtime.ReadMemStats 手动采集并填入 result.Extra（通过 b.ReportMetric）。
• 若需同时运行多个基准并对比，建议封装统一 runner，遍历函数列表并批量收集 BenchmarkResult。
• 生产环境中，推荐结合 testing.B.Run（子基准）与 b.ReportMetric 实现细粒度指标上报，再配合 testing.Benchmark 进行端到端结果采集。

通过这种方式，你不再受限于终端输出，而是获得完全可控的基准数据流——无论是存入数据库、上传至监控平台，还是生成 HTML 报表，都成为可能。