細說Golang的JSON解析

之前一直寫一些動態語言，覺得解析JOSN還是很簡單的，往往只需要幾行代碼就能拿到解析好的JSON對象。Go語言自帶的json包可以讓你在程序中方便的讀取和寫入 JSON 數據。生成JSON場景相對簡單一些，json.Marshal()會根據傳入的結構體生成JSON數據。解析JSON會把數據解析到結構體中，由於JSON格式的自由組合的特點，尤其是那些結構複雜的JSON數據對新手來說聲明接受JSON數據的結構體類型就會陷入不知從何下手的困擾。 最近工作中由於要解析JS和PHP程序持久化的JSON數據，大概花了兩個下午才搞清楚針對常見的JSON數據應該如何聲明結構體類型，下面分別說明一下。

解析簡單JSON

package main

import (
    "fmt"
    "encoding/json"
    "time"
    
)

func main() {
    type FruitBasket struct {
        Name    string 
        Fruit   []string
        Id      int64 `json:"ref"`// 聲明對應的json key
        Created time.Time
    }

    jsonData := []byte(`
    {
        "Name": "Standard",
        "Fruit": [
             "Apple",
            "Banana",
            "Orange"
        ],
        "ref": 999,
        "Created": "2018-04-09T23:00:00Z"
    }`)

    var basket FruitBasket
    err := json.Unmarshal(jsonData, &basket)
    if err != nil {
         fmt.Println(err)
    }
    fmt.Println(basket.Name, basket.Fruit, basket.Id)
    fmt.Println(basket.Created)
}

說明： 由於json.UnMarshal()方法接收的是字節切片，所以首先需要把JSON字符串轉換成字節切片c := []byte(s)
Playground url: https://play.golang.org/p/mcB...

解析內嵌對象的JSON

把上面的Fruit值如果改成字典 "Fruit" : {"Name", "Apple", "PriceTag": "$1"}, 變成：

    jsonData := []byte(`
    {
        "Name": "Standard",
        "Fruit" : {"Name": "Apple", "PriceTag": "$1"},
        "ref": 999,
        "Created": "2018-04-09T23:00:00Z"
    }`)

那麼結構體類型應該這麼聲明

type Fruit struct {
    Name string `json":Name"`
    PriceTag string `json:"PriceTag"`
}

type FruitBasket struct {
    Name    string 
    Fruit   Fruit
    Id      int64 `json:"ref"`// 聲明對應的json key
    Created time.Time
}

Playground url: https://play.golang.org/p/dqw...

解析內嵌對象數組的JSON(Embed Array of Object)

如果上面JOSN對象裏的Fruit值現在變成了

"Fruit" : [
    {
        "Name": "Apple",
            "PriceTag": "$1"
    },
    {
        "Name": "Pear",
        "PriceTag": "$1.5"
    }
]

這種情況也簡單把解析JSON的結構體做如下更改，把Fruit字段類型換爲 []Fruit即可

type Fruit struct {
    Name string `json:"Name"`
    PriceTag string `json:"PriceTag"`
}

type FruitBasket struct {
    Name    string 
    Fruit   []Fruit
    Id      int64 `json:"ref"`// 聲明對應的json key
    Created time.Time
}

解析具有動態Key的對象（Parse a JSON object with dynamic key)

下面再做一下複雜的變通，如果把上面的對象數組變爲Key爲水果ID的對象（object of object）比如

"Fruit" : {
    "1": {
        "Name": "Apple",
        "PriceTag": "$1"
    },
    "2": {
        "Name": "Pear",
        "PriceTag": "$1.5"
    }
}

每個Key的名字在聲明結構體的時候是不知道值的，這樣該怎麼聲明呢，答案是把Fruit字段的類型聲明爲一個key爲string類型值爲Fruit類型的map

type Fruit struct {
    Name string `json:"Name"`
    PriceTag string `json:"PriceTag"`
}

type FruitBasket struct {
    Name    string 
    Fruit   map[string]Fruit
    Id      int64 `json:"ref"`// 聲明對應的json key
    Created time.Time
}

示例代碼

package main

import (
    "fmt"
    "encoding/json"
    "time"
    
)

func main() {
    type Fruit struct {
        Name string `json:"Name"`
        PriceTag string `json:"PriceTag"`
    }

    type FruitBasket struct {
        Name    string 
        Fruit   map[string]Fruit
        Id      int64 `json:"ref"`// 聲明對應的json key
        Created time.Time

    }    
    jsonData := []byte(`
    {
        "Name": "Standard",
        "Fruit" : {
        "1": {
        "Name": "Apple",
        "PriceTag": "$1"
        },
        "2": {
        "Name": "Pear",
        "PriceTag": "$1.5"
        }
        },
        "ref": 999,
        "Created": "2018-04-09T23:00:00Z"
    }`)

    var basket FruitBasket
    err := json.Unmarshal(jsonData, &basket)
    if err != nil {
         fmt.Println(err)
    }
    for _, item := range basket.Fruit {
    fmt.Println(item.Name, item.PriceTag)
    }
}

Playground url: https://play.golang.org/p/fh8...

解析包含任意層級的數組和對象的JSON數據(arbitrary arrays and objects)

針對包含任意層級的JOSN數據，聲明結構體類型比較困難，encode\json包還提供另外一種方法來解析JSON數據。
encoding\json包使用：

• map[string]interface{} 存儲JOSN對象
• []interface 存儲JOSN數組

json.Unmarshl 將會把任何合法的JSON數據存儲到一個interface{}類型的值，通過使用空接口類型我們可以存儲任意值，但是使用這種類型作爲值時需要先做一次類型斷言。

示例代碼:

jsonData := []byte(`{"Name":"Eve","Age":6,"Parents":["Alice","Bob"]}`)

var v interface{}
json.Unmarshal(jsonData, &v)
data := v.(map[string]interface{})

for k, v := range data {
    switch v := v.(type) {
    case string:
        fmt.Println(k, v, "(string)")
    case float64:
        fmt.Println(k, v, "(float64)")
    case []interface{}:
        fmt.Println(k, "(array):")
        for i, u := range v {
            fmt.Println("    ", i, u)
        }
    default:
        fmt.Println(k, v, "(unknown)")
    }
}

雖然將JSON數據存儲到空接口類型的值中可以用來解析任意結構的JSON數據，但是在實際應用中發現還是有不可控的地方，比如將數字字符串的值轉換成了float類型的值，所以經常會在運行時報類型斷言的錯誤，所以在JSON結構確定的情況下還是優先使用結構體類型聲明，將JSON數據到結構體中的方式來解析JSON。