最近ハマったシリアライズの落とし穴

Transcript

1. 最近ハマったシリアライズの落とし穴 kamakura.go #8 kosuke1012 1
2. 自己紹介 kosuke1012 @kosuke_yellow 所属: 株式会社一休 マイブーム: ランニング（のシューズ集め） 2
3. シリアライズ type Event struct { UserID string `json:"user_id"` Amount int `json:"amount"` } in := Event{UserID: "u1", Amount: 1200} b, _ := json.Marshal(in) // b = {"user_id":"u1","amount":1200} var out Event _ = json.Unmarshal(b, &out) // out = {UserID:"u1", Amount:1200} 3
4. シリアライズしたいとき リクエスト間でいったん永続化しておきたいときとか 4
5. struct を変更したくなった // v1 type Event struct { UserID string `json:"user_id"` Amount int `json:"amount"` } // v2: フィールド名を変更（互換性なし） type Event struct { UID string `json:"uid"` Amount int `json:"amount"` } 5
6. 後方互換を意識しないといけない v1 の JSON を v2 で Unmarshal しないといけない 6
7. 後方互換その1 専用 Unmarshal メソッドをつくる type eventDTO struct { UserID string `json:"user_id"` UID string `json:"uid"` Amount int `json:"amount"` } func (e *Event) UnmarshalJSON(b []byte) error { var dto eventDTO if err := json.Unmarshal(b, &dto); err != nil { return err } // uid があれば uid, なければ user_id uid := dto.UID if uid == "" { uid = dto.UserID } *e = Event{UID: uid, Amount: dto.Amount} return nil } 7
8. 後方互換その2 バージョンごとに DTO と Unmarshal メソッドをつくる type raw struct { Version int `json:"version"` Event json.RawMessage `json:"data"` } func (e *Event) UnmarshalJSON(b []byte) error { var r raw _ = json.Unmarshal(b, &r) switch r.Version { case 1: return e.unmarshalJSONV1(r.Event) case 2: return e.unmarshalJSONV2(r.Event) } } 8
9. 実は前方互換も必要だった（今日話したかったこと） v2 の JSON を v1 で Unmarshal しないといけない たとえば k8s のローリングアップデート中など 9
10. 前方互換 v1 も Marshal する type envelope struct { Payloads map[string]json.RawMessage `json:"payloads"` } func (e Event) MarshalJSON() ([]byte, error) { v1, _ := json.Marshal(eventV1DTO{ /*...*/ }}) v2, _ := json.Marshal(eventV2DTO{ /*...*/ }}) return json.Marshal(envelope{ Payloads: map[string]json.RawMessage{ "v1": v1, "v2": v2, }, }) } 10
11. まとめ シリアライズのとき、後方互換は意識するけど前方互換忘れがち（じゃないですか？） 11