17370845950

Golang测试中如何初始化和清理资源
Go测试资源管理需分层:TestMain做全局初始化与清理,必须调用m.Run()并返回其退出码;单个测试用t.Cleanup确保及时释放,注意闭包变量捕获;并发测试须独占资源如随机端口和临时目录;清理失败应记录而非静默。

测试前用 TestMain 做全局初始化和清理

Go 的 testing.M 允许你在所有测试运行前后执行逻辑,适合数据库连接、临时目录创建、端口监听等一次性资源操作。不推荐在每个 TestXxx 函数里重复开闭资源,既慢又容易漏清理。

关键点:必须显式调用 m.Run(),否则测试不会执行;最后要返回 m.Run() 的退出码,否则 go test 会认为失败。

func TestMain(m *testing.M) {
	db, err := sql.Open("sqlite3", ":memory:")
	if err != nil {
		log.Fatal(err)
	}
	defer db.Close()

	// 设置全局变量或包级状态
	testDB = db

	// 运行所有测试
	code := m.Run()

	// 清理(这里 db.Close() 已由 defer 覆盖,但其他资源如文件、goroutine 需手动收)
	os.RemoveAll("_test_tmp")

	os.Exit(code)
}

单个测试用 t.Cleanup 确保及时释放

t.Cleanup 是 Go 1.14+ 引入的机制,注册的函数会在当前测试函数返回前按**后进先出**顺序执行,比 defer 更可靠——即使测试 panic、被 t.Fatal 中断,它也一定触发。

常见误用:在循环中注册 Cleanup 但没捕获变量值,导致闭包引用错误;或误以为它能跨测试生效(它只对当前 *testing.T 生效)。

  • ✅ 正确写法:用局部变量绑定当前迭代值
  • ❌ 错误写法:for i := range files { t.Cleanup(func() { os.Remove(files[i]) }) } —— i 最终是循环末尾值
  • ✅ 替代写法:for _, f := range files { f := f; t.Cleanup(func() { os.Remove(f) }) }

并发测试时避免资源竞争

多个 go test -race 并发运行的测试可能共用同一份资源(如固定端口、同名临时文件),引发冲突或清理失败。不要假设测试是串行的。

解决方式不是加锁,而是让每个测试独占资源:

  • net.Listen("tcp", "127.0.0.1:0") 让系统自动分配空闲端口,再用 l.Addr().(*net.TCPAddr).Port 获取实际端口号
  • os.MkdirTemp("", "test-*") 创建唯一临时目录,测试结束用 t.Cleanup 删除
  • 数据库测试优先用内存模式(:memory:)或为每个测试建独立 schema / prefix 表名

清理失败时别静默吞掉错误

清理阶段出错(比如文件正被占用、数据库连接已断)很容易被忽略,但会导致后续测试环境异常。不要只写 os.RemoveAll(path) 就完事。

建议统一处理并暴露问题:

func cleanupTempDir(t *testing.T, dir string) {
	t.Helper()
	if err := os.RemoveAll(dir); err != nil {
		t.Log("warning: failed to cleanup temp dir:", err)
		// 不 t.Fatal,避免掩盖主测试失败,但至少记录
	}
}

真正麻烦的是那些“看起来清理了,其实没清干净”的情况:比如 goroutine 泄漏、未关闭的 http.Server、忘记 cancel()context.WithCancel。这类问题需要配合 runtime.NumGoroutine() 快照或 pprof 对比排查。