
本文介绍如何在不修改被测函数代码的前提下,通过重定向 log 包的输出目标,实现在 Go 测试中捕获并断言 log.Print 等日志内容。核心方法是临时将 log.SetOutput 指向 bytes.Buffer,并在测试结束后恢复默认输出。
本文介绍如何在不修改被测函数代码的前提下,通过重定向 `log` 包的输出目标,实现在 go 测试中捕获并断言 `log.print` 等日志内容。核心方法是临时将 `log.setoutput` 指向 `bytes.buffer`,并在测试结束后恢复默认输出。
在 Go 中,log 包默认将日志写入 os.Stderr,因此无法直接通过标准输出捕获。但 log 提供了 log.SetOutput(io.Writer) 接口,允许我们动态替换其底层输出目标——这正是实现日志可测试性的关键。
以下是一个完整、安全的测试示例:
package main
import (
"bytes"
"io"
"log"
"os"
"testing"
)
func readByte() {
// 模拟错误场景
err := io.EOF
if err != nil {
fmt.Println("ERROR") // 注意:fmt.Println 不受 log.SetOutput 影响
log.Print("Couldn't read first byte")
return
}
}
func TestReadByte(t *testing.T) {
// 1. 创建缓冲区用于捕获日志
var buf bytes.Buffer
// 2. 临时重定向 log 输出到缓冲区
originalOutput := log.Writer() // 保存原始 writer(更健壮于 os.Stderr)
log.SetOutput(&buf)
defer func() {
log.SetOutput(originalOutput) // 恢复原始输出,避免影响其他测试
}()
// 3. 执行被测函数
readByte()
// 4. 断言日志内容(注意:log.Print 会自动添加时间戳和前缀)
output := buf.String()
t.Log("Captured log:", output)
// 若需精确匹配,可使用正则或子串检查;例如:
if !strings.Contains(output, "Couldn't read first byte") {
t.Errorf("expected log to contain 'Couldn't read first byte', got: %q", output)
}
}⚠️ 重要注意事项:
-
fmt.Println("ERROR")属于标准输出(os.Stdout),不受log.SetOutput控制;如需同时捕获它,需额外重定向os.Stdout(不推荐,易引发副作用)。 -
log.SetOutput是全局设置,必须在测试结束时严格恢复,否则可能污染其他测试用例或并发执行环境。使用defer+ 保存原始log.Writer()是最佳实践。 - 日志字符串包含自动添加的时间戳(如
2024/05/22 10:30:45)和换行符,断言时建议使用strings.Contains或正则匹配关键信息,而非全等比较。 - 若项目使用结构化日志库(如
logrus、zap),应改用对应库的测试钩子(如logrus.TestHook),而非log.SetOutput。
综上,通过临时劫持 log 的输出流,我们能在零侵入(无需修改 readByte 函数)的前提下,可靠地验证日志行为,显著提升错误处理逻辑的测试覆盖率。

















