深入理解jsonomitempty

一、jsonomitempty简介

Jsonomitempty是指可以在构建json数据时，自动判断是否将该字段加入json字符串中的标志,如果该字段的值为空或者该字段为零值，则在编码成json时不会输出该字段。(json中没有显式表示为null或者””)。

以下为一个简单的示例：

type Person struct {
    Name   string `json:"name,omitempty"`
    Age    int    `json:"age,omitempty"`
    Gender string `json:"gender,omitempty"`
}

func main() {
    person := Person{
        Name:   "Lily",
        Gender: "female",
    }

    data, err := json.Marshal(person)
    if err != nil {
        fmt.Println("json.Marshal error:", err)
    }

    fmt.Println(string(data))
}

输出结果为：

{"name":"Lily","gender":"female"}

可以看到，由于Age字段为空值，所以在编码为json字符串时并未加入该字段。

二、jsonomitempty的使用场景

Jsonomitempty非常适用于那些需要在向前端传递数据时，尽量减小json数据大小的情况。比如在微服务中，不少服务需要向前端提供json数据作为返回。在数据中有大量数据为空值的情况下，使用jsonomitempty可以将返回结果中不必要的数据剔除，降低数据传输的负担。

举个栗子：

type UserInfo struct {
    UserName string `json:"user_name"`
    UserId   int64  `json:"user_id"`
    Email    string `json:"email,omitempty"`
    Phone    string `json:"phone,omitempty"`
    Avatar   string `json:"avatar,omitempty"`
    Gender   string `json:"gender,omitempty"`
}

func GetUserInfo(userId int64) UserInfo {
    userInfo := UserInfo{
        UserName: "jack",
        UserId:   userId,
    }
    //... 查询数据库...
    return userInfo
}

以上代码演示了一个获取用户信息的函数，这个函数从数据库中查询用户信息，并将其组装成UserInfo对象返回。在返回结果中，由于邮箱、电话、头像和性别可能为空值，所以我们使用jsonomitempty标记，将这些字段从json字符串中剔除，如下所示。

假设该用户userId为1，接口返回结果如下：

{"user_name":"jack","user_id":1}

可以看到，由于邮箱、电话、头像及性别都为空值，因此在编码成json字符串时并未加入这些字段。

三、jsonomitempty的限制

尽管jsonomitempty看起来非常有用，但它并不是万能的。在使用jsonomitempty时，需要注意以下几点限制。

1、”omitempty”字段可能会带来歧义

在Go中，有些零值不等于空值。如果您的字段具有零值，并且您使用omitempty标记，则在组合json对象时，该字段将被视为空。因此，在使用jsonomitempty时，必须协调解决方案，以使一致性得到维护。

以Time类型为例，在默认情况下，它被视为 “非空” 。因此，使用omitempty标记，将清空Time类型的零值。

type StructA struct {
    Time time.Time `json:"time,omitempty"`
}

sa := StructA{Time: time.Time{}}

执行结果：

{}

2、Tag中不得使用”omitempty”字段进行json解码

您在集合json字符串时使用omitempty。您可以忽略其中某些不是必须的值，但在反序列化JSON时却无法使用此字段。在从json字符串构造结构体时，字段的零值应保留并由程序员手动验证是否为零值。例如：

type StructB struct {
    Time time.Time `json:"time,omitempty"`
}

sbJsonStr := `{"time":"2014-11-12T11:45:30.918Z"}`

sbParsed := StructB{}

err := json.Unmarshal([]byte(sbJsonStr), &sbParsed)
if err != nil {
    fmt.Println(err)
}

fmt.Println(sbParsed)

执行结果：

{}

在json.Unmarshal中使用`omitempty`字段标记，无法正常反序列化json字符串。

3、omitempty会自动忽略零值

如果您希望保留结构的默认值，而不管它是否为空，哪怕是零值您也不要使用omitempty。

type StructC struct {
    Num int `json:"num,omitempty"`
}

sc := StructC{}

jb, _ := json.Marshal(sc)

fmt.Println(string(jb)) // 输出 {}

如果删除”omitempty”标记，则输出为{“num”:0}。

四、总结

在我们的日常开发中，json字符串的交换、以及对不同源代码的调用，已经成为编写更好软件的不可缺少的一部分。这种数据交换可能涉及到客户端之间的交互，或者是从API向外提供服务。对于此类情况使用jsonomitempty是非常必要的。

通过本文的介绍，相信大家对jsonomitempty有了更深入的理解，并且在日常编码中也更加熟练掌握它的使用。不管是在Go语言还是其他的编程语言中，jsonomitempty都是一种很实用的编码和解码技巧，值得我们掌握。

原创文章，作者：小蓝，如若转载，请注明出处：https://www.506064.com/n/286881.html