Golang中omitempty关键字的具体实现

用法

熟悉 golang 的朋友对于 json 和 struct 之间的转换一定不陌生，为了将代码中的结构体与 json 数据解耦，通常我们会在结构体的 field 类型后加上解释说明，例如在表示一个地址的时候， json 数据如下所示

{
    "street": "200 larkin st",
    "city": "san francisco",
    "state": "ca",
    "zipcode": "94102"
}

与之相对应的 golang 结构体表示可能是这个样子的

type address struct {
    street  string `json:"street"`  // 街道
    ste     string `json:"suite"`   // 单元（可以不存在）
    city    string `json:"city"`    // 城市
    state   string `json:"state"`   // 州/省
    zipcode string `json:"zipcode"` // 邮编
}

这样无论代码中的变量如何改变，我们都能成功将 json 数据解析出来，获得正确的街道，城市等信息，到目前为止一切正常。但如果我们想要将地址结构体恢复成 json 格式时，问题就来了。比方说我们用下面这段代码读取了地址 json ，然后根据业务逻辑处理了之后恢复成正常的 json 打印出来

func main() {
        data := `{
        "street": "200 larkin st",
        "city": "san francisco",
        "state": "ca",
        "zipcode": "94102"
    }`
    addr := new(address)
    json.unmarshal([]byte(data), &addr)

        // 处理了一番 addr 变量...

    addressbytes, _ := json.marshalindent(addr, "", "    ")
    fmt.printf("%s\n", string(addressbytes))
}

这段代码的输出是

{
    "street": "200 larkin st",
    "suite": "",
    "city": "san francisco",
    "state": "ca",
    "zipcode": "94102"
}

多了一行 "suite": "", ，而这则信息在原本的 json 数据中是没有的（在美国的地址中，如果不是群租公寓或者共享办公楼， suite 这一条不存在很正常，人们直接用街道门牌号来表示地址就足够了），但我们更希望的是，在一个地址有 suite 号码的时候输出，不存在 suite 的时候就不输出，幸运的是，我们可以在 golang 的结构体定义中添加 omitempty 关键字，来表示这条信息如果没有提供，在序列化成 json 的时候就不要包含其默认值。稍作修改，地址结构体就变成了

type address struct {
    street  string `json:"street"`
    ste     string `json:"suite,omitempty"`
    city    string `json:"city"`
    state   string `json:"state"`
    zipcode string `json:"zipcode"`
}

重新运行，即可得到正确的结果。

陷阱

带来方便的同时，使用 omitempty 也有些小陷阱，一个是该关键字无法忽略掉嵌套结构体。还是拿地址类型说事，这回我们想要往地址结构体中加一个新 field 来表示经纬度，如果没有缺乏相关的数据，暂时可以忽略。新的 struct 定义如下所示

type address struct {
    street     string     `json:"street"`
    ste        string     `json:"suite,omitempty"`
    city       string     `json:"city"`
    state      string     `json:"state"`
    zipcode    string     `json:"zipcode"`
    coordinate coordinate `json:"coordinate,omitempty"`
}

type coordinate struct {
    lat float64 `json:"latitude"`
    lng float64 `json:"longitude"`
}

读入原来的地址数据，处理后序列化输出，我们就会发现即使加上了 omitempty 关键字，输出的 json 还是带上了一个空的坐标信息

{
    "street": "200 larkin st",
    "city": "san francisco",
    "state": "ca",
    "zipcode": "94102",
    "coordinate": {
        "latitude": 0,
        "longitude": 0
    }
}

为了达到我们想要的效果，可以把坐标定义为指针类型，这样 golang 就能知道一个指针的“空值”是多少了，否则面对一个我们自定义的结构， golang 是猜不出我们想要的空值的。于是有了如下的结构体定义

type address struct {
    street     string      `json:"street"`
    ste        string      `json:"suite,omitempty"`
    city       string      `json:"city"`
    state      string      `json:"state"`
    zipcode    string      `json:"zipcode"`
    coordinate *coordinate `json:"coordinate,omitempty"`
}

type coordinate struct {
    lat float64 `json:"latitude"`
    lng float64 `json:"longitude"`
}

相应的输出为

{
    "street": "200 larkin st",
    "city": "san francisco",
    "state": "ca",
    "zipcode": "94102"
}

另一个“陷阱”是，对于用 omitempty 定义的 field ，如果给它赋的值恰好等于默认空值的话，在转为 json 之后也不会输出这个 field 。比如说上面定义的经纬度坐标结构体，如果我们将经纬度两个 field 都加上 omitempty

type coordinate struct {
    lat float64 `json:"latitude,omitempty"`
    lng float64 `json:"longitude,omitempty"`
}

然后我们对非洲几内亚湾的“原点坐标”非常感兴趣，于是编写了如下代码

func main() {
    cdata := `{
        "latitude": 0.0,
        "longitude": 0.0
    }`
    c := new(coordinate)
    json.unmarshal([]byte(cdata), &c)

        // 具体处理逻辑...

    coordinatebytes, _ := json.marshalindent(c, "", "    ")
    fmt.printf("%s\n", string(coordinatebytes))
}

最终我们得到了一个

{}

这个坐标消失不见了！但我们的设想是，如果一个地点没有经纬度信息，则悬空，这没有问题，但对于“原点坐标”，我们在确切知道它的经纬度的情况下，（0.0, 0.0）仍然被忽略了。正确的写法也是将结构体内的定义改为指针

type coordinate struct {
    lat *float64 `json:"latitude,omitempty"`
    lng *float64 `json:"longitude,omitempty"`
}

这样空值就从 float64 的 0.0 变为了指针类型的 nil ，我们就能看到正确的经纬度输出。

{
    "latitude": 0,
    "longitude": 0
}

p.s. 本文中拿来作示例的地址是旧金山亚洲艺术博物馆的地址，藏品丰富，上到夏商周，下至明清的文物都能看到，几年前第一次去参观，很是喜欢，印象深刻。

到此这篇关于golang中omitempty关键字的具体实现的文章就介绍到这了,更多相关golang omitempty 内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！