Golang 的 “omitempty” 关键字详解

​json和struct转换简单介绍

熟悉 Golang 的朋友对于 json 和 struct 之间的转换一定不陌生，为了将代码中的结构体与 json 数据解耦，通常我们会在结构体的 field 类型后加上解释说明,注意:「结构体的属性首字母必须大写，否则json解析会不生效」。

type Person struct {
 Name string `json:"json_key_name"`
 Age  int    `json:"json_key_age"`
}

func main() {

 Per := Person{
  Name: "小饭",
  Age:  18,
 }
 
 res, _ := json.Marshal(Per)
 fmt.Println(string(res))
 return
}  
//输出结果
{"json_key_name":"小饭","json_key_age":18}

结构体只初始化部分变量​

接下来我们看另外一种情况：

p := Person{
  Name: "小饭",
 }
 res, _ := json.Marshal(p)
 fmt.Println(string(res))

如果我们在结构体初始化的时候只初始化了其中一个字段Name，那么理论上来说返回的json应该是。

{"Name":"小饭"}

但是我们实际运行一下返回的结果却是。

{"Name":"小饭","Age":0}

这明显是不符合我们的预期的，因为Age字段是我们不需要的。

如何解决​

接下来就轮到咱们今天的主角登场了，解决方式很简单，在后面加上「omitempty」即可。

type Person struct {
 Name string
 Age  int `json:",omitempty"`
}
func main() {
 p := Person{
  Name: "小饭",
 }
 res, _ := json.Marshal(p)
 fmt.Println(string(res))
}
//输出结果
{"Name":"小饭"}

结构体的特殊情况​

我们再来看下面的这个例子：

type Person struct {
 Name string
 Age  int
}

type Student struct {
 Num    int
 Person Person `json:",omitempty"`  //对结构体person使用了omitempty
}

func main() {
 Stu := Student{
  Num: 5,
 }
 res, _ := json.Marshal(Stu)
 fmt.Println(string(res))
}

我们对结构体「Person定义了omitempty」,按理说我们在初始化的时候并「没有初始化结构体的任何属性」，所以转换成json之后的打印结果应该是只有{"Num":5}的，但是我们实际运行之后发现打印的结果却是。

{"Num":5,"Person":{"Name":"","Age":0}}

为什么「omitempty对于结构体类型不生效」了呢？「这是因为结构体（上面例子的Person）不知道空值是什么，GO只知道简单结构体例如int,string,pointer 这种类型的空值」，为了不显示我们没有提供值的自定义结构体，我们可以使用「结构体指针」。

为什么用指针类型就可以解决这个问题？因为「指针是基本类型，Golang知道他的空值是啥」，所以就直接赋值为nil(指针类型的空值)。

type Person struct {
 Name string
 Age  int
}

type Student struct {
 Num    int
 Person *Person `json:",omitempty"`  //如果想要omitempty生效，必须是指针类型
}

func main() {
 Stu := Student{
  Num: 5,
 }
 res, _ := json.Marshal(Stu)
 fmt.Println(string(res))
}  
//输出结果
{"Num":5}

omitempty的一个大坑​

我们接下来还是看例子：

type Person struct {
 Age int `json:",omitempty"`
}
func main() {
 Per := Person{
  Age: 0,
 }
 res, _ := json.Marshal(Per)
 fmt.Println(string(res))
}

按照咱们的预期，应该给输出。

{"Age":0}

对不对，但是咱们实际运行以后输出的却是。

{}

这明显有问题啊，咱们需要的是输出的json字段，是必须有age，而且值是0，现在什么都没输出明显是有问题的。「因为Golang把0当成了零值，所以跟没有赋值是一样的」如果想解决这种问题一种方法是「使用int指针」，因为int指针的空值为nil,当我想输出0的时候，我传进去地址，地址肯定不是空值nil，这样肯定会显示出来0。

type Person struct {
 Age *int `json:",omitempty"`
}

func main() {
 age := 0
 Per := Person{
  Age: &age,
 }
 res, _ := json.Marshal(Per)
 fmt.Println(string(res))
}

总结​

omitempty只是在把结构体转换成json的过程中，「只会影响json转换后的结果，并不是影响结构体本身」，所以结构体的任何属性设置了omitempty之后，都不影响其正常使用。

omitempty的作用简单来说就是在「结构体转换json的过程中」，「把没有赋值的结构体属性不在json中输出而已」。

omitempty只支持「简单的数据类型」，对「结构体的数据类型是不生效」的，如果需要生效，只能用「结构体指针」。

omitempty分不清楚「0值，""值和未赋值」，「如果给某个属性赋值0或者""，并且想输出，只能用指针类型」。