Go 本地缓存怎么用 gob 保存并恢复结构体

Go 本地缓存如果只服务 Go 程序之间的读写，encoding/gob 是一个很顺手的选择：它能把结构体写成带类型信息的二进制流，再从文件恢复到另一个结构体变量。实际使用时不要只写一句 gob.NewEncoder(file).Encode(v) 就结束，真正容易出问题的是导出字段、文件半写入、结构体改版和过期缓存。

最稳妥的做法是：定义一个专用缓存结构体，只保留可恢复的导出字段；先写临时文件，编码成功后再替换正式文件；读取时把文件不存在、解码失败和已过期分开处理。

先把缓存对象边界定清楚

不要直接把业务对象原样落盘。可以定义一个专门的 CacheEntry，把版本、过期时间和业务数据放在一起。字段名比声明顺序更重要：发送端多出的字段在接收端会被忽略，接收端新增的字段会保留零值；同名字段则必须类型兼容。只有导出字段才会进入 gob 流。

用临时文件完成一次完整写入

下面的例子把编码目标放在临时文件中，只有 Encode 和关闭都成功，才把它重命名为正式缓存文件。os.Rename 在同一文件系统内通常是一个明确的替换边界；如果程序跨平台运行，仍应把权限、目录存在性和并发写入策略纳入自己的封装。

package cache

import (
    "encoding/gob"
    "fmt"
    "os"
    "path/filepath"
    "time"
)

type CacheEntry struct {
    Version   uint8
    ExpiresAt time.Time
    Payload   map[string]string
}

func Save(path string, entry CacheEntry) error {
    // 临时文件和正式文件放在同一目录，便于完成替换边界。
    dir := filepath.Dir(path)
    tmp, err := os.CreateTemp(dir, ".cache-*.tmp")
    if err != nil {
        return fmt.Errorf("create cache temp file: %w", err)
    }
    tmpName := tmp.Name()
    defer os.Remove(tmpName) // 任何失败都清理残留临时文件。

    // Encode 成功只代表数据写入了文件，还要检查 Close 的结果。
    if err := gob.NewEncoder(tmp).Encode(entry); err != nil {
        _ = tmp.Close()
        return fmt.Errorf("encode cache: %w", err)
    }
    if err := tmp.Close(); err != nil {
        return fmt.Errorf("close cache temp file: %w", err)
    }
    if err := os.Rename(tmpName, path); err != nil {
        return fmt.Errorf("replace cache file: %w", err)
    }
    return nil
}

这里没有把函数、通道或未导出字段当作可持久化数据。缓存目录也应提前创建；如果多个 goroutine 会同时写同一个 key，应该在更上层按 key 加锁，避免“最后完成的写入”覆盖掉业务上更新的内容。

读取时区分不存在、损坏和过期

恢复时必须传入结构体指针，因为 Decode 需要把值写入目标对象。文件不存在通常意味着首次启动或缓存自然淘汰，可以回源；文件存在但解码失败，则更像是损坏或格式不兼容，适合删除并重新生成，同时保留日志。

func Load(path string, now time.Time) (CacheEntry, error) {
    var entry CacheEntry
    file, err := os.Open(path)
    if err != nil {
        // 不存在是可预期的缓存未命中，交给调用方回源。
        if os.IsNotExist(err) {
            return CacheEntry{}, fmt.Errorf("cache miss: %w", err)
        }
        return CacheEntry{}, fmt.Errorf("open cache: %w", err)
    }
    defer file.Close() // 解码结束后释放文件描述符。

    if err := gob.NewDecoder(file).Decode(&entry); err != nil {
        return CacheEntry{}, fmt.Errorf("decode cache: %w", err)
    }
    if entry.Version != 1 || !entry.ExpiresAt.After(now) {
        // 版本不匹配或已经过期，都按缓存未命中处理。
        return CacheEntry{}, fmt.Errorf("stale cache: version=%d", entry.Version)
    }
    return entry, nil
}

调用方可以根据错误类型决定动作：cache miss 回源，decode cache 记录并删除坏文件，stale cache 重新加载。若需要精确判断，生产代码可以定义带原因的错误类型，而不是依赖错误字符串。

结构体改版时保留可控兼容

gob 的结构体匹配按字段名进行，因此给结构体增加一个导出字段，旧缓存通常能解码，新增字段得到零值；删除字段时旧数据中的该字段会被忽略。但“同名字段改类型”不应当赌兼容性，最好提升 Version，在读取时明确走迁移或回源路径。

还要留意几个边界：指针不会按地址保存，保存的是所指向的值；循环引用的值不适合直接编码；接口字段如果承载具体类型，需要在编码和解码两端注册具体类型。gob 主要面向 Go 数据流，不是跨语言协议。

常见问题

为什么 gob 解码后某些字段是空的？

先检查字段是否以大写字母开头。未导出字段不会被 gob 编码；再检查接收结构体中的同名字段类型是否兼容。

Encode 结构体时应该传值还是指针？

两者都可以，gob 会做必要的解引用；读取时必须把目标结构体的地址传给 Decode，例如 Decode(&entry)。

gob 文件能不能让用户上传后直接解码？

不建议。官方文档提醒 gob 不针对对抗性输入做强化，解码不可信数据可能消耗较多资源。只从受控的本地缓存目录读取。

本地缓存是否一定要用 gob？

不一定。只在 Go 内部、结构体形态稳定且更在意实现简单时使用 gob；需要跨语言、可读性或长期协议兼容时，应选有明确 schema 的格式。