必须用bytes.Buffer重定向log.SetOutput以捕获日志,再通过buf.String()断言;需在每个测试开头保存原输出、末尾defer恢复,避免子测试干扰和panic后失效。

如何在测试中捕获并断言日志输出
Go 标准库的 log 包默认写到 os.Stderr,无法直接断言。想验证日志内容是否符合规范(比如是否含时间戳、字段顺序、错误码前缀),必须重定向其输出目标。
实操建议:
- 用
log.SetOutput把日志重定向到bytes.Buffer,再用buf.String()检查输出 - 避免在
init()或包级变量里调用log.SetOutput——测试间会污染全局状态;应在每个测试函数开头重置 - 若项目用了
zap或logrus,别试图 patch 全局 logger 实例;改用它们提供的测试适配器:zap.NewAtomicLevelAt()+zaptest.NewLogger(),或logrus.StandardLogger().Out = &buf - 注意:
t.Log()和t.Logf()是测试框架自己的输出,不经过log包,不能用来测业务日志逻辑
为什么 t.Cleanup 不能替代 defer 清理日志重定向
测试函数退出时,defer 确实能恢复 log.SetOutput(os.Stderr),但 t.Cleanup 的执行时机晚于子测试(t.Run)的结束,且不保证在 panic 后运行。如果某个子测试 panic,而你只靠 t.Cleanup 恢复日志输出,后续测试可能继续写到旧的 bytes.Buffer,导致断言错乱或 panic。
正确做法是显式管理生命周期:
- 在每个测试函数开头保存原输出:
orig := log.Writer() - 在函数末尾
defer log.SetOutput(orig) - 不要在
t.Run内部做log.SetOutput—— 子测试共享同一 logger 实例,容易互相干扰
测试日志格式时最容易漏掉的三个点
日志规范不只是“有没有输出”,更关注结构化与可解析性。以下三点常被忽略:
-
log.SetFlags(log.LstdFlags)是否启用?没设的话,log.Printf不输出时间戳和文件行号,和生产环境行为不一致 - 多 goroutine 并发打日志时,
log默认非线程安全;若测试中启了 goroutine 调用log.Print,需提前用log.SetOutput绑定带锁的 writer(如sync.Mutex包裹的io.Writer),否则输出可能错乱 - 日志消息中含换行符(
\n)时,log会自动补一行空行;若规范要求单行日志,得提前strings.TrimSpace处理输入,或换用结构化 logger(如zap.String("msg", strings.ReplaceAll(s, "\n", " ")))
用 zaptest 验证结构化日志字段是否合规
如果你的日志规范要求 JSON 输出且含固定字段(如 "level"、"service"、"trace_id"),别用字符串匹配。直接用 zaptest 提供的 Observer 接口抓取结构化事件:
示例关键片段:
observed, logs := zaptest.NewObserver()
logger := zap.New(observed)
// 调用被测代码...
if len(logs.All()) == 0 {
t.Fatal("expected at least one log entry")
}
entry := logs.All()[0]
if entry.Level != zapcore.ErrorLevel {
t.Errorf("expected error level, got %v", entry.Level)
}
if entry.Message != "failed to connect to DB" {
t.Errorf("unexpected message: %s", entry.Message)
}
if _, ok := entry.Fields["trace_id"]; !ok {
t.Error("missing required field: trace_id")
}
这种断言方式不依赖序列化格式,也不怕字段顺序变化,比正则或 json.Unmarshal 更稳定。
临时测试环境里的日志自测,核心不是“让它能输出”,而是“让它按规范输出”。最易出问题的地方往往不在日志内容本身,而在输出目标的生命周期管理、并发安全性、以及结构化字段的强制校验逻辑上。
golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!











