Go -- 在Go语言中使用JSON struct

Posted ⬆️小马哥⬆️

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Go -- 在Go语言中使用JSON struct相关的知识,希望对你有一定的参考价值。

Encode

将一个对象编码成JSON数据,接受一个interface{}对象,返回[]byte和error:

func Marshal(v interface{}) ([]byte, error)

Marshal函数将会递归遍历整个对象,依次按成员类型对这个对象进行编码,类型转换规则如下:

bool类型 转换为JSON的Boolean
整数,浮点数等数值类型 转换为JSON的Number
string 转换为JSON的字符串(带""引号)
struct 转换为JSON的Object,再根据各个成员的类型递归打包
数组或切片 转换为JSON的Array
[]byte 会先进行base64编码然后转换为JSON字符串
map 转换为JSON的Object,key必须是string
interface{} 按照内部的实际类型进行转换
nil 转为JSON的null
channel,func等类型 会返回UnsupportedTypeError

 

  1. type ColorGroup struct {  
  2.     ID     int  
  3.     Name   string  
  4.     Colors []string  
  5. }  
  6. group := ColorGroup{  
  7.     ID:     1,  
  8.     Name:   "Reds",  
  9.     Colors: []string{"Crimson", "Red", "Ruby", "Maroon"},  
  10. }  
  11. b, err := json.Marshal(group)  
  12. if err != nil {  
  13.     fmt.Println("error:", err)  
  14. }  
  15. os.Stdout.Write(b)  
  16.   
  17. Output:  
  18. {"ID":1,"Name":"Reds","Colors":["Crimson","Red","Ruby","Maroon"]}  

 

Decode

将JSON数据解码

func Unmarshal(data []byte, v interface{}) error

类型转换规则和上面的规则类似


  1. var jsonBlob = []byte(`[  
  2.     {"Name": "Platypus", "Order": "Monotremata"},  
  3.     {"Name": "Quoll",    "Order": "Dasyuromorphia"}  
  4. ]`)  
  5. type Animal struct {  
  6.     Name  string  
  7.     Order string  
  8. }  
  9. var animals []Animal  
  10. err := json.Unmarshal(jsonBlob, &animals)  
  11. if err != nil {  
  12.     fmt.Println("error:", err)  
  13. }  
  14. fmt.Printf("%+v", animals)  
  15.   
  16. Output:  
  17. [{Name:Platypus Order:Monotremata} {Name:Quoll Order:Dasyuromorphia}]  

 

结构体

结构体必须是大写字母开头的成员才会被JSON处理到,小写字母开头的成员不会有影响。

Mashal时,结构体的成员变量名将会直接作为JSON Object的key打包成JSON;Unmashal时,会自动匹配对应的变量名进行赋值,大小写不敏感。

Unmarshal时,如果JSON中有多余的字段,会被直接抛弃掉;如果JSON缺少某个字段,则直接忽略不对结构体中变量赋值,不会报错。

  1. type Message struct {  
  2.     Name  string  
  3.     Body  string  
  4.     Time  int64  
  5.     inner string  
  6. }  
  7.   
  8. var m = Message{  
  9.     Name:  "Alice",  
  10.     Body:  "Hello",  
  11.     Time:  1294706395881547000,  
  12.     inner: "ok",  
  13. }  
  14. b := []byte(`{"nAmE":"Bob","Food":"Pickle", "inner":"changed"}`)  
  15.   
  16. err := json.Unmarshal(b, &m)  
  17. if err != nil {  
  18.     fmt.Printf(err.Error())  
  19.     return  
  20. }  
  21. fmt.Printf("%v", m)  
  22.   
  23. Output:  
  24. {Bob Hello 1294706395881547000 ok}  

 

StructTag

如果希望手动配置结构体的成员和JSON字段的对应关系,可以在定义结构体的时候给成员打标签:

使用omitempty熟悉,如果该字段为nil或0值(数字0,字符串"",空数组[]等),则打包的JSON结果不会有这个字段。

  1. type Message struct {  
  2.     Name string `json:"msg_name"`       // 对应JSON的msg_name  
  3.     Body string `json:"body,omitempty"` // 如果为空置则忽略字段  
  4.     Time int64  `json:"-"`              // 直接忽略字段  
  5. }  
  6. var m = Message{  
  7.     Name: "Alice",  
  8.     Body: "",  
  9.     Time: 1294706395881547000,  
  10. }  
  11. data, err := json.Marshal(m)  
  12. if err != nil {  
  13.     fmt.Printf(err.Error())  
  14.     return  
  15. }  
  16. fmt.Println(string(data))  
  17.   
  18. Output:  
  19. {"msg_name":"Alice"}  

更灵活地使用JSON

使用json.RawMessage

json.RawMessage其实就是[]byte类型的重定义。可以进行强制类型转换。

现在有这么一种场景,结构体中的其中一个字段的格式是未知的:

  1. type Command struct {  
  2.     ID   int  
  3.     Cmd  string  
  4.     Args *json.RawMessage  
  5. }  

 

使用json.RawMessage的话,Args字段在Unmarshal时不会被解析,直接将字节数据赋值给Args。我们可以能先解包第一层的JSON数据,然后根据Cmd的值,再确定Args的具体类型进行第二次Unmarshal。

这里要注意的是,一定要使用指针类型*json.RawMessage,否则在Args会被认为是[]byte类型,在打包时会被打包成base64编码的字符串。

使用interface{}

interface{}类型在Unmarshal时,会自动将JSON转换为对应的数据类型:

JSON的boolean 转换为bool
JSON的数值 转换为float64
JSON的字符串 转换为string
JSON的Array 转换为[]interface{}
JSON的Object 转换为map[string]interface{}
JSON的null 转换为nil

需要注意的有两个。一个是所有的JSON数值自动转换为float64类型,使用时需要再手动转换为需要的int,int64等类型。第二个是JSON的object自动转换为map[string]interface{}类型,访问时直接用JSON Object的字段名作为key进行访问。再不知道JSON数据的格式时,可以使用interface{}。

自定义类型

如果希望自己定义对象的打包解包方式,可以实现以下的接口:

  1. type Marshaler interface {  
  2.     MarshalJSON() ([]byte, error)  
  3. }  
  4. type Unmarshaler interface {  
  5.     UnmarshalJSON([]byte) error  
  6. }  

 

实现该接口的对象需要将自己的数据打包和解包。如果实现了该接口,json在打包解包时则会调用自定义的方法,不再对该对象进行其他处理。

以上是关于Go -- 在Go语言中使用JSON struct的主要内容,如果未能解决你的问题,请参考以下文章

Go语言之 Struct Tag

Go语言的JSON输入(解码)(反序列化)之struct存储

go语言json处理

使用 struct 在 Go 中处理空 JSON 数组

Go语言处理JSon字段

Go语言之读取yaml配置文件,转换成struct结构,json形式输出