登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  Golang >  Go教程

Go io.TeeReader 怎样把读取内容同步写入另一个 Writer

来源:17golang原创

时间:2026-11-18 20:54:32 193浏览 收藏

如果你需要在消费一个 io.Reader 的同时,把读到的字节写入日志、缓存、摘要计算器或归档流,Go 标准库的 io.TeeReader 可以把这条旁路接入原有读取流程。它返回的仍然是一个 Reader:调用方继续读取包装后的 Reader,旁路 Writer 就会同步收到同一批数据。

把 io.TeeReader(r, w) 当成一个“可读取的观察点”即可:读取先从 r 得到数据,再把这批数据写到 w;写入没有完成前,本次读取不会完成,写入错误也会作为读取错误返回。

官方文档:https://pkg.go.dev/io#TeeReader

把 Reader 和 Writer 接到同一条读取路径

io.TeeReader 的签名是 TeeReader(r Reader, w Writer) Reader。第一个参数是原始输入,第二个参数是旁路目标,返回值仍符合 io.Reader,所以可以继续交给 io.ReadAll、io.Copy 或自定义解析器。

package main

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

func main() {
    source := strings.NewReader("order=2026-11&status=ready")
    var mirror bytes.Buffer

    // TeeReader 仍然返回 Reader,读取它时才会触发旁路写入。
    observed := io.TeeReader(source, &mirror)
    data, err := io.ReadAll(observed)
    if err != nil {
        // ReadAll 会把读取链路中的 Writer 错误返回给调用方。
        log.Fatal(err)
    }

    // data 是主流程拿到的内容,mirror 是同步写入的旁路副本。
    fmt.Printf("main=%s mirror=%s\n", data, mirror.String())
}

这里真正驱动流程的是 io.ReadAll(observed)。仅创建 TeeReader 不会主动读取输入,也不会提前填充 mirror;只有下游调用 Read 时,数据才沿着这条链路流动。

Reader 经过 io.TeeReader 后同时流向主消费者和旁路 Writer 的结构说明图
图1:io.TeeReader 的读取与同步旁路写入结构图,属于静态说明图,不是运行截图。

按接口语义选择旁路目标

使用时最容易混淆的是三个角色:原始输入是 Reader,旁路接收端是 Writer,而 TeeReader 本身还是给下游消费的 Reader。它不是把多个 Writer 组合起来的工具,也不会把数据保存到内部缓存后再异步发送。

角色接口职责
原始来源io.Reader提供待消费的字节
旁路目标io.Writer接收每次读取到的字节
TeeReader 返回值io.Reader供主流程继续读取

因此,日志留存可以使用 bytes.Buffer 或文件 Writer,摘要计算可以使用实现了 io.Writer 的哈希对象,而主业务仍从 TeeReader 读取。若旁路目标是网络连接或文件,还要把它们自身的关闭和生命周期交给调用方管理。

处理 Writer 错误如何回到 Read

官方文档明确说明:TeeReader 没有内部缓冲,写入必须完成后读取才会完成;旁路写入遇到的错误会作为读取错误报告。这让调用方可以只检查一条读取链路,但也意味着慢 Writer 会直接拖慢 Reader。

package main

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

type failWriter struct{}

func (failWriter) Write(p []byte) (int, error) {
    // 模拟旁路目标不可用,返回已接受字节数为零的错误。
    return 0, errors.New("mirror writer unavailable")
}

func main() {
    source := strings.NewReader("payload")
    observed := io.TeeReader(source, failWriter{})

    data, err := io.ReadAll(observed)
    // 读取结果和错误都要检查;错误来自 TeeReader 的旁路写入。
    fmt.Printf("bytes=%d data=%q err=%v\n", len(data), data, err)
}

这个语义有两个工程含义:

  • 不能只看读取到的字节数而忽略错误;旁路失败时,主流程可能已经拿到部分数据,但这份数据不一定已经完整写入观察目标。
  • 如果 Writer 的处理速度明显低于 Reader,TeeReader 会形成同步背压。需要解耦速度时,应重新设计队列、落盘或异步管道,而不是期待 TeeReader 自带缓冲。
Read 调用等待 Write 完成并在旁路写入失败时返回读取错误的关系图
图2:读取等待写入完成、成功继续和失败回传的错误语义图,属于静态说明图,不是运行截图。

和 MultiWriter、Copy 组合成可复用流程

io.TeeReader 适合“读取过程中观察一份副本”;io.MultiWriter 适合“同一次写入分发到多个 Writer”。如果主流程本来就是流式复制,可以把 TeeReader 作为 io.Copy 的来源:

package main

import (
    "io"
)

func copyWithMirror(dst io.Writer, src io.Reader, mirror io.Writer) (int64, error) {
    // Copy 负责消费 Reader,TeeReader 负责把相同字节同步写给 mirror。
    observed := io.TeeReader(src, mirror)
    // 返回值包含复制字节数和读取或旁路写入链路中的首个错误。
    return io.Copy(dst, observed)
}

可以按下面的决策表选择组合:

目标更合适的入口注意事项
主消费时顺便留一份副本io.TeeReader旁路写入同步发生,错误回到 Read
一次写入发给多个目标io.MultiWriter它实现的是 Writer,不是 Reader
把输入持续复制到一个输出io.Copy可把 TeeReader 作为 src 组合进去

落地时记住这四个接口决定

  1. 先确认主流程确实会读取包装后的 Reader;创建包装器本身不会触发任何写入。
  2. 把旁路 Writer 当成同步依赖,慢写入会增加读取延迟。
  3. 同时处理 n 和 err,不要因为收到了部分数据就忽略错误。
  4. 需要异步、可重试或有界队列时,把这些能力放在更高层的组件中,并明确丢弃、阻塞和失败策略。

一句话总结:io.TeeReader 不是复制函数,而是把一个 Writer 嵌入读取路径的适配器。它让主消费者保持 Reader 接口,同时获得一条同步、无内部缓冲、错误可见的旁路。

io.TeeReader 会自动读取数据吗?

不会。它只包装输入;下游真正调用 Read 时,才会从原始 Reader 读取并写入旁路 Writer。

旁路 Writer 写入失败时应该检查什么?

检查读取调用返回的错误,同时根据业务决定是否丢弃部分结果、重试旁路目标或终止主流程。

想把数据写到多个地方能直接传多个 Writer 吗?

不能。TeeReader 只接受一个 Writer;多个目标可以在旁路位置使用 io.MultiWriter,但要接受它们共享同步写入和错误传播语义。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>