1. 程式人生 > >Go學習筆記:json處理

Go學習筆記:json處理

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. Output:  
  17. {"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. Output:  
  16. [{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. var m = Message{  
  8.     Name:  "Alice",  
  9.     Body:  "Hello",  
  10.     Time:  1294706395881547000,  
  11.     inner: "ok",  
  12. }  
  13. b := []byte(`{"nAmE":"Bob","Food":"Pickle", "inner":"changed"}`)  
  14. err := json.Unmarshal(b, &m)  
  15. if err != nil {  
  16.     fmt.Printf(err.Error())  
  17.     return  
  18. }  
  19. fmt.Printf("%v", m)  
  20. Output:  
  21. {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. Output:  
  18. {"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在打包解包時則會呼叫自定義的方法,不再對該物件進行其他處理。