17370845950

Golang测试代码应不应该放在_test文件
必须放在以 _test.go 结尾的文件中,这是 Go 官方约定和 go test 工具的硬性要求;文件名、测试函数命名(TestXxx)、签名(*testing.T)及包声明(xxx_test 或 xxx)任一错误都会导致“no tests to run”。

应该放在 _test.go 文件里,这是 Go 官方约定和 go test 工具的硬性要求。

为什么必须用 _test.go 后缀?

Go 的测试机制依赖文件名识别测试代码:go test 默认只编译并运行以 _test.go 结尾的文件。其他命名(比如 test_utils.gohelper_test.go 但没下划线)会被忽略,即使里面写了 TestXxx 函数也不会执行。

  • go buildgo run 会直接跳过 _test.go 文件,避免把测试代码打进生产二进制
  • 测试文件可声明独立的 package xxx_test,用于黑盒测试(访问被测包的导出符号,但不访问未导出字段/函数)
  • 若测试需要访问内部实现(如 unexported 方法),可与源码同包(即 package xxx),此时也必须用 _test.go 后缀,否则编译失败(包名冲突或无法导入)

xxx_test.go 里该写什么?

不是所有测试相关代码都适合塞进 _test.go。区分清楚三类内容:

  • 真正执行的测试函数(func TestXxx(t *testing.T))——必须放在 _test.go
  • 测试辅助函数(如构造 mock、初始化 fixture)——推荐放在同名 _test.go 中,避免跨包调用复杂化
  • 可复用的测试工具(如通用断言库、HTTP 测试客户端)——建议单独建 testutil 包,用普通 .go 后缀,导入时加 /testutil 路径;否则容易引发循环导入或测试包污染

常见错误:文件名对了但测试不运行

即使后缀正确,以下情况仍会导致 go test 找不到或跳过测试:

  • 函数名不符合规范:必须是 Test 开头 + 驼峰,如 TestHandleRequesttestHandleRequestTEST_HandleRequest 都无效
  • 签名错误:参数必须是 *testing.T(单元测试)或 *testing.B(基准测试),多一个参数或类型不对就静默忽略
  • 包声明问题:黑盒测试需声明 package xxx_test,且文件中不能 import 原包(否则循环依赖);同包测试则必须声明 package xxx,且不能有 import "xxx"
  • 执行范围限制:默认只跑当前目录,go test ./... 才递归所有子目录;子目录下没有 _test.go 就不会触发其测试
func TestAdd(t *testing.T) {
    got := Add(2, 3)
    if got != 5 {
        t.Errorf("Add(2, 3) = %d, want 5", got)
    }
}

测试文件命名、函数签名、包声明这三点只要错一个,go test 就不会报错,而是直接说 no tests to run —— 这是最容易卡住人的地方。