TestMain 是 Go 中唯一能统一管理所有测试前后初始化与清理的入口,适用于数据库连接、临时目录、环境变量等场景,避免重复代码、资源泄漏和测试干扰。

在 Go 中,TestMain 是唯一能让你在所有测试函数执行前/后统一做初始化和清理工作的入口,特别适合数据库连接、临时目录创建、环境变量设置、全局 mock 初始化等场景。
为什么需要 TestMain 而不是每个 TestXxx 里重复写?
避免重复代码、防止资源泄漏、确保测试间隔离、提升可维护性。比如每次测数据库都要连一次再断开,既慢又容易因 panic 导致连接没关闭;用 TestMain 可以集中管理生命周期。
基本用法:定义 TestMain 函数
必须在包的 main_test.go(或任意 *_test.go 文件)中定义签名完全匹配的函数:
func TestMain(m *testing.M)
立即学习“go语言免费学习笔记(深入)”;
它接收一个 *testing.M,调用 m.Run() 执行全部测试,返回整数退出码。你可以在前后插入自定义逻辑:
- 前置操作(如启动 HTTP server、初始化 DB 连接池)放在
m.Run()前 - 清理操作(如关闭连接、删除临时文件)放在
m.Run()后 - 最后用
os.Exit(m.Run())保证测试进程正确退出
典型实战示例:临时目录 + 环境变量隔离
假设你的测试依赖某个配置路径或需要读写临时文件:
func TestMain(m *testing.M) {
// 创建临时目录
tmpDir, err := os.MkdirTemp("", "myapp-test-*")
if err != nil {
log.Fatal("failed to create temp dir:", err)
}
defer os.RemoveAll(tmpDir) // 测试结束后清理
// 备份并覆盖环境变量
oldHome := os.Getenv("HOME")
os.Setenv("HOME", tmpDir)
// 运行所有测试
code := m.Run()
// 恢复环境变量(即使测试 panic 也要执行)
os.Setenv("HOME", oldHome)
os.Exit(code)
}
注意:defer 在 m.Run() 后才触发,所以清理逻辑要写在它之后;若需更严格控制(如 panic 后仍清理),可用 recover 或封装成带 defer 的闭包。
进阶技巧:按测试分组控制初始化粒度
TestMain 是全局的,但有时你只想对部分测试初始化(比如只对 TestDB* 初始化数据库)。Go 本身不支持“子 TestMain”,可通过以下方式模拟:
- 用
testing.M的Flag解析自定义参数(如-db),再决定是否初始化 - 在每个
TestXxx开头检查全局标记(如var dbInited bool+sync.Once) - 拆分测试文件:把 DB 相关测试放
db_test.go,用独立的TestMain(但注意一个包只能有一个TestMain)
推荐使用 sync.Once + 全局标记,兼顾灵活性与简洁性:
var initDBOnce sync.Once
var db *sql.DB
func setupDB() {
initDBOnce.Do(func() {
var err error
db, err = sql.Open("sqlite3", ":memory:")
if err != nil {
log.Fatal(err)
}
})
}
然后在各测试中显式调用 setupDB() —— 它只会真正执行一次,且线程安全。










