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中，哈希就是常见的数据类型map，本文就来聊聊Golang中map的相关知识吧2023-04-04
这篇文章主要介绍了go语言实现AES加密的方法,实例分析了Go语言的加密技巧,需要的朋友可以参考下2015-03-03
这篇文章主要为大家介绍了Hugo 游乐场内容初始化示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2023-02-02
这篇文章主要介绍了golang语言中for循环语句用法,实例分析了for循环遍历的使用技巧,具有一定参考借鉴价值,需要的朋友可以参考下2015-01-01
本文将介绍如何使用Go语言封装二级认证功能,实现简单高效的用户认证流程,二级认证是一种安全措施,要求用户在登录后进行额外的身份验证,以提高账户安全性,2023-10-10
在 Go 里有专门为同步通信而生的 channel,所以较少看到 sync.Cond 的使用,不过它也是并发控制手段里的一种,今天我们就来认识下它的相关实现,加深对同步机制的运用2023-09-09
这篇文章主要介绍了如何利用go-zero在Go中快速实现JWT认证，本文分步骤通过实例图文相结合给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友参考下吧2020-10-10
分页是我们日常开发中经常会遇到的一个需求,下面这篇文章主要给大家介绍了关于如何通过go自定义一个分页插件的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考下2024-03-03
堆，作为一种基本的数据结构，以其在优先队列和排序算法中提供高效解决方案的能力而闻名。在本文中，我们将深入探讨堆的内部工作原理，包括其特性、实现细节以及在现代编程中的应用2008-06-06
这篇文章主要介绍了Go语言应用闭包之返回函数,对于非常底层的纯 Go 语言代码或者包而言，在各个操作系统平台上的可移植性是非常强的，只需要将源码拷贝到相应平台上进行编译即可，或者可以使用交叉编译来构建目标平台的应用程序,需要的朋友可以参考下2023-07-07
最新评论