如何在 Go 中按需序列化 JSON 请求体中的可选字段

冬婷同学_8897

冬婷同学_8897

2026-04-17

893人浏览

原创

如何在 Go 中按需序列化 JSON 请求体中的可选字段

本文介绍如何使用 Go 的 json 标签(特别是 omitempty)配合指针类型,实现 HTTP 请求体中仅包含实际提供的字段,避免发送零值(如空字符串、0、nil)字段,提升 API 兼容性与请求简洁性。

本文介绍如何使用 go 的 `json` 标签(特别是 `omitempty`)配合指针类型,实现 http 请求体中仅包含实际提供的字段,避免发送零值(如空字符串、0、nil)字段,提升 api 兼容性与请求简洁性。

在构建 RESTful API 客户端或处理部分更新(PATCH)请求时,经常需要只提交用户显式修改的字段,而非将整个结构体所有字段(含零值)一并序列化为 JSON 发送。例如,原始结构体:

type MyStruct struct {
    Name  string `json:"name"`
    Age   int    `json:"age"`
    Email string `json:"email"`
}

即使 Email 为空、Age 未修改,json.Marshal() 仍会输出:

{
  "name": "Kevin",
  "age": 0,
  "email": ""
}

这不仅冗余,还可能被服务端误判为“显式清空”,导致非预期的数据覆盖。

✅ 正确做法是结合 omitempty 标签与合适的数据类型:

  • 对字符串、切片、映射等零值有明确“空”语义的类型,直接添加 ,omitempty 即可:

    arcgis-js
    arcgis-js

    提供 ArcGIS Maps SDK for JavaScript 开发辅助,涵盖 2D/3D 地图视图、图层管理、数据可视化、空间分析等功能模块的参考和示例指导。

    下载
    type MyStruct struct {
        Name  string `json:"name,omitempty"`
        Age   *int   `json:"age,omitempty"` // 注意:int 本身不能用 omitempty(0 是合法值),改用 *int
        Email string `json:"email,omitempty"`
    }
  • 对数值类型(如 int, bool, float64),其零值(0, false, 0.0)无法与“未提供”区分,因此必须使用指针类型(如 *int)。此时 nil 表示“未设置”,而 omitempty 会跳过 nil 指针字段。

完整示例:

package main

import (
    "encoding/json"
    "fmt"
)

type MyStruct struct {
    Name  string `json:"name,omitempty"`
    Age   *int   `json:"age,omitempty"`
    Email string `json:"email,omitempty"`
}

func main() {
    age := 25
    data := MyStruct{
        Name: "Kevin",
        Age:  &age,
        // Email 留空(空字符串),将被 omitempty 忽略
    }

    body, _ := json.Marshal(data)
    fmt.Println(string(body))
    // 输出:{"name":"Kevin","age":25}
}

⚠️ 注意事项:

  • omitempty 仅对零值生效:""(空字符串)、0(数字)、nil(切片/映射/指针/接口)等;
  • int、bool 等基础类型无法安全使用 omitempty,务必改用 *int、*bool;
  • 若服务端要求 age 字段存在但允许为 null,可额外添加 string 标签(如 json:"age,omitempty,string"),但需服务端支持;
  • 在 HTTP 客户端中,建议将该结构体专用于请求体(DTO),避免与领域模型混用,确保语义清晰。

通过合理组合 omitempty 与指针类型,你就能生成真正“按需”的轻量 JSON 请求体,既符合 REST 设计原则,也提升了前后端协作的健壮性。

相关文章

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

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

下载

相关标签:

js json

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

相关专题

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

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

2026.02.24

226

7

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

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

2026.02.24

133

7

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

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

2026.02.24

677

10

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

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

2026.02.24

238

7

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

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

2026.02.24

497

7

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

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

2026.02.24

208

7

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

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

2026.02.26

584

7

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

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

2026.02.26

245

7

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

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

2026.02.26

62

7

热门下载

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

精品课程

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

共101课时 | 21.2万人学习

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

共39课时 | 4.9万人学习