本文介绍如何利用 TestMain 在 Go 单元测试中提前设置环境变量，确保 init() 函数能正确读取测试所需配置，避免因 init() 优先执行导致的测试失败。
本文介绍如何利用 `testmain` 在 go 单元测试中提前设置环境变量，确保 `init()` 函数能正确读取测试所需配置，避免因 `init()` 优先执行导致的测试失败。
在 Go 中，init() 函数会在包导入时自动执行，且执行顺序严格遵循依赖图：被依赖包的 init() 总是先于依赖它的包执行。这导致一个常见痛点——当你的主逻辑（如环境变量解析）放在 init() 中时，测试代码中的 init()（用于 os.Setenv）永远晚于主包的 init() 执行，从而无法生效。
直接在测试文件中写 func init() 设置环境变量是无效的，因为此时 env.Parse(&envConfig) 已在主包 init() 中执行完毕，甚至可能因缺失环境变量而触发 log.Fatal，直接终止测试进程。
✅ 正确解法：使用 TestMain 进行全局测试前准备
TestMain 是 Go 测试框架提供的钩子函数，它在所有测试函数运行前执行，并可完全控制测试生命周期。你可以在其中安全地设置环境变量、初始化全局状态，甚至临时重定向日志输出以捕获 log.Fatal（如需进一步容错）。
以下是完整、可运行的示例：
// config.go
package main
import (
"log"
"os"
"github.com/caarlos0/env"
)
type envVars struct {
Host string `env:"APP_HOST"`
Username string `env:"APP_USERNAME"`
Password string `env:"APP_PASSWORD"`
}
var envConfig envVars
func init() {
if err := env.Parse(&envConfig); err != nil {
log.Fatal("failed to parse env vars:", err)
}
}
// config_test.go
package main
import (
"os"
"testing"
"github.com/stretchr/testify/assert"
)
func TestMain(m *testing.M) {
// ✅ 在所有测试开始前设置环境变量
os.Setenv("APP_HOST", "http://localhost:9999")
os.Setenv("APP_USERNAME", "john")
os.Setenv("APP_PASSWORD", "doe")
// ⚠️ 注意：若 init() 中调用 log.Fatal，此处无法拦截
// 如需更健壮测试，建议将 init() 中的逻辑移至显式初始化函数（见下方建议）
// 运行实际测试
exitCode := m.Run()
// 可选：清理环境变量（避免影响其他测试或并发运行）
os.Unsetenv("APP_HOST")
os.Unsetenv("APP_USERNAME")
os.Unsetenv("APP_PASSWORD")
os.Exit(exitCode)
}
func TestEnvConfig(t *testing.T) {
assert.NotNil(t, envConfig)
assert.Equal(t, "http://localhost:9999", envConfig.Host)
assert.Equal(t, "john", envConfig.Username)
assert.Equal(t, "doe", envConfig.Password)
}
? 关键注意事项：
- TestMain 必须定义在包含 Test* 函数的同一包中，且函数签名必须为 func TestMain(*testing.M)；
- m.Run() 必须被调用，否则测试不会执行；
- os.Exit() 必须使用 m.Run() 返回的退出码，以保证测试框架正确报告失败；
- 环境变量设置应在 m.Run() 之前，清理应在之后（或使用 defer + os.Clearenv() 更彻底）；
- 进阶建议：长期来看，应避免在 init() 中执行有副作用的操作（如 I/O、环境读取、panic/fatal）。推荐改为显式初始化函数（如 LoadConfig()），由 main() 或测试按需调用——这不仅提升可测试性，也符合 Go 的显式优于隐式设计哲学。
通过 TestMain，你获得了对测试生命周期的完全掌控，让原本“不可测”的 init() 逻辑变得可靠、可重复、可维护。
