Golang单元测试编写指南

本文系统讲解了 Go 语言官方 testing 包的单元测试编写实践，涵盖测试文件命名规范、函数签名要求、错误报告机制（t.Error/t.Fatal 等）、子测试（t.Run）的结构化组织技巧，以及 go test 命令的核心用法与高效选项（如 -v、-run、-cover），帮助开发者快速上手轻量、可靠、无需外部依赖的原生测试流程，并写出可维护、易调试、高覆盖率的 Go 单元测试。

Go 语言的 testing 包是官方提供的轻量、高效、内建的测试框架，无需额外依赖。编写单元测试时，只需遵循命名规范（测试函数以 Test 开头、参数为 *testing.T），并用 go test 命令运行即可。

定义测试函数的基本规则

测试函数必须放在以 _test.go 结尾的文件中，且与被测代码在同一包内（或使用 xxx_test 包做白盒/黑盒隔离）。函数签名固定为：

• 函数名以 Test 开头，后接大写字母开头的有意义名称（如 TestAdd、TestParseURL）
• 唯一参数类型为 *testing.T
• 不能有返回值

常用断言与错误报告方式

Go 不提供内置断言函数，而是通过 *testing.T 的方法显式控制测试流程：

• t.Error(...)：记录错误，继续执行后续语句
• t.Errorf(...)：带格式化字符串的错误记录（推荐用于含变量的提示）
• t.Fatal(...) 和 t.Fatalf(...)：记录错误并立即终止当前测试函数
• 避免使用 panic 或 log.Fatal，它们会绕过测试框架，导致结果不可靠

例如验证加法函数：
func TestAdd(t *testing.T) {
  got := Add(2, 3)
  if got != 5 {
    t.Errorf("Add(2,3) = %d, want 5", got)
  }
}

使用子测试组织多个场景

用 t.Run() 可将一个测试函数拆分为多个逻辑子测试，便于分组、过滤和独立失败定位：

• 每个子测试有自己的名字和作用域，失败时显示完整路径（如 TestAdd/positive_numbers）
• 支持用 -run 参数只运行匹配的子测试：go test -run "TestAdd/positive"
• 适合覆盖边界值、异常输入、不同配置等场景

示例：
func TestAdd(t *testing.T) {
  t.Run("positive_numbers", func(t *testing.T) {
    if got := Add(2, 3); got != 5 {
      t.Errorf("expected 5, got %d", got)
    }
  })
  t.Run("negative_numbers", func(t *testing.T) {
    if got := Add(-1, -2); got != -3 {
      t.Errorf("expected -3, got %d", got)
    }
  })
}

测试命令与实用选项

go test 是核心命令，配合参数可提升效率和可观测性：

• go test：运行当前目录下所有 *_test.go 中的测试
• go test -v：显示详细输出（包括每个测试函数名和日志）
• go test -run=^TestAdd$：正则匹配精确测试函数（^ 和 $ 防止子串误匹配）
• go test -cover：显示测试覆盖率百分比
• go test -coverprofile=c.out && go tool cover -html=c.out：生成 HTML 覆盖率报告

本篇关于《Golang单元测试编写指南》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于Golang的相关知识，请关注golang学习网公众号！