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

Go compress/gzip 怎样从 gzip Header 读取原始文件名

来源:17golang原创

时间:2026-10-18 06:47:56 318浏览 收藏

如果 gzip 压缩流里确实写入了文件名,Go 不需要手工解析前 10 个字节。调用 gzip.NewReader 成功后,直接读取 zr.Name;它来自 gzip Header 的可选文件名字段。若字段没有写入,结果就是空字符串,不能拿压缩文件在磁盘上的名字代替。

官方文档:https://pkg.go.dev/compress/gzip

要点速览
  • gzip.Reader 嵌入了 Header,NewReader 返回后即可读取 Name。
  • Header 文件名是可选元数据,生产代码必须允许它为空。
  • 完整读取到 io.EOF 再关闭 Reader,才能让长度和 CRC 校验完成。

用 Header.Name 读取 gzip 文件名

下面的示例先在内存中写入一个带文件名的 gzip 成员,再重新读取它。写入端必须在第一次 Write、Flush 或 Close 前设置 Header 字段;读取端则在 NewReader 返回后查看 Name。

package main

import (
    "bytes"
    "compress/gzip"
    "fmt"
    "io"
    "log"
)

func main() {
    var compressed bytes.Buffer
    zw := gzip.NewWriter(&compressed)
    // Header 要在第一次写入前设置,Name 只是可选元数据。
    zw.Name = "report.txt"
    if _, err := zw.Write([]byte("daily report")); err != nil {
        log.Fatal(err)
    }
    // Close 会写出尚未刷新的压缩数据和 gzip 尾部校验信息。
    if err := zw.Close(); err != nil {
        log.Fatal(err)
    }

    zr, err := gzip.NewReader(bytes.NewReader(compressed.Bytes()))
    if err != nil {
        log.Fatal(err)
    }
    // Name 来自 gzip Header;没有 FNAME 时这里可能是空字符串。
    fmt.Printf("原始文件名: %q\\n", zr.Name)
    body, err := io.ReadAll(zr)
    if err != nil {
        log.Fatal(err)
    }
    // 读到 EOF 后再关闭,才能完成长度与 CRC 校验。
    if err := zr.Close(); err != nil {
        log.Fatal(err)
    }
    fmt.Printf("解压内容: %s\\n", body)
}

关键点是 zr.Name 和 body 来自两条不同的信息路径:前者是压缩成员的 Header 元数据,后者是解压后的正文。两者都为空或失败时,应分别排查 Header 是否存在、数据流是否完整。

Go compress/gzip 中 gzip 字节流、gzip.Reader、Header.Name 与解压数据的静态结构关系
图1:gzip Header 与解压数据的静态结构说明图,不是截图或运行证据。

文件名为空时不要猜测来源

gzip 格式允许文件名不出现。即使文件路径叫 backup.gz,也不能推断 Header.Name 应该是 backup;磁盘路径属于外层文件系统,Header.Name 属于压缩流内部。需要业务名称时,应明确制定回退策略,例如使用调用方传入的逻辑名,并把“Header 未提供文件名”记录为一个可识别状态。

Go 文档还规定 Header 中的字符串必须是 UTF-8,并受 gzip 格式可表示字符范围限制。不要把任意本地路径、目录分隔符或未确认编码直接塞进 Writer.Name。它也不是安全路径:解压时不能因为读到了 Name 就直接拼接到目标目录。

字段含义使用边界
Reader.Name读取到的 gzip 文件名可为空;只代表当前记录的 Header
Reader.CommentHeader 注释同样是可选元数据
Reader.ModTime压缩成员的修改时间不能等同于本地文件 mtime

多成员 gzip 的 Header 只看当前边界

一个 gzip 文件可以串联多个独立成员。默认 Multistream(true) 时,读取器会把各成员的解压数据拼起来返回,但 Reader 字段只记录第一个 Header。因此循环读取一个多成员文件时,不能把一次 ReadAll 得到的正文和每个成员的文件名一一对应。

如果业务必须逐个成员读取,应让底层输入实现 io.ByteReader,调用 zr.Multistream(false),读完当前成员后再用 zr.Reset 进入下一成员。此时每次 Reset 后读取到的 zr.Name 才对应新的当前 Header;没有下一个成员时,Reset 会返回 io.EOF。

Go gzip 多成员读取中 Multistream、首个 Header、Header.Name 与 Reset 的静态边界
图2:多成员 gzip 的 Header 记录边界说明图,不是截图或运行证据。

接入 os.File 时的检查清单

  1. 先检查 os.Open 和 gzip.NewReader 的错误;不要把普通文件误当 gzip。
  2. 把 zr.Name 当作可选字符串,空值时走业务定义的回退名。
  3. 把数据读到 io.EOF,再处理 Read 或 Close 返回的校验错误。
  4. 关闭 gzip.Reader 不会替底层 os.File 关闭,两个资源分别负责。

相关问题

Header.Name 为什么经常是空字符串?

因为 gzip 文件可以不携带可选文件名。空值表示“Header 没提供名称”,不表示解压失败。

读取 Name 前要先 Read 一次吗?

不需要。NewReader 或 Reset 成功后,Reader 的 Header 字段就已可读取。

只调用 Close 能验证 CRC 吗?

不能把它当成完整校验。应继续读取到 io.EOF,因为 gzip 的长度和 checksum 在读到压缩成员末尾时才会被检查。

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