encoding/json パッケージ

Goと外部システム(REST API など)とのやり取りでは、JSON形式が広く使われます。encoding/json を使うと struct と JSON を相互変換できます。

以降のサンプルで共通して使う User 型は以下の定義です。フィールドに付けた `json:"..."` タグにより、JSON 上のキー名を指定できます(Name → "name"、Age → "age")。

type User struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
}

1. struct から JSON への変換(json.Marshal)

json.Marshal は、struct を JSON 形式のバイト列 []byte に変換する関数です。書き方は以下のとおりです。

data, err := json.Marshal(構造体)   // ([]byte, error) ─ struct を JSON バイト列に変換する

次のコードは、User 型の値を JSON に変換して表示する例です。

package main

import (
    "encoding/json"
    "fmt"
)

type User struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
}

func main() {
    u := User{Name: "Taro", Age: 30}
    data, _ := json.Marshal(u)
    fmt.Println(string(data))
}

以下のような実行結果が表示されます。

{"name":"Taro","age":30}

User の中身が JSON 形式のバイト列に変換され、string(data) で文字列にして表示すると {"name":"Taro","age":30} になりました。タグで指定したキー名(name / age)が使われている点に注目してください。

2. JSON から struct への変換(json.Unmarshal)

json.Unmarshal は、JSON バイト列を struct に読み込む関数です。書き方は以下のとおりです。

err = json.Unmarshal(バイト列, &構造体変数)   // error ─ JSON バイト列を struct に読み込む

第2引数は「書き込む先の struct のポインタ」なので、Goポインタ で扱った &変数名 の形でアドレスを渡します。

次のコードは、JSON 文字列を User に読み込んで表示する例です。

package main

import (
    "encoding/json"
    "fmt"
)

type User struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
}

func main() {
    input := []byte(`{"name":"Jiro","age":25}`)
    var u User
    json.Unmarshal(input, &u)
    fmt.Println(u)
}

以下のような実行結果が表示されます。

{Jiro 25}

JSON 文字列が User に読み込まれ、フィールド値が並んだ既定形式で表示されました。u.Name に "Jiro"、u.Age に 25 が入っている状態です。