go语言json的使用技巧

294次阅读

共计 4159 个字符，预计需要花费 11 分钟才能阅读完成。

导读	本文整理了一部分我们平时在项目中经常遇到的关于 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 是结构体的元信息，可以在运行的时候通过反射的机制读取出来。Tag 在结构体字段的后方定义，由一对反引号包裹起来，具体的格式如下：

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

结构体 tag 由一个或多个键值对组成。键与值使用冒号分隔，值用双引号括起来。
同一个结构体字段可以设置多个键值对 tag，不同的键值对之间使用空格分隔。

使用 json 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}
}