Go bytes.Buffer 怎样复用缓冲区并避免旧内容残留处理空输入并保留错误边界

批量拼接文本、读取小文件或循环构造请求体时，bytes.Buffer 很容易被写成“声明一次、一直复用”。真正容易出错的地方不是写入，而是上一轮内容没有被清掉：第二轮看起来只是追加了一段字符串，实际结果却混入了第一轮数据。

解决办法很明确：把 Reset() 放在每次复用的边界上。它会让缓冲区的逻辑长度回到 0，同时保留底层存储，适合重复写入；空输入可以返回空结果，读取过程中的非 EOF 错误则继续向上返回。

官方地址：https://pkg.go.dev/bytes

本文小结：① 复用前先 Reset；② 空数据不等同于读取失败；③ 需要长期保存字节内容时复制 Bytes()，不要保存会被后续修改的别名切片。

先看旧内容为什么会残留

bytes.Buffer 的零值即可使用。问题通常出现在同一个变量跨循环复用，却只调用 WriteString，没有告诉它“这一轮已经结束”。下面的片段每轮都向同一个缓冲区写入内容，第二次输出自然会带上第一次的前缀：

package main

import (
	"bytes"
	"fmt"
)

func main() {
	var buf bytes.Buffer
	for _, name := range []string{"alpha", "beta"} {
		// 这里只写当前值，没有清空上一轮的逻辑内容。
		buf.WriteString("name=")
		buf.WriteString(name)
		fmt.Println(buf.String())
	}
}

这段代码的关键不是容量是否增长，而是 Len() 始终在增长。第一次结束后，缓冲区仍然持有 name=alpha；第二次写入只是接着它后面追加。把“每次构造一条独立记录”作为复用边界，就能确定清理动作应该放在哪里。

把 Reset 放在每次读取之前

下面把“读取一条记录”封装成小函数。函数接收外部传入的 io.Reader 和可复用的 buffer，第一行先清理上一次的逻辑内容，再调用 ReadFrom。

package main

import (
	"bytes"
	"errors"
	"fmt"
	"io"
	"strings"
)

// readOne 复用 buf 读取一条记录，并保留真实读取错误。
func readOne(r io.Reader, buf *bytes.Buffer) (string, error) {
	// Reset 只清空已读内容，保留底层容量供下一次写入使用。
	buf.Reset()
	if r == nil {
		// nil reader 是调用方错误，不能伪装成空输入。
		return "", errors.New("reader 不能为空")
	}

	if _, err := buf.ReadFrom(r); err != nil {
		// EOF 由 ReadFrom 按读取完成处理；其它错误继续向上返回。
		return "", fmt.Errorf("读取记录失败: %w", err)
	}
	return buf.String(), nil
}

func main() {
	inputs := []string{"first", "", "third"}
	var buf bytes.Buffer
	for _, input := range inputs {
		result, err := readOne(strings.NewReader(input), &buf)
		if err != nil {
			fmt.Println("error:", err)
			continue
		}
		// 空输入是长度为 0 的成功结果，不与读取错误混为一谈。
		fmt.Printf("%q len=%d cap=%d\n", result, len(result), buf.Cap())
	}
}

这里的空字符串经过 strings.NewReader 后仍是一次成功读取，结果是 ""。这和 nil reader 或底层设备返回的实际错误不同：前者可直接作为空记录处理，后者必须保留错误上下文。

Reset 不承诺每次都重新分配内存。想观察复用是否发生，可以在示例中读取 Cap()，但不要把容量数字写成固定性能结论；实际容量取决于之前写入的数据和运行环境。

Bytes、String 和错误边界要分开看

如果只需要把结果交给下一层，buf.String() 通常更直观；如果要处理字节协议，可以使用 buf.Bytes()。但官方文档明确说明，Bytes() 返回的是未读内容的切片，并且会别名底层存储，下一次读、写、Reset 或 Truncate 后就不应继续依赖它。

// 保存一份不会随 buffer 后续修改而变化的字节结果。
func snapshot(buf *bytes.Buffer) []byte {
	// append 到 nil 切片会复制当前未读内容，而不是保存底层别名。
	return append([]byte(nil), buf.Bytes()...)
}

// 只在下一次修改前消费 Bytes 返回的别名切片。
func consumeNow(buf *bytes.Buffer) string {
	// 这里立即转换为 string，避免把切片交给异步任务长期持有。
	return string(buf.Bytes())
}

另一个容易混淆的点是 Reset 与“清零所有底层字节”不是一回事。它改变的是缓冲区的可读长度；如果你的需求是让对象不再保留大块容量，应按生命周期丢弃这个 buffer，重新声明一个新的，而不是把 Reset 当成内存归还操作。

一个小项目的验收清单

把这套写法放进批处理、日志组装或请求体构造器时，可以按下面的顺序检查：

还要注意，bytes.Buffer 不是并发安全类型；如果多个 goroutine 同时读写，应在更高层做同步，或者每个任务拥有自己的 buffer。只要复用范围是单 goroutine、清空位置稳定、错误没有被吞掉，这种模式就能兼顾简单性与较少的重复分配。

相关问题

Reset 和 Truncate(0) 有什么区别？

对一个正常的 bytes.Buffer 来说，Reset() 等价于 Truncate(0)，但 Reset 更清楚地表达“这轮结束，准备复用”的意图。不要对 nil buffer 指针调用方法。

为什么不能把 Bytes 返回值跨轮次保存？

因为它可能与 buffer 的底层存储共享。下一次写入、读取或 Reset 都可能改变这块存储对应的可见内容；需要独立结果时使用复制快照。

空输入要不要返回 io.EOF？

如果你的函数语义是“读取一条记录”，可以把空输入当作合法空记录；如果语义是“持续遍历直到结束”，则由外层协议决定是否把 EOF 作为结束信号。关键是不要把业务上的空值和底层真实错误混成一个分支。