Go 中测试 io.Writer 输出行为的方法

本文介绍使用 `bytes.Buffer` 作为可捕获输出的 `io.Writer` 实现，对依赖 `io.Writer` 的函数进行单元测试，验证其写入内容是否符合预期。

在 Go 单元测试中，当函数接受 io.Writer 作为参数（如用于格式化输出），我们无需依赖真实文件、标准输出或网络连接——只需提供一个内存中的、可读取的 io.Writer 实现即可。bytes.Buffer 是标准库中最常用且最合适的选项：它同时实现了 io.Writer 和 io.Reader 接口，能无副作用地累积写入内容，并通过 .String() 或 .Bytes() 暴露结果。

以下是一个典型测试示例，对应被测方法：

func (s *containerStats) Display(w io.Writer) error {
    fmt.Fprintf(w, "%s %s\n", "hello", "world")
    return nil
}

对应的单元测试如下：

func TestDisplay(t *testing.T) {
    s := newContainerStats() // 替换为实际的构造逻辑（如 &containerStats{} 或工厂函数）
    var buf bytes.Buffer

    if err := s.Display(&buf); err != nil {
        t.Fatalf("s.Display() returned unexpected error: %v", err)
    }

    got := buf.String()
    want := "hello world\n"

    if got != want {
        t.Errorf("s.Display() output = %q, want %q", got, want)
    }
}

✅ 关键要点说明：

• bytes.Buffer 满足 io.Writer 接口，可直接传入被测函数；
• 测试关注输出内容的确定性，而非副作用（如打印到终端）；
• 建议显式检查错误返回（即使本例中恒为 nil），以增强测试健壮性；
• 使用 %q 格式化动词可在失败时清晰显示不可见字符（如换行符 \n）；
• 若需测试多行、结构化或二进制输出，buf.Bytes() 配合 bytes.Equal() 或 assert.Equal(t, ...) 同样适用。

⚠️ 注意事项：

• 避免在测试中使用 os.Stdout 或 os.Stderr —— 这会使测试非隔离、不可重入，且难以断言；
• 不要忘记初始化被测对象（如 s），确保其状态可控；
• 若 Display 方法内部可能修改 w 外部状态（如调用 w.Close()），需确认 *bytes.Buffer 是否支持（通常不需关闭，且 Close() 是空操作）。

通过这种“注入可观察 writer”的方式，你能让所有基于 io.Writer 的输出逻辑变得完全可测试、可验证，这也是 Go 接口抽象与组合哲学的典型实践。