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 即可：

  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 设计原则，也提升了前后端协作的健壮性。