在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

type ColorGroup struct {    ID     int    Name   string    Colors []string}group := ColorGroup{    ID:     1,    Name:   "Reds",    Colors: []string{"Crimson", "Red", "Ruby", "Maroon"},}b, err := json.Marshal(group)if err != nil {    fmt.Println("error:", err)}os.Stdout.Write(b)Output:{"ID":1,"Name":"Reds","Colors":["Crimson","Red","Ruby","Maroon"]}

Decode

將JSON資料解碼

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

類型轉換規則和上面的規則類似

var jsonBlob = []byte(`[    {"Name": "Platypus", "Order": "Monotremata"},    {"Name": "Quoll",    "Order": "Dasyuromorphia"}]`)type Animal struct {    Name  string    Order string}var animals []Animalerr := json.Unmarshal(jsonBlob, &animals)if err != nil {    fmt.Println("error:", err)}fmt.Printf("%+v", animals)Output:[{Name:Platypus Order:Monotremata} {Name:Quoll Order:Dasyuromorphia}]

結構體

結構體必須是大寫字母開頭的成員才會被JSON處理到，小寫字母開頭的成員不會有影響。

Mashal時，結構體的成員變數名將會直接作為JSON Object的key打包成JSON；Unmashal時，會自動匹配對應的變數名進行賦值，大小寫不敏感。

Unmarshal時，如果JSON中有多餘的欄位，會被直接拋棄掉；如果JSON缺少某個欄位，則直接忽略不對結構體中變數賦值，不會報錯。

type Message struct {Name  stringBody  stringTime  int64inner string}var m = Message{Name:  "Alice",Body:  "Hello",Time:  1294706395881547000,inner: "ok",}b := []byte(`{"nAmE":"Bob","Food":"Pickle", "inner":"changed"}`)err := json.Unmarshal(b, &m)if err != nil {fmt.Printf(err.Error())return}fmt.Printf("%v", m)Output:{Bob Hello 1294706395881547000 ok}

StructTag

如果希望手動設定結構體的成員和JSON欄位的對應關係，可以在定義結構體的時候給成員打標籤：

使用omitempty熟悉，如果該欄位為nil或0值（數字0,字串"",空數組[]等），則打包的JSON結果不會有這個欄位。

type Message struct {Name string `json:"msg_name"`       // 對應JSON的msg_nameBody string `json:"body,omitempty"` // 如果為空白置則忽略欄位Time int64  `json:"-"`              // 直接忽略欄位}var m = Message{Name: "Alice",Body: "",Time: 1294706395881547000,}data, err := json.Marshal(m)if err != nil {fmt.Printf(err.Error())return}fmt.Println(string(data))Output:{"msg_name":"Alice"}

更靈活地使用JSON

使用json.RawMessage

json.RawMessage其實就是[]byte類型的重定義。可以進行強制類型轉換。

現在有這麼一種情境，結構體中的其中一個欄位的格式是未知的：

type Command struct {ID   intCmd  stringArgs *json.RawMessage}

使用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{}。

自訂類型

如果希望自己定義對象的打包解包方式，可以實現以下的介面：

type Marshaler interface {    MarshalJSON() ([]byte, error)}type Unmarshaler interface {    UnmarshalJSON([]byte) error}

實現該介面的對象需要將自己的資料打包和解包。如果實現了該介面，json在打包解包時則會調用自訂的方法，不再對該對象進行其他處理。