go語言json的使用技巧

導讀	本文整理了一部分我們平時在專案中經常遇到的關於go語言JSON資料與結構體之間相互轉換的問題及解決辦法。

首先我們來看一下Go語言中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}

Tag是結構體的元資訊，可以在執行的時候透過反射的機制讀取出來。 Tag在結構體欄位的後方定義，由一對反引號包裹起來，具體的格式如下：

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

結構體tag由一個或多個鍵值對組成。鍵與值使用冒號分隔，值用雙引號括起來。
同一個結構體欄位可以設定多個鍵值對tag，不同的鍵值對之間使用空格分隔。

序列化與反序列化預設情況下使用結構體的欄位名，我們可以透過給結構體欄位新增tag來指定json序列化生成的欄位名。

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

如果你想在json序列化/反序列化的時候忽略掉結構體中的某個欄位，可以按如下方式在tag中新增-。

// 使用json tag指定json序列化與反序列化時的行為
type Person struct {
 Name  string `json:"name"` // 指定json序列化/反序列化時使用小寫name
 Age  int64
 Weight float64 `json:"-"` // 指定json序列化/反序列化時忽略此欄位
}

當 struct 中的欄位沒有值時， json.Marshal() 序列化的時候不會忽略這些欄位，而是預設輸出欄位的型別零值（例如int和float型別零值是 0，string型別零值是""，物件型別零值是 nil）。如果想要在序列序列化時忽略這些沒有值的欄位時，可以在對應欄位新增omitempty tag。
舉個例子：

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)
}

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

如果想要在最終的序列化結果中去掉空值欄位，可以像下面這樣定義結構體：

// 在tag中新增omitempty忽略空值
// 注意這裡 hobby,omitempty 合起來是json tag值，中間用英文逗號分隔
type User struct {
 Name string  `json:"name"`
 Email string  `json:"email,omitempty"`
 Hobby []string `json:"hobby,omitempty"`
}

此時，再執行上述的omitemptyDemo，輸出結果如下：
str:{"name":"小明"} // 序列化結果中沒有email和hobby欄位

說句題外話，我們使用gorm運算元據庫的話，經常會遇到想忽略指定欄位修改的問題，比如結構體中的關聯實體，只想json展示，form提交時忽略實體，這種問題我會單獨整理一篇出來。

首先來看幾種結構體巢狀的示例：

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時序列化後的json串為單層的：
str:{"name":"小明","hobby":["足球","藍球"],"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":""}}

想要在巢狀的結構體為空值時，忽略該欄位，僅新增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":""}}

還需要使用巢狀的結構體指標：

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

我們需要json序列化User，但是不想把密碼也序列化，又不想修改User結構體，這個時候我們就可以使用建立另外一個結構體PublicUser匿名巢狀原User，同時指定Password欄位為匿名結構體指標型別，並新增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":"小明"}
}

有時候，前端在傳遞來的json資料中可能會使用字串型別的數字，這個時候可以在結構體tag中新增string來告訴json包從字串中解析相應欄位的資料：

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}
}