当前位置:

首页 > 编程开发 > 如何在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.Marshalerjson.Unmarshaler 接口的时候才会乖乖调用对应方法。如果使用指针接收器实现但传入的是值类型,或者字段中包含未导出、不支持的类型,那方法要么不触发,要么直接报错。

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

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

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

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

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

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

标准库 time.TimeMarshalJSON 默认输出带时区和纳秒的完整 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 支持。比如字段是 funcchanmap[interface{}]interface{} 或是未导出字段(小写开头)。

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

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

本文内容来源于互联网,如有侵权请联系删除。
作者最新文章
编程开发
相关文章 更多
抖音官网入口网页
抖音官网入口网页

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

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

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

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

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

using namespace 使用中遇到的问题怎么解决
using namespace 使用中遇到的问题怎么解决

命名空间的基本概念与常见引入问题在C++等编程语言中,命名空间(namespace)是一种将代码标识符(如变量、函数、类名)封装在特定名称下的机制,其主要目的是避免命名冲突,尤其是在大型项目或使用多个第三方库时。使用“using namespace”指令可以将指定命名空间中的所有名称引入当前作用域,

c语言函数递归 实操经验总结:这些技巧很实用
c语言函数递归 实操经验总结:这些技巧很实用

理解递归的基本原理在C语言中,递归是一种函数调用自身的编程技术。要掌握它,首先需要理解其核心思想:将一个复杂的大问题,分解为一个或几个与原问题相似但规模更小的子问题,直到子问题足够简单,可以直接求解。这个过程通常包含两个关键部分:递归出口和递归体。递归出口定义了问题何时不再继续分解,即最简单、可直接

c语言函数递归 怎么选?常见方案对比分析
c语言函数递归 怎么选?常见方案对比分析

递归函数的基本概念与适用场景在C语言编程中,递归是一种函数调用自身的编程技巧。它并非适用于所有问题,但在处理某些具有自相似结构的问题时,能提供极其清晰和优雅的解决方案。递归的核心思想是将一个大规模问题分解为一个或多个同类型但规模更小的子问题,直到子问题简单到可以直接求解。典型的适用场景包括树形结构的

Objective-C 内存管理入门:从 alloc 到 dealloc 的生命周期详解
Objective-C 内存管理入门:从 alloc 到 dealloc 的生命周期详解

理解内存管理的基石在Objective-C的编程世界中,内存管理是开发者必须掌握的核心技能之一。它直接关系到应用的性能、稳定性与资源利用效率。与一些采用自动垃圾回收机制的语言不同,Objective-C在很长一段时间里,依赖一套基于引用计数的、需要开发者部分介入的管理规则。这套规则的核心思想是明确的

如何正确使用 dealloc 以避免 iOS 应用中的内存泄漏
如何正确使用 dealloc 以避免 iOS 应用中的内存泄漏

理解 dealloc 的角色与时机在 iOS 应用开发中,内存管理是保障应用性能与稳定性的基石。dealloc 方法是 Objective-C 中对象生命周期结束时的关键回调,它标志着对象即将被系统回收内存。正确理解其触发时机至关重要:当一个对象的引用计数降为零时,运行时系统会自动调用该对象的 de

深入理解 Objective-C 中的 dealloc 方法:内存管理核心机制
深入理解 Objective-C 中的 dealloc 方法:内存管理核心机制

内存管理的基石在Objective-C的世界里,内存管理是开发者必须掌握的核心技能之一。作为一门在手动引用计数(MRC)时代诞生的语言,Objective-C要求程序员对对象的生命周期有清晰的认识。dealloc方法正是这一生命周期中至关重要的终点站。它是一个实例方法,当对象的引用计数降为零时,系统

理解 native2ascii:Java 国际化开发中的字符编码工具
理解 native2ascii:Java 国际化开发中的字符编码工具

native2ascii 工具的基本定位在Ja va应用程序的国际化与本地化开发过程中,处理非拉丁字符集是一个常见且关键的环节。Ja va内部使用Unicode字符集来统一表示全球各种语言的文字,但其属性文件(.properties)在历史上要求使用ASCII编码,或者更准确地说,要求非ASCII字

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

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

Windows
Windows

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

macOS软件
macOS软件

正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

Mac软件 更多
灵活计算器
灵活计算器
macOS/iOS/Android

灵活计算器是一款笔记式算数应用,支持实时计算、动态关联和云端同步功能。记录、整理和输出之间的过渡会更自然,适合长期写作、做笔记或持续沉淀个人内容。

赤友清理大师
赤友清理大师
macOS

赤友清理大师是一款为 Mac 设计的智能清理优化工具,可精准扫描垃圾、大文件、重复文件等,释放磁盘空间。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

极度公式
极度公式
Windows/macOS/Linux

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

WINDOWS 更多
Windows 10
Windows 10
Windows

Windows 10 是一款微软推出的经典操作系统,拥有硬件兼容性与多任务处理能力。它更偏向把系统状态查看和常用调节动作放在一起,适合需要持续观察和微调设备状态的场景。

极度公式
极度公式
Windows/macOS/Linux

极度公式是一款跨平台专业LaTeX公式识别编辑软件,支持OCR公式识别和多平台编辑。和使用说明,避免使用,享受完整功能与稳定支持。做扫描整理、文字提取和表格转换时,它能把识别后的处理步骤接得更顺,资料录入这类场景会省下不少时间。

密码键盘
密码键盘
Windows/macOS/iOS/Android

密码键盘是一款兼具安全性与便捷性的高效密码管理器。日常使用里的持续防护和信息管理会更突出,适合把安全控制放进长期使用流程中的场景。