如何在 JSON 中隐藏结构体字段：Go 语言初学者与专家指南

Go 中的 JSON 魔法：为什么有些字段可见，而有些不可见？

您是否遇到过这样的情况：您的 Go 结构体在 JSON 响应中发送了客户端完全不需要看到的内容？例如，用户密码、内部数据库 ID 或密钥。或者相反，您需要仅在特定条件下（例如，当字段非空时）显示该字段。

这个问题是 Stack Overflow 上最热门的问题之一，这并非没有原因。在 Go 中处理 JSON 是一门在类型严谨性与表示灵活性之间取得平衡的艺术。今天，我们将探讨所有方法：从简单的 json:"-" 标签到使用接口的复杂自定义解决方案。我们开始吧！

1. 最简单的方法：json:"-" 标签

Go 允许通过特殊标签来控制结构体的序列化。如果您想永久地从 JSON 中隐藏某个字段，只需添加 json:"-" 即可。

type User struct {    Name     string `json:"name"`    Password string `json:"-"`    Age      int    `json:"age"`}

func main() {    u := User{Name: "Alice", Password: "supersecret", Age: 30}    data, _ := json.Marshal(u)    fmt.Println(string(data))    // 输出: {"name":"Alice","age":30}}

Password 字段消失了，就好像它从未存在过一样。对于绝不应离开服务器的敏感数据来说，这非常理想。

2. 条件隐藏：omitempty

有时，您只需要在字段为空时将其隐藏。为此，可以使用 omitempty 选项（"omit if empty" 的缩写）。

type Product struct {    Name        string  `json:"name"`    Description string  `json:"description,omitempty"`    Price       float64 `json:"price,omitempty"`}

func main() {    p1 := Product{Name: "Book", Price: 500.0}    data1, _ := json.Marshal(p1)    fmt.Println(string(data1)) // {"name":"Book","price":500}

    p2 := Product{Name: "Course"}    data2, _ := json.Marshal(p2)    fmt.Println(string(data2)) // {"name":"Course"}}

重要提示： omitempty 仅适用于“零值”：""、0、false、nil（对于切片、映射、指针）。

数字字段的陷阱

请小心：如果 Price 等于 0，它也会被隐藏。在某些业务逻辑中，这是不可接受的（免费商品也是一种价格）。在这种情况下，最好使用指针。

3. 使用指针 (*) 和接口

当您需要区分“未指定值”和“值为零”时，指针是您最好的朋友。

type UserProfile struct {    Name    string  `json:"name"`    Age     *int    `json:"age,omitempty"`  // 指向 int 的指针    Bio     *string `json:"bio,omitempty"`}

func main() {    // 年龄未指定 — 字段将被隐藏    u1 := UserProfile{Name: "Ivan"}    data1, _ := json.Marshal(u1)    fmt.Println(string(data1)) // {"name":"Ivan"}

    // 年龄 = 0 — 这是一个有意义的值    zero := 0    u2 := UserProfile{Name: "Maria", Age: &zero}    data2, _ := json.Marshal(u2)    fmt.Println(string(data2)) // {"name":"Maria","age":0}}

这种方法在 REST API 中经常使用，您需要仅更新传递的字段（部分更新，PATCH 请求）。

4. 自定义序列化：json.Marshaler 接口

如果标准标签不够用，您可以完全控制该过程。实现 json.Marshaler 接口并编写您自己的逻辑。

type DynamicUser struct {    ID        int    Name      string    ShowEmail bool    Email     string}

func (u DynamicUser) MarshalJSON() ([]byte, error) {    // 创建一个仅用于序列化的匿名结构体    m := map[string]interface{}{        "id":   u.ID,        "name": u.Name,    }    if u.ShowEmail {