omitempty只是在把結構體轉換成json的過程中,「只會影響json轉換后的結果,并不是影響結構體本身」,所以結構體的任何屬性設置了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應該是。
但是我們實際運行一下返回的結果卻是。
這明顯是不符合我們的預期的,因為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))
}
按照咱們的預期,應該給輸出。
對不對,但是咱們實際運行以后輸出的卻是。
這明顯有問題啊,咱們需要的是輸出的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或者"",并且想輸出,只能用指針類型」。