0

0

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

花韻仙語

花韻仙語

发布时间:2026-01-11 22:57:39

|

625人浏览过

|

来源于php中文网

原创

如何在 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
}

? 关键优势

GitHub Copilot
GitHub Copilot

GitHub AI编程工具,实时编程建议

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

⚠️ 注意事项:

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

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

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

408

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

532

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

309

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

253

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

206

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1463

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

616

2023.11.24

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

80

2026.01.09

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号