go語言JSON處理

這是一個建立於 的文章，其中的資訊可能已經有所發展或是發生改變。

JSON（JavaScript Object Notation）是一種輕量級的資料交換語言，以文字為基礎，具有自我描述性且易於讓人閱讀。儘管JSON是Javascript的一個子集，但JSON是獨立於語言的文字格式設定，並且採用了類似於C語言家族的一些習慣。JSON與XML最大的不同在於XML是一個完整的標記語言，而JSON不是。JSON由於比XML更小、更快，更易解析,以及瀏覽器的內建快速解析支援,使得其更適用於網路資料轉送領域。目前我們看到很多的開放平台，基本上都是採用了JSON作為他們的資料互動的介面。既然JSON在Web開發中如此重要，那麼Go語言對JSON支援的怎麼樣呢？Go語言的標準庫已經非常好的支援了JSON，可以很容易的對JSON資料進行編、解碼的工作。

前一小節的營運的例子用json來表示，結果描述如下：

{"servers":[{"serverName":"Shanghai_VPN","serverIP":"127.0.0.1"},{"serverName":"Beijing_VPN","serverIP":"127.0.0.2"}]}

本小節餘下的內容將以此JSON資料為基礎，來介紹go語言的json包對JSON資料的編、解碼。

解析JSON

解析到結構體

假如有了上面的JSON串，那麼我們如何來解析這個JSON串呢？Go的JSON包中有如下函數

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

通過這個函數我們就可以實現解析的目的，詳細的解析例子請看如下代碼：

package mainimport (    "encoding/json"    "fmt")type Server struct {    ServerName string    ServerIP   string}type Serverslice struct {    Servers []Server}func main() {    var s Serverslice    str := `{"servers":[{"serverName":"Shanghai_VPN","serverIP":"127.0.0.1"},{"serverName":"Beijing_VPN","serverIP":"127.0.0.2"}]}`    json.Unmarshal([]byte(str), &s)    fmt.Println(s)}

在上面的範例程式碼中，我們首先定義了與json資料對應的結構體，數組對應slice，欄位名對應JSON裡面的KEY，在解析的時候，如何將json資料與struct欄位相匹配呢？例如JSON的key是Foo，那麼怎麼找對應的欄位呢？

• 首先尋找tag含有Foo的可匯出的struct欄位(首字母大寫)
• 其次尋找欄位名是Foo的匯出欄位
• 最後尋找類似FOO或者FoO這樣的除了首字母之外其他大小寫不敏感的匯出欄位

聰明的你一定注意到了這一點：能夠被賦值的欄位必須是可匯出欄位(即首字母大寫）。同時JSON解析的時候只會解析能找得到的欄位，找不到的欄位會被忽略，這樣的一個好處是：當你接收到一個很大的JSON資料結構而你卻只想擷取其中的部分資料的時候，你只需將你想要的資料對應的欄位名大寫，即可輕鬆解決這個問題。

解析到interface

上面那種解析方式是在我們知曉被解析的JSON資料的結構的前提下採取的方案，如果我們不知道被解析的資料的格式，又應該如何來解析呢？

我們知道interface{}可以用來儲存任意資料類型的對象，這種資料結構正好用於儲存解析的未知結構的json資料的結果。JSON包中採用map[string]interface{}和[]interface{}結構來儲存任意的JSON對象和數組。Go類型和JSON類型的對應關係如下：

• bool 代表 JSON booleans,
• float64 代表 JSON numbers,
• string 代表 JSON strings,
• nil 代表 JSON null.

現在我們假設有如下的JSON資料

b := []byte(`{"Name":"Wednesday","Age":6,"Parents":["Gomez","Morticia"]}`)

如果在我們不知道他的結構的情況下，我們把他解析到interface{}裡面

var f interface{}err := json.Unmarshal(b, &f)

這個時候f裡面儲存了一個map類型，他們的key是string，值儲存在空的interface{}裡

f = map[string]interface{}{    "Name": "Wednesday",    "Age":  6,    "Parents": []interface{}{        "Gomez",        "Morticia",    },}

那麼如何來訪問這些資料呢？通過斷言的方式：

m := f.(map[string]interface{})

通過斷言之後，你就可以通過如下方式來訪問裡面的資料了

for k, v := range m {    switch vv := v.(type) {    case string:        fmt.Println(k, "is string", vv)    case int:        fmt.Println(k, "is int", vv)    case float64:        fmt.Println(k,"is float64",vv)    case []interface{}:        fmt.Println(k, "is an array:")        for i, u := range vv {            fmt.Println(i, u)        }    default:        fmt.Println(k, "is of a type I don't know how to handle")    }}

通過上面的樣本可以看到，通過interface{}與type assert的配合，我們就可以解析未知結構的JSON數了。

上面這個是官方提供的解決方案，其實很多時候我們通過類型斷言，操作起來不是很方便，目前bitly公司開源了一個叫做simplejson的包,在處理未知結構體的JSON時相當方便，詳細例子如下所示：

js, err := NewJson([]byte(`{    "test": {        "array": [1, "2", 3],        "int": 10,        "float": 5.150,        "bignum": 9223372036854775807,        "string": "simplejson",        "bool": true    }}`))arr, _ := js.Get("test").Get("array").Array()i, _ := js.Get("test").Get("int").Int()ms := js.Get("test").Get("string").MustString()

可以看到，使用這個庫操作JSON比起官方包來說，簡單的多,詳細的請參考如下地址：https://github.com/bitly/go-simplejson

產生JSON

我們開發很多應用的時候，最後都是要輸出JSON資料串，那麼如何來處理呢？JSON包裡面通過Marshal函數來處理，函數定義如下：

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

假設我們還是需要產生上面的伺服器列表資訊，那麼如何來處理呢？請看下面的例子：

package mainimport (    "encoding/json"    "fmt")type Server struct {    ServerName string    ServerIP   string}type Serverslice struct {    Servers []Server}func main() {    var s Serverslice    s.Servers = append(s.Servers, Server{ServerName: "Shanghai_VPN", ServerIP: "127.0.0.1"})    s.Servers = append(s.Servers, Server{ServerName: "Beijing_VPN", ServerIP: "127.0.0.2"})    b, err := json.Marshal(s)    if err != nil {        fmt.Println("json err:", err)    }    fmt.Println(string(b))}

輸出如下內容：

{"Servers":[{"ServerName":"Shanghai_VPN","ServerIP":"127.0.0.1"},{"ServerName":"Beijing_VPN","ServerIP":"127.0.0.2"}]}

我們看到上面的輸出欄位名的首字母都是大寫的，如果你想用小寫首字母怎麼辦呢？把結構體的欄位名改成首字母小寫？JSON輸出的時候必須注意，只有匯出的欄位才會被輸出，如果修改欄位名，那麼就會發現什麼都不會輸出，所以必須通過struct tag定義來實現：

type Server struct {    ServerName string `json:"serverName"`    ServerIP   string `json:"serverIP"`}type Serverslice struct {    Servers []Server `json:"servers"`}

通過修改上面的結構體定義，輸出的JSON串就和我們最開始定義的JSON串保持一致了。

針對JSON的輸出，我們在定義struct tag的時候需要注意的幾點是:

• 欄位的tag是"-"，那麼這個欄位不會輸出到JSON
• tag中帶有自訂名稱，那麼這個自訂名稱會出現在JSON的欄位名中，例如上面例子中serverName
• tag中如果帶有"omitempty"選項，那麼如果該欄位值為空白，就不會輸出到JSON串中
• 如果欄位類型是bool, string, int, int64等，而tag中帶有",string"選項，那麼這個欄位在輸出到JSON的時候會把該欄位對應的值轉換成JSON字串

舉例來說：

type Server struct {    // ID 不會匯出到JSON中    ID int `json:"-"`    // ServerName 的值會進行二次JSON編碼    ServerName  string `json:"serverName"`    ServerName2 string `json:"serverName2,string"`    // 如果 ServerIP 為空白，則不輸出到JSON串中    ServerIP   string `json:"serverIP,omitempty"`}s := Server {    ID:         3,    ServerName:  `Go "1.0" `,    ServerName2: `Go "1.0" `,    ServerIP:   ``,}b, _ := json.Marshal(s)os.Stdout.Write(b)

會輸出以下內容：

{"serverName":"Go \"1.0\" ","serverName2":"\"Go \\\"1.0\\\" \""}

Marshal函數只有在轉換成功的時候才會返回資料，在轉換的過程中我們需要注意幾點：

• JSON對象只支援string作為key，所以要編碼一個map，那麼必須是map[string]T這種類型(T是Go語言中任意的類型)
• Channel, complex和function是不能被編碼成JSON的
• 嵌套的資料是不能編碼的，不然會讓JSON編碼進入死迴圈
• 指標在編碼的時候會輸出指標指向的內容，而null 指標會輸出null

本小節，我們介紹了如何使用Go語言的json標準包來編解碼JSON資料，同時也簡要介紹了如何使用第三方包go-simplejson來在一些情況下簡化操作，學會並熟練運用它們將對我們接下來的Web開發相當重要。