如何在 Go 中同时序列化和反序列化结构体的导出与非导出字段

本文介绍一种安全、清晰且可维护的方式,让 go 的 `json.marshal/unmarshal` 同时处理结构体中导出(首字母大写)与非导出(小写首字母)字段,避免递归调用导致的栈溢出,并保持代码可扩展性。

在 Go 中,encoding/json 包默认仅序列化导出字段(即首字母大写的字段),这是由 Go 的可见性规则决定的。因此,像 fieldA string 这样的非导出字段不会出现在 JSON 输出中,即使你为其设置了 json:"fieldA" 标签。若需同时处理导出与非导出字段,不能依赖嵌入原结构体或直接递归调用 json.Marshal(t)(这会导致无限递归和栈溢出),而应采用「中间结构体(DTO)」模式——即定义一个专用于 JSON 编解码的公开结构体,显式映射所有需传输的字段。

以下是一个推荐实现:

type Test struct {
    fieldA string // 非导出,但需参与 JSON 传输
    FieldB int    // 导出,自然参与
    FieldC string // 导出,自然参与
}

// TestJSON 是专用于 JSON 编解码的公开 DTO 结构体
// 字段全部导出,且标签与预期 JSON 键名一致
type TestJSON struct {
    FieldA string `json:"fieldA"`
    FieldB int    `json:"fieldB"`
    FieldC string `json:"fieldC"`
}

func (t *Test) MarshalJSON() ([]byte, error) {
    return json.Marshal(TestJSON{
        FieldA: t.fieldA,
        FieldB: t.FieldB,
        FieldC: t.FieldC,
    })
}

func (t *Test) UnmarshalJSON(b []byte) error {
    var temp TestJSON
    if err := json.Unmarshal(b, &temp); err != nil {
        return err
    }
    // 显式赋值回原结构体(含非导出字段)
    t.fieldA = temp.FieldA
    t.FieldB = temp.FieldB
    t.FieldC = temp.FieldC
    return nil
}

优势说明:

  • 无递归风险:MarshalJSON 不再调用 json.Marshal(t),而是构造并序列化独立的 TestJSON 值;
  • 类型安全 & 可读性强:字段映射一目了然,新增字段只需同步更新 TestJSON 和两个方法,IDE 可自动提示缺失项;
  • 零反射开销:相比泛型或反射方案,此方式编译期确定,性能更优;
  • 兼容标准库行为:完全遵循 json.Marshaler/json.Unmarshaler 接口规范,可无缝集成 http, gin, echo 等框架。

⚠️ 注意事项:

  • 若 Test 字段较多或频繁变更,建议配合代码生成工具(如 stringer 或自定义 go:generate 脚本)自动化 TestJSON 和编解码逻辑,进一步降低维护成本
  • 切勿在 UnmarshalJSON 中使用 &t(即 json.Unmarshal(b, &t)),这会尝试解码到 *Test 指针本身,而 t 是指针,Go 会尝试设置其字段——但非导出字段不可寻址赋值,且仍可能触发隐式递归;正确做法是解码到临时变量再手动赋值;
  • 如该结构体需支持其他序列化格式(如 XML、YAML),可复用同一 TestJSON 模式,仅调整标签即可。

总结:与其绕过 Go 的可见性设计强行“hack”非导出字段的 JSON 行为,不如拥抱其约定——用轻量 DTO 分离数据契约(JSON 层)与领域模型(内存结构)。这不仅解决了当前问题,更提升了接口清晰度与长期可维护性。