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

Go io.ReadFull 怎样读取固定长度数据并区分短读

来源:17golang原创

时间:2026-11-18 20:53:44 491浏览 收藏

固定长度读取最容易踩的坑,是把一次 Read 当成“必定读满”。真正的 io.Reader 只承诺本次最多填充给定缓冲区,返回的 n 可能小于 len(buf)。如果业务要求“记录不完整就不要解析”,应直接使用 io.ReadFull:读满才返回 nil,没有读到任何字节时返回 io.EOF,读到一部分后输入结束时返回 io.ErrUnexpectedEOF。

官方地址:https://pkg.go.dev/io#ReadFull

把固定长度当作输入契约:用 n == len(buf) 判断是否读满,用 errors.Is(err, io.ErrUnexpectedEOF) 识别残缺记录;不要因为 n > 0 就把半截缓冲区交给解析器。

普通 Read 为什么会让固定长度记录变短

假设一条记录固定占 8 个字节,底层数据暂时只提供了 3 个字节。普通 Read 可以返回 n=3,这不是违反接口约定,而是“当前能读到多少就先返回多少”。网络流、管道和带缓冲 Reader 都可能出现这种情况。

// 这个写法不能把一次 Read 当成读满保证。
buf := make([]byte, 8)
n, err := r.Read(buf)
if err != nil {
    // 先保留 n,再按错误决定是否丢弃这条记录。
    return fmt.Errorf("读取记录头:%w", err)
}
if n != len(buf) {
    // 短读不一定是 EOF,不能在这里直接解析半条记录。
    return fmt.Errorf("记录不完整:收到 %d/%d 字节", n, len(buf))
}

如果调用方愿意自己循环,也可以不断读取直到填满;但“循环、累计 n、处理 EOF 和残缺输入”本身就是一个固定长度契约。io.ReadFull 把这层约定集中起来,调用处只需要判断结果。

io.Reader、io.ReadFull、目标缓冲区以及 n 和 err 返回值的静态关系说明图
图1:静态结构说明图,查看 Reader、固定长度缓冲区与 n/err 返回值之间的关系;这不是运行截图。

用 io.ReadFull 表达“必须读满”

io.ReadFull(r, buf) 会持续从 r 读取,直到填满 buf 或遇到错误。成功条件很明确:n == len(buf) 且 err == nil。这比在业务代码里写一个只覆盖“常见一次读满”的判断更可靠。

// 固定长度记录只有读满后才交给后续解析函数。
func readHeader(r io.Reader) ([]byte, error) {
    header := make([]byte, 8)
    n, err := io.ReadFull(r, header)
    if err != nil {
        // n 仍然有意义:它表示本次已经拿到多少字节。
        return nil, fmt.Errorf("读取 8 字节头部失败,已读 %d:%w", n, err)
    }
    // err 为 nil 时,io.ReadFull 保证 n == len(header)。
    return header, nil
}

这里没有把 io.ReadFull 当作“忽略所有错误”的工具。它只是把短读循环和标准错误归一化,非 EOF 的底层错误仍会返回给调用方。

把 EOF、ErrUnexpectedEOF 和自定义错误分成三类

固定长度记录通常需要三种业务分流。io.EOF 表示开始读取前输入已经结束,常见于“正常遍历到文件末尾”;io.ErrUnexpectedEOF 表示已经读到一部分,但还不够一个完整记录;其他错误则应保留其根因。

// 按错误类别决定是结束、丢弃残缺记录,还是继续上抛。
func classifyRecord(r io.Reader) error {
    record := make([]byte, 8)
    n, err := io.ReadFull(r, record)
    switch {
    case err == nil:
        // 只有完整记录才进入解析阶段。
        return parseRecord(record)
    case errors.Is(err, io.EOF) && n == 0:
        // 没有新字节:把它视为输入正常结束。
        return io.EOF
    case errors.Is(err, io.ErrUnexpectedEOF):
        // 已经拿到半条记录:不要继续解析,交给上层决定丢弃或报警。
        return fmt.Errorf("残缺记录:收到 %d/%d 字节:%w", n, len(record), err)
    default:
        // 保留底层错误,便于区分网络、文件或自定义 Reader 故障。
        return fmt.Errorf("读取固定长度记录:%w", err)
    }
}

判断 io.EOF 时同时看 n == 0,是为了表达“一个新记录都没有开始”。而 ErrUnexpectedEOF 只说明固定长度目标没有完成,已读字节仍在缓冲区里,但它们不构成可交付的完整记录。

固定长度记录对应读满、EOF、ErrUnexpectedEOF 和源 Reader 错误的静态边界图
图2:静态错误边界说明图,查看固定长度契约如何对应成功、空输入和残缺输入;这不是运行截图。

把固定长度契约放在解析器之前

如果后续使用 binary.Read、自定义反序列化器或字段切片,最好先完成固定长度读取,再进入解析阶段。这样解析器面对的永远是完整缓冲区,错误边界也集中在输入层。

  • 记录长度已知:优先分配固定大小缓冲区并调用 io.ReadFull。
  • 记录长度来自外部:先单独读取并限制长度,再为正文建立明确的上限。
  • 遇到 ErrUnexpectedEOF:不要把当前缓冲区当成默认值继续解析。
  • 遇到自定义错误:用 %w 包装,调用方仍可使用 errors.Is 或 errors.As 判断。

速查起来,可以记住一条:Read 适合“尽可能拿到当前数据”,ReadFull 适合“拿不到完整数据就失败”。两者不是谁更快的问题,而是输入契约不同。

相关问题

io.ReadFull 成功时还需要检查 n 吗?

建议保留检查习惯。按它的契约,err == nil 时 n == len(buf);业务日志若需要记录实际读取量,也可以继续使用 n。

为什么不能只判断 err == io.EOF?

因为输入在读到部分数据后结束时,io.ReadFull 返回的是 io.ErrUnexpectedEOF。用 errors.Is 判断更稳妥,也能兼容上层包装错误。

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