JSONをGoの構造体に変換!

JSONを入力すると、jsonタグ付きのGo構造体に変換します!Go (Golang) struct, json tags 対応。
JSON
結果

JSONをGoの構造体に変換!

JSON を、encoding/json のタグ付きの Go の構造体定義に変換します。フィールド名は Go のエクスポート名のルールと golint のイニシャリズム一覧(ID、URL、API など)に従い、gofmt にかけたように列がそろいます。

Webhook のペイロードや API レスポンスを json.Unmarshal で受ける型、net/http・Gin・Echo のハンドラー用のリクエストボディ構造体、CLI の設定構造体が必要なときに役立ちます。

使い方

  1. JSON を貼り付けます。複数行の配列なら、一部の行にないフィールドを検出して omitempty タグを付けます。
  2. 構造体名 にトップレベルの構造体名を入力します(既定は Root)。URL に ?name= として残ります。
  3. 結果を .go ファイルに貼り付け、package 句を追加します。時刻のフィールドが見つかった場合は import "time" も含まれます。
  4. var ev WebhookEvent; err := json.Unmarshal(body, &ev) のように使います。

例

入力 (JSON)
{
  "event_id": "evt_1Pq",
  "type": "invoice.paid",
  "created_at": "2024-05-01T03:15:00Z",
  "amount_cents": 4999,
  "customer": { "id": "cus_9", "email": "kim@example.com" },
  "retry_count": null
}
出力 (Go)
import "time"

type WebhookEvent struct {
	EventID     string    `json:"event_id"`
	Type        string    `json:"type"`
	CreatedAt   time.Time `json:"created_at"`
	AmountCents int       `json:"amount_cents"`
	Customer    Customer  `json:"customer"`
	RetryCount  any       `json:"retry_count,omitempty"`
}

type Customer struct {
	ID    string `json:"id"`
	Email string `json:"email"`
}

event_id は golint のイニシャリズムのルールにより EventID になり、RFC 3339 の文字列である created_at は time.Time と推論されて import "time" が追加されます。retry_count は null で型がわからないため、omitempty 付きの any になります。

対応機能

  • すべてのフィールドに json:"originalKey" タグを付け、一部の行にないフィールドや null を含むフィールドには ,omitempty を加えます。
  • 省略可能な値型(int、string、bool、構造体、time.Time)は、「存在しない」とゼロ値を区別できるようポインター(*int)にします。スライスと any はもともと nil になれるのでポインターにしません。
  • 数値: 32 ビットの整数は int、それを超えると int64、小数があれば float64。
  • 2024-05-01T03:15:00Z のような RFC 3339 の文字列は time.Time と推論します。
  • よく使われるイニシャリズムは大文字のまま残し(user_id → UserID、home_url → HomeURL)、数字で始まるキーには Field の接頭辞を付けます。
  • "" のように Go の json タグに書けないキーは飛ばし、構造体の上のコメントに一覧で示します。
  • トップレベルがオブジェクトの配列なら、要素の構造体と、[]Root にアンマーシャルするよう示すコメントを出力します。

利用シーン

Webhook の受信側

決済サービスや Git ホスティングサービスが送るサンプルイベントから構造体を作り、json.NewDecoder(r.Body).Decode(&ev) でデコードすれば、map[string]any への型アサーションを繰り返す必要がなくなります。

Gin や Echo でのリクエストのバインド

クライアントのリクエストのサンプルから c.ShouldBindJSON(&req) 用の構造体を生成し、必要な箇所に binding:"required" タグを追加します。

JSON の設定を読む CLI

config.json を一度構造体にしておけば、os.ReadFile のあとに json.Unmarshal を1回呼ぶだけで設定全体が型付きの値で手に入ります。

注意点と制限

  • time.Time と推論するのは RFC 3339 の文字列だけです。2024-05-01 03:15:00 のような値や Unix タイムスタンプは string や int のままです。
  • json.Unmarshal は既定で未知のキーを無視し、キーを大文字・小文字を区別せずに照合します。厳密にデコードしたい場合は Decoder.DisallowUnknownFields() を使ってください。
  • int は 64 ビット環境では 64 ビットですが、int64 を書くのはサンプルの値が 32 ビットを超えた場合だけです。増えていく ID などは、自分で int64 に変えておくほうが安全です。
  • ネストした構造体はすべて別のトップレベル型として定義し、匿名のインライン構造体は使いません。
  • 型が混在する値や常に null の値は any になります。実際の型がわかったら置き換えてください。

よくある質問

省略可能なフィールドが *int のようなポインターなのはなぜですか?

普通の int フィールドはキーがないと 0 になり、本当の 0 と区別できません。ポインターならキーがないときや null のときに nil になり、omitempty と組み合わせることで、再びマーシャリングするときにキーが省かれます。

フィールド名を小文字にできますか?

encoding/json が読み書きするのはエクスポートされた(大文字始まりの)フィールドだけで、小文字のフィールドはタグがあっても無視されます。Go では名前を大文字始まりのままにし、JSON のキーはタグに書きます。

retry_count のような null のフィールドが any になりました。

サンプルに null しかないと型を推論する材料がありません。実際の値が入った別のレスポンスを配列に加えて両方を変換するか、*int などに手で変えてください。

Go の構造体からサンプル JSON に戻せますか?

戻せます。上部の Go struct → JSON タブに構造体を貼り付ければ、タグを読み取って例の JSON を作ります。