如何将os.Stdout输出捕获为字符串用于单元测试？

方案一：依赖注入io.Writer（推荐） #

如果可以修改目标函数，最好让它接受一个io.Writer参数，这样测试时能传入字节缓冲区捕获输出，同时让函数更灵活：

修改后的函数：

import "io"

func f(w io.Writer) {
    fmt.Fprintln(w, "hello")
}

对应的单元测试：

import (
    "bytes"
    "fmt"
    "testing"
)

func TestF(t *testing.T) {
    var buf bytes.Buffer
    // 将缓冲区传入函数
    f(&buf)
    
    expected := "hello\n"
    if actual := buf.String(); actual != expected {
        t.Errorf("输出不匹配：期望 %q，实际 %q", expected, actual)
    }
}

方案二：重定向os.Stdout（无法修改函数时使用） #

如果函数硬编码使用os.Stdout，可以临时重定向标准输出到缓冲区，测试完成后恢复原输出，避免影响其他测试用例：

目标函数：

func f() {
    fmt.Fprintln(os.Stdout, "hello")
}

对应的单元测试：

import (
    "bytes"
    "os"
    "testing"
)

func TestF(t *testing.T) {
    // 保存原始标准输出
    originalStdout := os.Stdout
    // 测试结束后恢复，避免影响后续测试
    defer func() { os.Stdout = originalStdout }()

    // 创建缓冲区用于捕获输出
    var buf bytes.Buffer
    os.Stdout = &buf

    // 调用目标函数
    f()

    // 验证输出是否符合预期
    expected := "hello\n"
    if actual := buf.String(); actual != expected {
        t.Errorf("输出不匹配：期望 %q，实际 %q", expected, actual)
    }
}

说明 #

• 方案一通过依赖注入解耦了输出目标，是Go语言中更优雅的测试方式，同时提升了函数的复用性。
• 方案二属于临时 workaround，务必使用defer恢复原始标准输出，否则会导致后续测试的输出异常。

内容的提问来源于stack exchange，提问作者Mark Harrison