Go Replacer.WriteString 怎样把替换文本直接写入 Writer

如果替换后的文本要继续写入文件、HTTP 响应或缓冲区，Go 不必先调用 Replace 生成一份完整字符串。strings.Replacer.WriteString 接收一个 io.Writer，会把替换后的内容直接写入目标，并返回已经写入的字节数和第一个写入错误。

实用结论：需要输出到已有 Writer 时，用 WriteString；需要在内存中继续拼接、比较或重复读取结果时，再用 Replace。判断成功不能只看替换后的内容，还要检查 err。

WriteString 到底解决什么问题

strings.NewReplacer 用成对参数创建替换器，例如 "{{name}}", "Go"。调用 WriteString(w, s) 时，s 中的匹配项会被替换，然后直接写进 w。它的签名是：

func (r *Replacer) WriteString(w io.Writer, s string) (n int, err error)

n 是 Writer 实际接受的字节数，不是匹配次数，也不是源字符串的字符数。替换结果变长时，n 也会随实际输出字节数变化；Writer 失败时，n 可能已经大于零，所以要同时检查两个返回值。

Replacer 可以被多个 goroutine 并发使用，但传入的 Writer 是否安全，仍由 Writer 自己决定。多个替换规则按源文本中的位置处理，不会对已经替换出的文本再次套用规则。

把替换结果直接写入 bytes.Buffer

先用内存缓冲区演示最常见的场景。bytes.Buffer 实现了 io.Writer，因此不需要中间字符串：

package main

import (
	"bytes"
	"fmt"
	"strings"
)

func main() {
	// 用成对参数声明占位符和最终文本，参数数量必须是偶数。
	r := strings.NewReplacer("{{name}}", "Go", "{{verb}}", "直接写入")
	input := "{{name}} 可以把替换结果 {{verb}} Writer。"

	var out bytes.Buffer
	// n 是实际写入 out 的字节数，err 表示 Writer 是否在写入时失败。
	n, err := r.WriteString(&out, input)
	if err != nil {
		// 写入失败时不要把不完整的 out 当成完整结果继续发送。
		panic(err)
	}

	fmt.Printf("写入字节数=%d\n%s\n", n, out.String())
}

这个例子中，out.String() 只在最后需要查看结果时才被调用。若目标是文件或网络响应，可以把同一个 Writer 换成打开的文件或响应写入器，调用方式不变。

n 应该怎样和 err 一起判断

Writer 的契约允许一次写入只接受部分字节并返回错误。Replacer 会累加每次底层写入返回的字节数；一旦某次写入返回错误，方法会停止并把当前累计的 n 与错误返回。因此 n > 0 只表示部分输出已经到达 Writer，不能替代错误判断。

package main

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

// limitedWriter 模拟只能接受一部分数据后失败的目标。
type limitedWriter struct {
	limit int
	used  int
}

func (w *limitedWriter) Write(p []byte) (int, error) {
	remaining := w.limit - w.used
	if remaining  remaining {
		w.used += remaining
		// 这里故意返回部分字节和错误，用来演示调用方的判断。
		return remaining, io.ErrShortWrite
	}
	w.used += len(p)
	return len(p), nil
}

func main() {
	r := strings.NewReplacer("TODO", "完成")
	w := &limitedWriter{limit: 8}
	n, err := r.WriteString(w, "TODO: review")
	if err != nil {
		// n 可能已经大于 0；err 才说明本次输出没有完整完成。
		fmt.Printf("部分写入=%d，错误=%v\n", n, err)
		return
	}
	fmt.Println("完整写入", n)
}

生产代码通常不需要自己重试这个方法。是否重试、从哪里继续写、目标是否可以恢复，要由 Writer 的语义决定；对 HTTP 响应这类不可回滚目标，更应该在调用前准备好可恢复的输入和错误处理策略。

WriteString 和 Replace 怎样选择

创建 Replacer 时还要注意：参数必须以旧字符串、新字符串成对出现，传入奇数个参数会触发 panic。若多个规则的旧字符串相同，前面的规则优先；空字符串规则也会影响匹配边界，建议在业务输入稳定后再加入。

常见问题

WriteString 返回的 n 是字符数吗？

不是。它沿用 io.Writer 的字节计数语义，中文等 UTF-8 文本的字节数与 rune 数量可能不同。

替换后的文本会再次被替换吗？

不会把新文本当作下一轮输入重新扫描；匹配按原始输入向前处理，且不重叠。

Writer 返回错误后还能直接继续调用吗？

不能一概而论。先确认 Writer 是否可恢复、已消费多少数据以及业务是否允许重复输出，再决定重试或终止。