乐趣区

细说Golang的JSON解析

jiezi

之前一直写一些动态语言，觉得解析 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。

退出移动版