範例驅動 Go:JSON

Go 提供對 JSON 編碼與解碼的內建支援,包括來自內建和自定義資料類型,以及編碼到內建和自定義資料類型。

package main
import (
    "encoding/json"
    "fmt"
    "os"
)

我們將使用以下兩個結構,示範自定義類型的編碼與解碼。

type response1 struct {
    Page   int
    Fruits []string
}

只有外傳欄位會編碼/解碼到 JSON 中。欄位必須以大寫字母開頭才能外傳。

type response2 struct {
    Page   int      `json:"page"`
    Fruits []string `json:"fruits"`
}
func main() {

首先我們來看基本資料類型如何編碼為 JSON 字串。以下是一些原子值的範例。

    bolB, _ := json.Marshal(true)
    fmt.Println(string(bolB))
    intB, _ := json.Marshal(1)
    fmt.Println(string(intB))
    fltB, _ := json.Marshal(2.34)
    fmt.Println(string(fltB))
    strB, _ := json.Marshal("gopher")
    fmt.Println(string(strB))

以下是陣列和對應的範例,會編碼成 JSON 陣列和物件,這是你的預期結果。

    slcD := []string{"apple", "peach", "pear"}
    slcB, _ := json.Marshal(slcD)
    fmt.Println(string(slcB))
    mapD := map[string]int{"apple": 5, "lettuce": 7}
    mapB, _ := json.Marshal(mapD)
    fmt.Println(string(mapB))

JSON 套件能夠自動編碼你的自定義資料類型。它只會將外傳欄位包含在編碼的輸出中,並且會預設將這些名稱使用為 JSON 金鑰。

    res1D := &response1{
        Page:   1,
        Fruits: []string{"apple", "peach", "pear"}}
    res1B, _ := json.Marshal(res1D)
    fmt.Println(string(res1B))

你可以在結構欄位宣告中使用標籤,自訂編碼後 JSON 金鑰的名稱。請參閱上方 `response2` 的定義,以查看此類標籤的範例。

    res2D := &response2{
        Page:   1,
        Fruits: []string{"apple", "peach", "pear"}}
    res2B, _ := json.Marshal(res2D)
    fmt.Println(string(res2B))

現在讓我們來看看如何將 JSON 資料解碼為 Go 值。以下是通用資料結構的範例。

    byt := []byte(`{"num":6.13,"strs":["a","b"]}`)

我們需要提供一個變數,讓 JSON 套件可以將解碼資料放入其中。這個 `map[string]interface{}` 將會存放字串對應至任意資料類型的對應。

    var dat map[string]interface{}

以下是實際的解碼,以及檢查相關錯誤。

    if err := json.Unmarshal(byt, &dat); err != nil {
        panic(err)
    }
    fmt.Println(dat)

為了使用解碼對應中的值,我們需要將其轉換為適當的類型。例如,這裡我們將 `num` 中的值轉換為預期的 `float64` 類型。

    num := dat["num"].(float64)
    fmt.Println(num)

取用巢狀資料需要一系列的轉換。

    strs := dat["strs"].([]interface{})
    str1 := strs[0].(string)
    fmt.Println(str1)

我們也可以將 JSON 解碼至自定義資料類型。這有助於為我們的程式增加額外的類型安全,並在取用解碼資料時消除類型斷言的需要。

    str := `{"page": 1, "fruits": ["apple", "peach"]}`
    res := response2{}
    json.Unmarshal([]byte(str), &res)
    fmt.Println(res)
    fmt.Println(res.Fruits[0])

在以上範例中,我們在資料與標準輸出上的 JSON 表示之間,始終使用位元組和字串作為中間項。我們也可以直接將 JSON 編碼串流到 `os.Writer`(例如 `os.Stdout`)甚至 HTTP 回應主體。

    enc := json.NewEncoder(os.Stdout)
    d := map[string]int{"apple": 5, "lettuce": 7}
    enc.Encode(d)
}
$ go run json.go
true
1
2.34
"gopher"
["apple","peach","pear"]
{"apple":5,"lettuce":7}
{"Page":1,"Fruits":["apple","peach","pear"]}
{"page":1,"fruits":["apple","peach","pear"]}
map[num:6.13 strs:[a b]]
6.13
a
{1 [apple peach]}
apple
{"apple":5,"lettuce":7}

我們在此已介紹 Go 中 JSON 的基礎,但請查看 JSON 和 Go 部落格文章和 JSON 套件文件,以瞭解更多相關資訊。

下一個範例:XML