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

Go hex.Dumper 怎么流式输出可读十六进制内容

来源:17golang原创

时间:2026-10-04 14:29:45 159浏览 收藏

需要持续查看文件、网络载荷或二进制协议时,不必先把全部字节读进内存。Go 的 encoding/hex 提供了 hex.Dumper:把它接到任意 io.Writer,后续分块调用 Write,就能得到接近 hexdump -C 的偏移、十六进制和 ASCII 可读列。关键是最后一定调用 Close,否则不足 16 字节的尾行不会完成。

要点速览
  • hex.Dumper(w) 返回的是 io.WriteCloser,目标可以是文件、缓冲区或标准输出。
  • 写入可以被任意分块,Dumper 自己维护 16 字节行宽和累计偏移。
  • Close 负责补齐尾行;要同时处理每次 Write 和最终 Close 的错误。

把 hex.Dumper 接到任意 io.Writer

Dumper 不要求输入一次到位。下面的示例用 bytes.Buffer 接收结果,实际项目也可以换成 os.File、网络响应写入器或日志管道。示例刻意分三次写入,说明分块边界不会改变十六进制行的组织方式。

package main

import (
    "bytes"
    "encoding/hex"
    "fmt"
    "log"
)

func main() {
    var out bytes.Buffer
    dumper := hex.Dumper(&out)

    // 分块写入模拟网络或文件读取,不要求每次正好写满一行。
    chunks := [][]byte{[]byte("Go "), []byte("binary"), []byte(" data")}
    for _, chunk := range chunks {
        if _, err := dumper.Write(chunk); err != nil {
            log.Fatal(err)
        }
    }
    // 尾行可能不足 16 字节,Close 会补齐空格并写出 ASCII 区。
    if err := dumper.Close(); err != nil {
        log.Fatal(err)
    }
    fmt.Print(out.String())
}
Go hex.Dumper 通过 io.Writer 接收输入并组织偏移列、十六进制列和 ASCII 可读列的结构说明图
图1:hex.Dumper 与 io.Writer 的关系说明图,展示输入字节与三类可读输出区域的静态对应关系。

输出的左侧偏移从 00000000 开始,中间是每个字节的两位十六进制值,右侧把不可打印字节显示为点号。这里的图是结构说明图,用来理解字段关系,不代表某次本机运行截图。

Write 如何处理跨分块的 16 字节行

官方实现按 16 字节组织一行,并在内部维护当前行已写入的字节数和累计偏移。因此一次只写 3 个字节、下一次再写 13 个字节,与一次写 16 个字节,最终行布局是一致的。用 io.Copy 连接流时也遵循同一规则:

// src 可以是文件、网络响应或其他 io.Reader。
func dumpReader(src io.Reader, dst io.Writer) error {
    dumper := hex.Dumper(dst)
    // io.Copy 负责持续搬运数据,Dumper 负责格式化每个字节。
    if _, err := io.Copy(dumper, src); err != nil {
        // 输入读取或中途写入失败时,先保留原错误上下文。
        _ = dumper.Close()
        return err
    }
    // 即使 Copy 成功,尾行收尾也可能暴露目标 writer 的错误。
    return dumper.Close()
}

这段代码中的 io.Reader 和 io.Writer 需要在调用文件中导入 io。如果 Close 失败,不应把它当成无关紧要的清理错误:尾行还没有可靠写入,日志或诊断结果可能因此不完整。

Close 决定最后一行是否完整

hex.Dumper 是 io.WriteCloser,不是只提供 Write 的普通写入器。完整行在第 16 个字节写入时会自然闭合;如果最后只剩几个字节,Close 会把十六进制区补空格,再写入右侧 ASCII 区和换行。

Go hex.Dumper 以 16 字节行宽维护 h.used 并由 Close 完成尾行和 closed 状态的结构说明图
图2:Close 收尾边界结构说明图,强调不足 16 字节的数据仍要闭合 ASCII 区。

关闭后再次写入不会继续追加数据,官方实现会返回 encoding/hex: dumper closed。所以不要把一个已关闭的 Dumper 放回对象池后直接复用;如果确实需要复用,应重新创建一个 Dumper 并绑定新的目标。

按任务选择 Dumper、Dump 还是 EncodeToString

需求适合的 API判断
边读边输出调试格式hex.Dumper不需要攒齐全部输入,输出带偏移和 ASCII 列
已有完整字节切片,马上得到文本hex.Dump返回一个字符串,格式同样接近 hexdump -C
只需要紧凑的十六进制字符串hex.EncodeToString没有偏移列和 ASCII 列,适合令牌或摘要展示

边界可以这样记:Dumper 解决的是“持续写入并保持可读布局”,Dump 解决的是“已有切片的一次性转储”,而 EncodeToString 解决的是“只要连续十六进制字符”。不要为了得到调试列而先把大文件完整读入内存。

常见问题

每次 Write 必须写满 16 字节吗?

不需要。Dumper 会记住当前行状态,下一次写入会接着填充;只有全部输入结束后才需要调用 Close。

为什么 Close 也要检查 error?

尾行的补空格、ASCII 区和换行是在 Close 中写出的,底层文件或网络 writer 可能在这一刻才返回错误。

能把 Dumper 当成普通 io.Writer 长期保存吗?

可以保存为写入阶段的依赖,但一旦调用 Close,它就进入关闭状态;后续写入会报错,应为新的目标重新创建。

因此,Go 中流式输出可读十六进制内容的最小可靠组合就是:创建 hex.Dumper,持续检查 Write,输入结束后检查 Close。这三点同时满足,分块输入、短尾行和底层写入错误才不会被悄悄掩盖。

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