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

风静小哥_5716

风静小哥_5716

2026-07-01

473人浏览

原创

json.marshal仅在类型直接实现json.marshaler或json.unmarshaler接口时调用对应方法;若指针接收器实现但传入值类型,或字段含未导出/不支持类型,将导致方法不调用或报错。

如何在golang中自定义json序列化行为 go语言marshaler接口与自定义接收器解析

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

因为 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 输出带时区和纳秒的完整字符串,但业务常要简化格式。不能直接改 time.Time(不可修改标准库类型),得包装一层。

推荐做法:定义新类型并实现 json.Marshaler:

Aria2 Json Rpc
Aria2 Json Rpc

通过 JSON‑RPC 2.0 与 aria2 下载管理器交互,使用自然语言命令管理下载、查询状态并控制任务。适用于 aria2、下载管理或种子操作。

下载
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")下才忽略某个字段。这时得靠自定义 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 中显式列出要序列化的字段,不依赖反射自动遍历。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

golang js json go语言

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Golang 入门学习路线:从零基础到上手开发
Golang 入门学习路线:从零基础到上手开发

Golang 入门路线涵盖从零到上手的核心路径:首先打牢基础语法与切片等底层机制;随后攻克 Go 的灵魂——接口设计与 Goroutine 并发模型;接着通过 Gin 框架与 GORM 深入 Web 开发实战;最后在微服务与云原生工具开发中进阶,旨在培养具备高性能并发处理能力的后端工程师。

2026.02.24

186

7

Golang 疑难杂症解决指南:常见问题排查与优化
Golang 疑难杂症解决指南:常见问题排查与优化

《Golang 疑难杂症解决指南》聚焦开发过程中常见却棘手的问题,从并发模型、内存管理、性能瓶颈到工程化实践逐步拆解。通过真实案例与调试思路,帮助开发者定位问题根因,建立系统化排查方法。不只给出答案,更强调分析路径与工具使用,让你在复杂 Go 项目中具备持续解决问题的能力。

2026.02.24

113

7

Golang 运行与部署实战:从本地到云端
Golang 运行与部署实战:从本地到云端

《Golang 运行与部署实战》围绕 Go 应用从开发完成到稳定上线的完整流程展开,系统讲解编译构建、环境配置、日志与配置管理、容器化部署以及常见运维问题处理。结合真实项目场景,拆解自动化构建与持续部署思路,帮助开发者建立可靠的发布流程,提升服务稳定性与可维护性。

2026.02.24

617

10

Golang 面试题精选:高频问题与解答
Golang 面试题精选:高频问题与解答

Golang 面试题精选》系统整理企业常见 Go 技术面试问题,覆盖语言基础、并发模型、内存与调度机制、网络编程、工程实践与性能优化等核心知识点。每道题不仅给出答案,还拆解背后的设计原理与考察思路,帮助读者建立完整知识结构,在面试与实际开发中都能更从容应对复杂问题。

2026.02.24

198

7

Golang 性能优化专题:提升应用效率
Golang 性能优化专题:提升应用效率

《Golang 性能优化专题》聚焦 Go 应用在高并发与大规模服务中的性能问题,从 profiling、内存分配、Goroutine 调度、GC 机制到 I/O 与锁竞争逐层分析。结合真实案例讲解定位瓶颈的方法与优化策略,帮助开发者建立系统化性能调优思维,在保证代码可维护性的同时显著提升服务吞吐与稳定性。

2026.02.24

437

7

Golang 生态工具与框架:扩展开发能力
Golang 生态工具与框架:扩展开发能力

《Golang 生态工具与框架》系统梳理 Go 语言在实际工程中的主流工具链与框架选型思路,涵盖 Web 框架、RPC 通信、依赖管理、测试工具、代码生成与项目结构设计等内容。通过真实项目场景解析不同工具的适用边界与组合方式,帮助开发者构建高效、可维护的 Go 工程体系,并提升团队协作与交付效率。

2026.02.24

168

7

Golang 并发编程专题:掌握多核时代的核心技能
Golang 并发编程专题:掌握多核时代的核心技能

《Golang 并发编程专题:掌握多核时代的核心技能》系统讲解 Go 在并发领域的设计哲学与实践方法,深入剖析 goroutine、channel、调度模型与并发安全机制,结合真实场景与性能思维,帮助开发者构建高吞吐、低延迟、可扩展的并发程序,全面提升多核时代的工程能力。

2026.02.26

524

7

Golang Web 开发路线:构建高效后端服务
Golang Web 开发路线:构建高效后端服务

《Golang Web 开发路线:构建高效后端服务》围绕 Go 在后端领域的工程实践,系统讲解 Web 框架选型、路由设计、中间件机制、数据库访问与接口规范,结合高并发与可维护性思维,逐步构建稳定、高性能、易扩展的后端服务体系,帮助开发者形成完整的 Go Web 架构能力。

2026.02.26

185

7

Golang 实际项目案例:从需求到上线
Golang 实际项目案例:从需求到上线

《Golang 实际项目案例:从需求到上线》以真实业务场景为主线,完整覆盖需求分析、架构设计、模块拆分、编码实现、性能优化与部署上线全过程,强调工程规范与实践决策,帮助开发者打通从技术实现到系统交付的关键路径,提升独立完成 Go 项目的综合能力。

2026.02.26

62

7

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程