当前位置:

首页 > 编程开发 > 如何在Golang中自定义JSON序列化行为 Go语言Marshaler接口与自定义接收器解析

如何在Golang中自定义JSON序列化行为 Go语言Marshaler接口与自定义接收器解析

很多开发者在使用 Go 的 json.Marshal 时,会发现自定义的 MarshalJSON 方法没有被调用,或者序列化结果和预期出入很大。这个问题的根源在于:json.Marshal 只在类型直接实现 json.Marshaler 或 json.Unmarshaler 接口的时候才会乖乖调用对

本文目录

    很多开发者在使用 Go 的 json.Marshal 时,会发现自定义的 MarshalJSON 方法没有被调用,或者序列化结果和预期出入很大。这个问题的根源在于:json.Marshal 只在类型直接实现 json.Marshaler 或 json.Unmarshaler 接口的时候才会乖乖调用对应方法。如果使用指针接收器实现但传入的是值类型,或者字段中包含未导出、不支持的类型,那方法要么不触发,要么直接报错。

    如何在Golang中自定义JSON序列化行为 Go语言Marshaler接口与自定义接收器解析

    为什么 json.Marshal 不调用你的方法?

    这是 Go 新手最常踩的坑之一。你要知道,Go 的 JSON 序列化只认两个接口:json.Marshaler 和 json.Unmarshaler,而且只在你给类型直接实现这两个接口时才生效。最常见的翻车姿势是:给指针类型实现了接口,但传入 json.Marshal 的却是值类型变量——这时候方法根本不会触发。

    举个例子,你写了 func (t *MyType) MarshalJSON() ([]byte, error),但传进去的是 MyType{}(非指针),那 MarshalJSON 直接隐身。

    • 检查接收器类型:值接收器对应值变量,指针接收器对应指针变量或取地址后的值
    • 确认变量实际类型:用 fmt.Printf("%T", v) 看看传进去的是 MyType 还是 *MyType
    • 如果结构体字段是值类型,嵌入时也要保持接收器一致性,否则嵌套序列化会直接跳过你写的自定义逻辑

    如何让时间字段输出为 "2006-01-02" 而不是 RFC3339?

    标准库 time.Time 的 MarshalJSON 默认输出带时区和纳秒的完整 RFC3339 字符串,但业务场景往往只需要一个简洁的日期格式,比如 "2006-01-02"。直接改 time.Time 是不可能的(标准库类型不可修改),所以得包装一层。

    推荐的做法是:定义一个新类型,然后实现 json.Marshaler:

    type Date time.Time
    
    func (d Date) MarshalJSON() ([]byte, error) {
        return []byte(`"` + time.Time(d).Format("2006-01-02") + `"`), nil
    }
    
    // 用法:struct 中字段类型声明为 Date,不是 time.Time
    type Event struct {
        When Date `json:"when"`
    }
    • 注意返回的字节必须包含双引号,json.Marshal 不会自动帮你加
    • 别漏掉 time.Time(d) 类型转换,否则 Format 方法不可用
    • 如果还需要反序列化,必须同时实现 UnmarshalJSON,并且处理带引号的字符串输入

    嵌套结构体里部分字段想忽略,但又不想用 json:"-"?

    全局忽略用 tag 确实最方便,但有时逻辑更复杂:比如你希望只在特定状态(如 Status == "draft")下才忽略某个字段。这时候 tag 就搞不定了,得靠自定义 MarshalJSON 手动控制哪些字段输出、哪些不输出。

    核心思路:手动构造一个 map,按条件决定是否加入键值对,然后再用 json.Marshal 编码这个 map:

    func (u User) MarshalJSON() ([]byte, error) {
        type Alias User // 防止无限递归
        raw := struct {
            *Alias
            CreatedAt string `json:"created_at,omitempty"`
        }{
            Alias: (*Alias)(&u),
        }
        if u.Status != "draft" {
            raw.CreatedAt = u.CreatedAt.Format(time.RFC3339)
        }
        return json.Marshal(raw)
    }
    • 用 type Alias User 是关键,避免调用自身的 MarshalJSON 导致死循环
    • 字段名大小写必须和目标 JSON key 一致,否则字段不会出现
    • 不要试图在 MarshalJSON 里直接拼接 JSON 字符串,容易出错且难维护;优先走 map 或匿名 struct 路线

    为什么实现了 MarshalJSON 却仍报 json: unsupported type?

    你可能会纳闷:明明实现了接口,为什么还报错?其实这个错误通常不是接口没实现的问题,而是底层字段类型根本不被 json.Marshal 支持。比如字段是 func、chan、map[interface{}]interface{} 或是未导出字段(小写开头)。

    • 检查结构体中所有字段是否可导出(首字母大写),否则即使实现了接口,内部字段也无法被反射访问
    • 确认没有嵌入不支持的类型:例如 http.Handler、sync.Mutex 等,它们本身不可序列化
    • 如果用了 map[string]interface{} 存动态数据,确保值类型都在 JSON 支持范围内(string/int/float/bool/map/slice/nil)
    • 第三方类型(如 uuid.UUID)需自行实现 MarshalJSON,或用其自带的序列化方法转成字符串再存

    最稳妥的做法:在自定义 MarshalJSON 中显式列出要序列化的字段,不依赖反射自动遍历。这样既能避免 unsupported type 报错,又能精确控制输出内容。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发 JSON
    相关文章 更多
    Java发送post请求发送json数据的实现方法与代码示例
    Java发送post请求发送json数据的实现方法与代码示例

    深入解析Java发送JSON格式POST请求的实现机制,对比原生API与第三方库的代码差异,提供可复制的代码示例,并探讨超时设置、编码处理及微服务场景下的例外情况。

    抖音官网入口网页
    抖音官网入口网页

    抖音官网入口的正确打开方式 如果你在寻找抖音网页版的入口,那么直接访问 https://www.douyin.com 就是了。这不仅是通往海量短视频世界的门户,更是一个功能越来越专业的媒体素材库和创作工具箱。为什么这么说?看看它最近在功能上的深度拓展就知道了。 简单一个网址背后,其实是一个日益精密的

    在小说搜搜找不到想看的小说怎么办?小说搜搜换源功能使用详解【必学】
    在小说搜搜找不到想看的小说怎么办?小说搜搜换源功能使用详解【必学】

    小说搜搜搜索不到结果?五种实用解决方法帮你搞定 在小说搜搜里搜不到想看的书?这事儿其实挺常见。问题多半出在书源上——要么是默认的书源还没来得及收录,要么是原先的源数据失效了,更新没跟上。别急,下面这五条解决路径,基本能覆盖绝大多数情况,操作起来也不复杂。 一、通过阅读页调出换源入口手动切换 这个方法

    蓝海搜书搜书攻略及入口指南免费分享
    蓝海搜书搜书攻略及入口指南免费分享

    蓝海搜书提供超三百万部小说资源,覆盖十余类题材;具备毫秒级搜索响应、四套主题引擎、跨端加密同步及全文索引等核心功能,入口为lanhaizw.com。 关于蓝海搜书的免费资源入口和核心功能,一直是许多读者关注的焦点。今天,我们就来深入拆解一下这个平台,看看它在资源、体验和功能上究竟有哪些门道。 官方入

    Java中JSONassert,JsonUnit和Jackson三方比对
    Java中JSONassert,JsonUnit和Jackson三方比对

    断言工具专为测试场景设计,支持宽松模式并精准定位差异;单元工具基于断言工具和杰克逊库封装,提供更友好的断言接口;杰克逊库作为主流处理库,可通过节点树模型自定义比对逻辑,适用于业务开发中精细控制差异的场景。

    百度编辑器从Json对象中取值,完成初次渲染,在编辑器内画表格
    百度编辑器从Json对象中取值,完成初次渲染,在编辑器内画表格

    通过AJAX异步请求服务器获取JSON格式的表格数据,解析JSON对象后遍历数据条目,动态拼接成包含表格标签的HTML字符串,最后调用编辑器实例的setContent()方法将HTML写入编辑器,完成表格在编辑器内的初次渲染。

    1024编程
    1024编程

    面向8-18岁青少年,采用计算机硕士以上师资,以Scratch、Python、C++、CSP-J/S和NOIP五个阶段系统化循序渐进推进,避免冗余理论,注重实战,紧密对标竞赛与升学需求,形成高效衔接、直通信息学奥赛的课程体系,着力培养计算思维,助力学生冲刺升学。

    能编程与会编程
    能编程与会编程

    能编程与会编程的区别在于前者仅是技术实现,后者包含情绪管理、坚持探索、主动负责、追求完善及知识体系构建等综合能力。编程之外的能力决定了解决问题的深度与广度。

    c++如何解析GeoJSON中的FeatureCollection地理要素集【实战】
    c++如何解析GeoJSON中的FeatureCollection地理要素集【实战】

    使用nlohmann/json库解析GeoJSONFeatureCollection,需逐层防御性访问features、geometry和properties,坐标数组维度不确定,需判断。坐标系和精度问题在解析层无法解决,应暴露原始坐标数组供上层处理。性能敏感时避免重复解析和深拷贝,可缓存并视口裁剪。

    Pandas如何解析JSON数据为表_利用json_normalize函数扁平化数据
    Pandas如何解析JSON数据为表_利用json_normalize函数扁平化数据

    pandas.json_normalize 这个函数,说起来挺有意思的——很多人以为它能一键把嵌套 JSON 拍扁成表格,结果往往发现列名变成了一串带点的“火车”(比如 profile.address.city),真正棘手的问题却一个都没解决。字段缺失怎么办?列表嵌套怎么炸开?多层结构怎么拆?答案其

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。