如何在 Go 中为同时包含导出与非导出字段的结构体实现自定义 JSON 序列化

14次阅读

如何在 Go 中为同时包含导出与非导出字段的结构体实现自定义 JSON 序列化

gojson 包默认仅序列化导出(大写首字母)字段,但通过实现 marshaljson 和 unmarshaljson 方法,可安全地包含非导出字段——关键在于避免递归调用,推荐使用独立的中间结构体(如 testjson)进行桥接。

go 中,JSON 编解码默认仅处理导出字段(即首字母大写的字段),这是由语言的可见性规则决定的。若需在 JSON 中保留非导出字段(如 fieldA),必须手动实现 json.Marshaler 和 json.Unmarshaler 接口。但直接在 MarshalJSON 中调用 json.Marshal(t) 会导致无限递归——因为这又会触发 t.MarshalJSON() 自身,最终溢出。

✅ 正确做法是:引入一个纯导出字段的中间结构体(DTO),作为 JSON 数据的“镜像”,并在 MarshalJSON/UnmarshalJSON 中显式映射原始结构体与该 DTO:

type Test Struct {     fieldA string // 非导出,需手动参与 JSON     FieldB int    // 导出,可自动参与(但统一走 DTO 更清晰可控)     FieldC string // 导出 }  // TestJSON 是仅用于 JSON 编解码的导出结构体,字段名与 JSON key 对齐 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 }

? 关键优势

  • ✅ 完全避免递归:json.Marshal 操作的是 TestJSON(无自定义方法的 Plain Struct),不会触发 Test.MarshalJSON;
  • ✅ 类型安全 & 可维护:字段映射集中、显式,新增字段只需同步更新 TestJSON 和两个方法,ide 可提示缺失项;
  • ✅ 兼容标准库行为:支持 omitempty、自定义 tag、嵌套结构等所有 json tag 特性;
  • ✅ 无副作用:不修改原始结构体设计(无需将 fieldA 强行导出破坏封装)。

⚠️ 注意事项:

  • 不要使用匿名嵌入 *Test(如原错误示例),这仍会触发递归;
  • UnmarshalJSON 中应使用局部变量 temp 而非 &t(t 是指针,&t 是指向指针的指针,类型不匹配);
  • 若结构体含嵌套自定义类型,中间结构体也需对应定义,并在编解码中逐层桥接;
  • 如需深度一致性(如字段校验、默认值填充),可在 UnmarshalJSON 赋值后添加逻辑。

总结:当必须混合导出与非导出字段参与 JSON 时,中间结构体模式是最清晰、最健壮、最符合 Go 习惯的解决方案。它兼顾封装性、可读性与可维护性,远优于手动拼接 JSON 字符串或强行导出敏感字段。

text=ZqhQzanResources