快捷導(dǎo)航

詳解go語(yǔ)言json的使用技巧

更新時(shí)間：2021年03月30日 09:08:08 作者：王中陽(yáng)Go

這篇文章主要介紹了詳解go語(yǔ)言json的使用技巧，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

本文整理了一部分我們平時(shí)在項(xiàng)目中經(jīng)常遇到的關(guān)于go語(yǔ)言JSON數(shù)據(jù)與結(jié)構(gòu)體之間相互轉(zhuǎn)換的問(wèn)題及解決辦法。

基本的序列化

首先我們來(lái)看一下Go語(yǔ)言中json.Marshal()（系列化）與json.Unmarshal（反序列化）的基本用法。

type Person struct {
 Name  string
 Age  int64
 Weight float64
}

func main() {
 p1 := Person{
 Name:  "小明",
 Age:  18,
 Weight: 71.5,
 }
 // struct -> json string
 b, err := json.Marshal(p1)
 if err != nil {
 fmt.Printf("json.Marshal failed, err:%v\n", err)
 return
 }
 fmt.Printf("str:%s\n", b)
 // json string -> struct
 var p2 Person
 err = json.Unmarshal(b, &p2)
 if err != nil {
 fmt.Printf("json.Unmarshal failed, err:%v\n", err)
 return
 }
 fmt.Printf("p2:%#v\n", p2)
}

輸出：
str:{"Name":"小明","Age":18,"Weight":71.5}
p2:main.Person{Name:"小明", Age:18, Weight:71.5}

結(jié)構(gòu)體tag介紹

Tag是結(jié)構(gòu)體的元信息，可以在運(yùn)行的時(shí)候通過(guò)反射的機(jī)制讀取出來(lái)。 Tag在結(jié)構(gòu)體字段的后方定義，由一對(duì)反引號(hào)包裹起來(lái)，具體的格式如下：

`key1:"value1" key2:"value2"`

結(jié)構(gòu)體tag由一個(gè)或多個(gè)鍵值對(duì)組成。鍵與值使用冒號(hào)分隔，值用雙引號(hào)括起來(lái)。
同一個(gè)結(jié)構(gòu)體字段可以設(shè)置多個(gè)鍵值對(duì)tag，不同的鍵值對(duì)之間使用空格分隔。

使用json tag指定字段名

序列化與反序列化默認(rèn)情況下使用結(jié)構(gòu)體的字段名，我們可以通過(guò)給結(jié)構(gòu)體字段添加tag來(lái)指定json序列化生成的字段名。

// 使用json tag指定序列化與反序列化時(shí)的行為
type Person struct {
 Name  string `json:"name"` // 指定json序列化/反序列化時(shí)使用小寫(xiě)name
 Age  int64
 Weight float64
}

忽略某個(gè)字段

如果你想在json序列化/反序列化的時(shí)候忽略掉結(jié)構(gòu)體中的某個(gè)字段，可以按如下方式在tag中添加-。

// 使用json tag指定json序列化與反序列化時(shí)的行為
type Person struct {
 Name  string `json:"name"` // 指定json序列化/反序列化時(shí)使用小寫(xiě)name
 Age  int64
 Weight float64 `json:"-"` // 指定json序列化/反序列化時(shí)忽略此字段
}

忽略空值字段

當(dāng) struct 中的字段沒(méi)有值時(shí)， json.Marshal() 序列化的時(shí)候不會(huì)忽略這些字段，而是默認(rèn)輸出字段的類型零值（例如int和float類型零值是 0，string類型零值是""，對(duì)象類型零值是 nil）。如果想要在序列序列化時(shí)忽略這些沒(méi)有值的字段時(shí)，可以在對(duì)應(yīng)字段添加omitempty tag。

舉個(gè)例子：

type User struct {
 Name string  `json:"name"`
 Email string  `json:"email"`
 Hobby []string `json:"hobby"`
}

func omitemptyDemo() {
 u1 := User{
 Name: "小明",
 }
 // struct -> json string
 b, err := json.Marshal(u1)
 if err != nil {
 fmt.Printf("json.Marshal failed, err:%v\n", err)
 return
 }
 fmt.Printf("str:%s\n", b)
}

輸出結(jié)果：
str:{"name":"小明","email":"","hobby":null}

如果想要在最終的序列化結(jié)果中去掉空值字段，可以像下面這樣定義結(jié)構(gòu)體：

// 在tag中添加omitempty忽略空值
// 注意這里 hobby,omitempty 合起來(lái)是json tag值，中間用英文逗號(hào)分隔
type User struct {
 Name string  `json:"name"`
 Email string  `json:"email,omitempty"`
 Hobby []string `json:"hobby,omitempty"`
}

此時(shí)，再執(zhí)行上述的omitemptyDemo，輸出結(jié)果如下：

str:{"name":"小明"} // 序列化結(jié)果中沒(méi)有email和hobby字段

說(shuō)句題外話，我們使用gorm操作數(shù)據(jù)庫(kù)的話，經(jīng)常會(huì)遇到想忽略指定字段修改的問(wèn)題，比如結(jié)構(gòu)體中的關(guān)聯(lián)實(shí)體，只想json展示，form提交時(shí)忽略實(shí)體，這種問(wèn)題我會(huì)單獨(dú)整理一篇出來(lái)。

忽略嵌套結(jié)構(gòu)體空值字段

首先來(lái)看幾種結(jié)構(gòu)體嵌套的示例：

type User struct {
 Name string  `json:"name"`
 Email string  `json:"email,omitempty"`
 Hobby []string `json:"hobby,omitempty"`
 Profile
}

type Profile struct {
 Website string `json:"site"`
 Slogan string `json:"slogan"`
}

func nestedStructDemo() {
 u1 := User{
 Name: "小明",
 Hobby: []string{"足球", "籃球"},
 }
 b, err := json.Marshal(u1)
 if err != nil {
 fmt.Printf("json.Marshal failed, err:%v\n", err)
 return
 }
 fmt.Printf("str:%s\n", b)
}

匿名嵌套Profile時(shí)序列化后的json串為單層的：

str:{"name":"小明","hobby":["足球","藍(lán)球"],"site":"","slogan":""}

想要變成嵌套的json串，需要改為具名嵌套或定義字段tag：

type User struct {
 Name  string  `json:"name"`
 Email  string  `json:"email,omitempty"`
 Hobby  []string `json:"hobby,omitempty"`
 Profile `json:"profile"`
}
// str:{"name":"小明","hobby":["足球","籃球"],"profile":{"site":"","slogan":""}}

想要在嵌套的結(jié)構(gòu)體為空值時(shí)，忽略該字段，僅添加omitempty是不夠的：

type User struct {
 Name   string  `json:"name"`
 Email  string  `json:"email,omitempty"`
 Hobby  []string `json:"hobby,omitempty"`
 Profile `json:"profile,omitempty"`
}
// str:{"name":"小明","hobby":["足球","籃球"],"profile":{"site":"","slogan":""}}

還需要使用嵌套的結(jié)構(gòu)體指針：

type User struct {
 Name   string  `json:"name"`
 Email  string  `json:"email,omitempty"`
 Hobby  []string `json:"hobby,omitempty"`
 *Profile `json:"profile,omitempty"` //這里是重點(diǎn)
}
// str:{"name":"小明","hobby":["足球","籃球"]}

不修改原結(jié)構(gòu)體忽略空值字段

我們需要json序列化User，但是不想把密碼也序列化，又不想修改User結(jié)構(gòu)體，這個(gè)時(shí)候我們就可以使用創(chuàng)建另外一個(gè)結(jié)構(gòu)體PublicUser匿名嵌套原User，同時(shí)指定Password字段為匿名結(jié)構(gòu)體指針類型，并添加omitemptytag，示例代碼如下：

type User struct {
 Name   string `json:"name"`
 Password string `json:"password"`
}

type PublicUser struct {
 *User       // 匿名嵌套
 Password *struct{} `json:"password,omitempty"`
}

func omitPasswordDemo() {
 u1 := User{
 Name:   "小明",
 Password: "123456",
 }
 b, err := json.Marshal(PublicUser{User: &u1})
 if err != nil {
 fmt.Printf("json.Marshal u1 failed, err:%v\n", err)
 return
 }
 fmt.Printf("str:%s\n", b) // str:{"name":"小明"}
}

優(yōu)雅處理字符串格式的數(shù)字

有時(shí)候，前端在傳遞來(lái)的json數(shù)據(jù)中可能會(huì)使用字符串類型的數(shù)字，這個(gè)時(shí)候可以在結(jié)構(gòu)體tag中添加string來(lái)告訴json包從字符串中解析相應(yīng)字段的數(shù)據(jù)：

type Card struct {
 ID  int64  `json:"id,string"`  // 添加string tag
 Score float64 `json:"score,string"` // 添加string tag
}

func intAndStringDemo() {
 jsonStr1 := `{"id": "1234567","score": "88.50"}`
 var c1 Card
 if err := json.Unmarshal([]byte(jsonStr1), &c1); err != nil {
 fmt.Printf("json.Unmarsha jsonStr1 failed, err:%v\n", err)
 return
 }
 fmt.Printf("c1:%#v\n", c1) // c1:main.Card{ID:1234567, Score:88.5}
}