細說 Golang 的 JSON 解析

KevinYan發表於2019-12-09
GolangJSON

之前一直寫一些動態語言，覺得解析JSON還是很簡單的，往往只需要幾行程式碼就能拿到解析好的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/mcB6Kb6zCHE

解析內嵌物件的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/dqw6tLb4JWm

解析內嵌物件陣列的JSON(Embed Array of Object)

如果上面JSON物件裡的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/fh8JKa6pKJS

解析包含任意層級的陣列和物件的JSON資料(arbitrary arrays and objects)

針對包含任意層級的JSON資料，宣告結構體型別比較困難，encode/json包還提供另外一種方法來解析JSON資料。
encoding/json包使用：

  • map[string]interface{} 儲存JSON物件
  • []interface 儲存JSON陣列

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。

本作品採用《CC 協議》，轉載必須註明作者和本文連結
公眾號:網管叨bi叨 | Golang、Laravel、Docker、K8s等學習經驗分享

相關文章