脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 脚本专栏 → Golang → Go语言omitempty选项

Go语言omitempty选项的实现

 更新时间：2023年06月08日 09:13:35   作者：黎明⁢  
本文主要介绍了Go语言omitempty选项的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧

在使用Golang的时候，不免会使用Json和结构体的相互转换，这时候常用的就是 json.Marshal 和 json.Unmarshal 两个函数。这时候在定义json结构体的时候，我们会用到 omitempty 这个字段，这个字段作用就是 空值省略，看似简单，但是却有很多小坑，这篇文章带你稍微研究一下他的用途和功能。

omit：

v. 删除; 忽略; 漏掉; 遗漏; 不做; 未能做;

adj. 省略了的；省去的;

基本用法

当我们设置json的struct的时候，会定义每个字段对一个json的格式，比如定义一个dog 结构体：

type Dog struct {
    Name   string
    Weight int
}

现在我们对他进行初始化，将其编码为JSON格式：

func main() {
    d := Dog{
        Name:   "小黑",
        Weight: 20,
    }
    marshalDog, err := json.Marshal(d)
    if err != nil {
        fmt.Println(err.Error())
    }
    fmt.Println(string(marshalDog))
}

则输出的结果为：

{"Name":"小黑","Weight":20} 

现在假如有一个结构体变量我们没初始化，那么结果可能也会跟我们预期的不太一样：

d := Dog{
        Name: "小黑",
    }

输出的结果为：

{"Name":"小黑","Weight":0}

很明显，狗的weight是未知，而不是0,并不是我们想要的结果，我们更想要的结果是：

{"Name":"小黑"}

为了实现这样的目的，我们这时候应该使用 omitempty 选项来帮我们实现，当我们在Dog结构体加上这个tag的时候：

type Dog struct {
    Name   string
    Weight int `json:",omitempty"`
}

此时，输出结果为：

{"Name":"小黑"}

不能单纯使用omitempty

当结构体相互嵌套的时候，那么omitempty就可能出现问题，比如：

type Variety struct {
    Color    string
    Category string
}
type Dog struct {
    Name    string
    Weight  int     `json:",omitempty"`
    Variety Variety `json:",omitempty"`
}
func main() {
    d := Dog{
        Name: "小黑",
    }
    marshalDog, err := json.Marshal(d)
    if err != nil {
        fmt.Println(err.Error())
    }
    fmt.Println(string(marshalDog))
}

输出结果为：

{"Name":"小黑","Variety":{"Color":"","Category":""}}

omitempty 为什么对嵌套结构体不生效呢？这是因为GO只知道简单结构体例如int,string,pointer 这种类型的空值，不知道Variety类型的空值是什么，为了不显示我们没有提供值的自定义结构体，我们可以使用结构体指针：

type Dog struct {
    Name    string
    Weight  int      `json:",omitempty"`
    Variety *Variety `json:",omitempty"`
}

运行结果为：

{"Name":"小黑"}

但是如果给出下面情况的赋值：

d := Dog{
        Name:    "小黑",
        Variety: &Variety{Color: "black"},
    }

运行结果为：

{"Name":"小黑","Variety":{"Color":"black","Category":""}}

可以看到，omitempty只对*Variety生效。所以想要嵌套结构体里面的字段也能有空值省略的效果，就要在定义嵌套的结构体的时候，对里面的每个字段都要加上omitempty选项。如下所示：

type Variety struct {
    Color    string `json:",omitempty"`
    Category string `json:",omitempty"`
}

运行结果如下：

{"Name":"小黑","Variety":{"Color":"black"}}

剩下的最后一个坑就是：如果想要某个值就是为空（有实际意义），也就是说当一个空值有实际意义的时候就显示，没有实际意义（当时还不知道其值）的时候就不显示，这样的需求应该怎么做？如果还是向上面那样，当我们需要Category为空的时候（Category:“”），最后会发现omitempty选项会把这个空值字段省略。正确的做法是使用指针来定义其变量。最后代码如下：

package main
import (
    "encoding/json"
    "fmt"
)
type Variety struct {
    Color    *string `json:",omitempty"`
    Category *string `json:",omitempty"`//一定要是*string类型
}
type Dog struct {
    Name    string
    Weight  int      `json:",omitempty"`
    Variety *Variety `json:",omitempty"`
}
func main() {
    color := "black"
    //此处的空值有实际意义
    category := ""
    d := Dog{
        Name:    "小黑",
        Variety: &Variety{Color: &color, Category: &category},
    }
    marshalDog, err := json.Marshal(d)
    if err != nil {
        fmt.Println(err.Error())
    }
    fmt.Println(string(marshalDog))
}

运行结果如下：

{"Name":"小黑","Variety":{"Color":"black","Category":""}}

到此这篇关于Go语言omitempty选项的实现的文章就介绍到这了,更多相关Go语言omitempty选项内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • Go语言开发必知的一个内存模型细节

    Go语言开发必知的一个内存模型细节

    这篇文章主要为大家介绍了Go语言开发必知的一个内存模型细节详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2022-07-07
  • Go 泛型切片函数的内存陷阱

    Go 泛型切片函数的内存陷阱

    本文主要介绍了Go 泛型切片函数的内存陷阱,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2026-04-04
  • GoLang OS包以及File类型详细讲解

    GoLang OS包以及File类型详细讲解

    go中对文件和目录的操作主要集中在os包中，下面对go中用到的对文件和目录的操作，做一个总结笔记。在go中的文件和目录涉及到两种类型，一个是type File struct，另一个是type Fileinfo interface
    2023-03-03
  • Go并发:使用sync.WaitGroup实现协程同步方式

    Go并发:使用sync.WaitGroup实现协程同步方式

    这篇文章主要介绍了Go并发:使用sync.WaitGroup实现协程同步方式，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2021-05-05
  • Go语言使用net/http构建一个RESTful API的示例代码

    Go语言使用net/http构建一个RESTful API的示例代码

    Go的标准库net/http提供了构建Web服务所需的强大功能,虽然众多第三方框架（如 Gin、Echo）已经封装了很多功能,但如果你真正想理解 Go的底层Web服务机制,那么使用net/http实现一个原生的RESTful API 是最好的入门方式,需要的朋友可以参考下本文
    2025-08-08
  • node-exporter被检测出来pprof调试信息泄露漏洞问题

    node-exporter被检测出来pprof调试信息泄露漏洞问题

    这篇文章主要介绍了node-exporter被检测出来pprof调试信息泄露漏洞问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-04-04
  • Go语言Telnet回音服务器的实现

    Go语言Telnet回音服务器的实现

    这篇文章主要介绍了Go语言Telnet回音服务器的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-01-01
  • 使用Go语言编写一个毫秒级生成组件库文档工具

    使用Go语言编写一个毫秒级生成组件库文档工具

    在开发组件库的过程中,文档无疑是不可或缺的一环,在本文中将尝试将Go语言与前端技术巧妙融合,以创建一款能在毫秒级别完成文档生成的工具,需要的可以参考下
    2024-03-03
  • Golang: 内建容器的用法

    Golang: 内建容器的用法

    这篇文章主要介绍了Golang: 内建容器的用法，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2021-05-05
  • GoLang中的timer定时器实现原理分析

    GoLang中的timer定时器实现原理分析

    Timer中对外暴露的只有一个channel,这个 channel也是定时器的核心。当计时结束时，Timer会发送值到channel中，外部环境在这个 channel 收到值的时候，就代表计时器超时了，可与select搭配执行一些超时逻辑
    2023-02-02

最新评论