如何在 Go 中为基于 glog 的日志封装器编写单元测试-Golang-PHP中文网

如何在 Go 中为基于 glog 的日志封装器编写单元测试

本文介绍如何通过重定向 os.Stderr 捕获 glog 输出，实现对自定义日志封装器（如带前缀、按 emitter 控制日志级别）的高覆盖率单元测试。

本文介绍如何通过重定向 os.stderr 捕获 glog 输出，实现对自定义日志封装器（如带前缀、按 emitter 控制日志级别）的高覆盖率单元测试。

在 Go 项目中使用 glog 时，常需封装其接口以支持动态前缀、按模块/组件粒度控制日志级别等增强能力。但 glog 默认将日志直接写入 os.Stderr，无法像标准库 log 那样注入 io.Writer，这给单元测试带来挑战——传统断言无法直接验证日志内容。

解决思路是：在测试期间临时劫持 os.Stderr，将其替换为内存管道（os.Pipe），执行被测日志逻辑后读取捕获的输出，并还原原始 stderr。该方法无需修改生产代码，完全符合黑盒测试原则，且能精准验证日志格式、内容与触发条件。

以下是一个可复用的 stderr 捕获辅助函数及对应测试示例：

func captureStderr(f func()) (string, error) {
    old := os.Stderr
    r, w, err := os.Pipe()
    if err != nil {
        return "", err
    }
    os.Stderr = w

    outC := make(chan string, 1)
    go func() {
        var buf bytes.Buffer
        io.Copy(&buf, r)
        outC <p>使用该工具可轻松验证日志行为：</p><pre class="brush:php;toolbar:false;">func TestGlogError(t *testing.T) {
    stdErr, err := captureStderr(func() {
        glog.Error("Test error")
    })
    if err != nil {
        t.Fatalf("failed to capture stderr: %v", err)
    }
    // glog 输出格式通常为：I0101 00:00:00.000000   12345 file.go:10] Test error
    // 我们关注末尾是否包含期望消息（忽略时间戳和前缀）
    if !strings.Contains(stdErr, "Test error") {
        t.Errorf("expected 'Test error' in stderr output, got:\n%s", stdErr)
    }
}

⚠️ 注意事项：

glog 在首次调用日志函数时会初始化全局 flag，因此建议在 init() 或 TestMain 中提前调用 glog.Flush() 或 glog.CopyStandardLogTo()（若启用）避免竞态；
若测试并发执行多个日志调用，需确保 captureStderr 调用互斥（glog 本身非完全 goroutine-safe）；
glog 已归档（官方推荐迁移到 zap/slog），新项目建议优先选用 slog（Go 1.21+ 内置）或 zap，二者原生支持 writer 注入与测试友好设计；
对于带前缀的封装器（如 Logger{prefix: "DB"}），应在测试中构造实例并调用其 Errorf() 等方法，再捕获输出验证前缀是否正确拼接。