自分で対応表を書く場合#

例えば以下のような JSON を扱うことを考えます。

{
  "user_id": 100,
  "user_name": "tkgling",
  "user_email": "[email protected]"
}

これは先程の考えを推し進めれば次のように構造体をつくれば Decodable で一発で変換できる。

struct UserInfo: Decodable {
    let user_id: Int
    let user_name: String
    let user_email: String
}

しかし、Swift はキャメルケースが命名規則なので、この変数名は正直センスがない。別の言い方をすればイカしていないのである。

Swift の命名規則に従えばこれらの変数は以下のように定義されるべきである。スネークケースからキャメルケースの変換は簡単で、アンダーバーを削除してアンダーバーの最初のアルファベットを大文字にするだけである。

struct UserInfo: Decodable {
    let userId: Int
    let userName: String
    let userEmail: String
}

ただ、これではそのままデコードできないのでそこを繋げるための対応表を書く。

private let UserInfoKeys: String, CodingKey {
    case userId     = "user_id"
    case userName   = "user_name"
    case userEmail  = "user_email"
}

Enum の名前は今回は変数名と揃えたが、区別がつくなら別に何でも良い。ただし、rawValue だけはキーと一致させる必要がある。

最後に構造体のイニシャライザを書いたらそれらをくっつけるだけである。

struct UserInfo: Decodable {
   let userId: Int
   let userName: String
   let userEmail: String

   private let UserInfoKeys: String, CodingKey {
   case userId     = "user_id"
   case userName   = "user_name"
   case userEmail  = "user_email"
   }

   init(from decoder: Decoder) throws {
       let container = try decoder.container(keyedBy: UserInfoKeys.self)
       // 処理を書く
   }
}

これは Playground で簡単に再現できるのでやってみましょう。

import Foundation

// JSONファイルを定義
let json = """
{
    "user_id": 0,
    "user_name": "tkgling",
    "user_email": "[email protected]"
}
"""

let decoder = JSONDecoder()
let data = try decoder.decode(UserInfo.self, from: Data(json.utf8))
print(data)

// UserInfoの定義
struct UserInfo: Decodable {
    let userId: Int
    let userName: String
    let userEmail: String

    // プロパティとキーの対応
    private enum UserInfoKeys: String, CodingKey {
        case userId = "user_id"
        case userName = "user_name"
        case userEmail = "user_email"
    }

    // イニシャライザ
    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: UserInfoKeys.self)

        userId = try container.decode(Int.self, forKey: .userId)
        userName = try container.decode(String.self, forKey: .userName)
        userEmail = try container.decode(String.self, forKey: .userEmail)
    }
}

このコードで正しく、次のような結果を得ることができます。

// 実行結果
UserInfo(userId: 0, userName: "tkgling", userEmail: "[email protected]")

が、やってみればわかるのですが途方もなくめんどくさいです。プロパティが 10 くらいならやる気もおきますが、それを超えるとめんどうなだけです。

スネークケースからキャメルケースへの変換#

単にスネークケースからキャメルケースに変換するだけであれば JSONDecoder のconvertFromSnakeCaseのプロパティが使えます。

import Foundation

let json = """
{
    "user_id": 0,
    "user_name": "tkgling",
    "user_email": "[email protected]"
}
"""

let decoder: JSONDecoder = {
    let decoder = JSONDecoder()
    decoder.keyDecodingStrategy = .convertFromSnakeCase
    return decoder
}()
let data = try decoder.decode(UserInfo.self, from: Data(json.utf8))
print(data)

struct UserInfo: Decodable {
    let userId: Int
    let userName: String
    let userEmail: String
}

これは JSONDecoder のプロパティに予め.convertFromSnakeCaseを適用させた状態で使っているため、JSON を読み込んだ段階でキーが全てキャメルケースに変換されています。

よって、対応表を書かなくとも一発でデータを取得することができます。

JSON のキーをプロパティ名にする#

こちらは Swift での命名規則よりも JSON 側の命名規則を優先する場合、または JSON 側がキャメルケースになっている場合などに使えます。

import Foundation

let json = """
{
    "user_id": 0,
    "user_name": "tkgling",
    "user_email": "[email protected]"
}
"""

let decoder: JSONDecoder = {
    let decoder = JSONDecoder()
    decoder.keyDecodingStrategy = .useDefaultKeys
    return decoder
}()
let data = try decoder.decode(UserInfo.self, from: Data(json.utf8))
print(data)

struct UserInfo: Decodable {
    let user_id: Int
    let user_name: String
    let user_email: String
}

配列#

ではちょっと複雑化したネスト付きの JSON を考えよう。

{
  "user_id": 100,
  "user_name": "tkgling",
  "user_email": "[email protected]",
  "created_at": 1617267600,
  "accounts": ["tkgling", "tkgstrator"]
}

このように配列が入っている場合も、構造体のプロパティとして配列を与えてやれば JSONDecoder は自動で変換してくれます。

struct UserInfo: Decodable {
    let userId: Int
    let userName: String
    let userEmail: String
    let createdAt: Date
    let accounts: [String]
}

// 実行結果
UserInfo(userId: 100, userName: "tkgling", userEmail: "[email protected]", createdAt: 2021-04-01 09:00:00 +0000, accounts: ["tkgling", "tkgstrator"])

ちなみに今回は String 型で単純に受け取っていますが、以下のように好きな構造体を割り当てることもできます。

オブジェクト配列#

オブジェクトを配列として持っている場合を考える。

このときは先程とは違い、何番目のアカウントの id や created_at に直接アクセスできるような仕組みになっているとありがたいわけである。

{
  "user_id": 100,
  "user_name": "tkgling",
  "user_email": "[email protected]",
  "created_at": 1617267600,
  "accounts": [
    {
      "id": "tkgling",
      "created_at": 1617267600
    },
    {
      "id": "tkgstrator",
      "created_at": 1617267600
    }
  ]
}

この場合はオブジェクトが配列になっているだけなのだから、次のように構造体を定義すれば良い。

struct UserInfo: Decodable {
    let userId: Int
    let userName: String
    let userEmail: String
    let createdAt: Date
    let accounts: [Account]

    struct Account: Decodable {
        let id: String
        let createdAt: Date
    }
}

UserInfo(userId: 100, userName: "tkgling", userEmail: "[email protected]", createdAt: 2021-04-01 09:00:00 +0000, accounts: [Page_Contents.UserInfo.Account(id: "tkgling", createdAt: 2021-04-01 09:00:00 +0000), Page_Contents.UserInfo.Account(id: "tkgstrator", createdAt: 2021-04-01 09:00:00 +0000)])

オブジェクト#

{
  "user_id": 100,
  "user_name": "tkgling",
  "user_email": "[email protected]",
  "created_at": 1617267600,
  "accounts": {
    "id": "tkgling",
    "created_at": 1617267600
  }
}

ここで少し問題になるのは、ユーザがアカウントを作成していれば確実に情報は入っていますが、アカウントを作成していない場合にはaccountsの中身が想定しているものと変わるケースがあるということです。

// パターン1
// accountsそのものをレスポンスに含まない
{
    "user_id": 100,
    "user_name": "tkgling",
    "user_email": "[email protected]",
    "created_at": 1617267600,
}

// パターン2
// レスポンスに含むが、ないことを示す
{
    "user_id": 100,
    "user_name": "tkgling",
    "user_email": "[email protected]",
    "created_at": 1617267600,
    "accounts": null
}

// パターン3
// レスポンスに含めるが、それぞれのパラメータがないことを示す
{
    "user_id": 100,
    "user_name": "tkgling",
    "user_email": "[email protected]",
    "created_at": 1617267600,
    "accounts": {
        "id": null,
        "created_at": null
    }
}

それぞれについて対応策を考えていきますが、結局はどこのパラメータとしてnilを許容するかという問題になります。

// パターン1, 2の場合
struct UserInfo: Decodable {
    let userId: Int
    let userName: String
    let userEmail: String
    let createdAt: Date
    let accounts: Account? // オプショナル

    struct Account: Decodable {
        let id: String
        let createdAt: Date
    }
}

// 実行結果
UserInfo(userId: 100, userName: "tkgling", userEmail: "[email protected]", createdAt: 2021-04-01 09:00:00 +0000, accounts: nil)

パターン 2 の場合はaccountsにnilが入る可能性があるため、該当部分をオプショナルに変更します。

ちなみに Swift は変数をもったりもたなかったりというようなことが（多分）できないのでパターン 1 の JSON は強制的にパターン 2 と同じデータに変換されます。

// パターン3の場合
struct UserInfo: Decodable {
    let userId: Int
    let userName: String
    let userEmail: String
    let createdAt: Date
    let accounts: Account

    struct Account: Decodable {
        let id: String?
        let createdAt: Date?
    }
}

// 実行結果
UserInfo(userId: 100, userName: "tkgling", userEmail: "[email protected]", createdAt: 2021-04-01 09:00:00 +0000, accounts: Optional(Page_Contents.UserInfo.Account(id: nil, createdAt: nil)))

パターン 3 の場合はaccounts自体はかならずあるが、中身のデータが有るかどうかがわからないのでこうなります。

オブジェクト#

気が狂いそうになるのがこのパターン。Swift は変数名の先頭を数字にできないため、以下のような構造をしていると単純にデータをとってくることができなくなる。

{
  "user_id": 100,
  "user_name": "tkgling",
  "user_email": "[email protected]",
  "created_at": 1617267600,
  "accounts": {
    "1": "tkgling",
    "2": "tkgstrator"
  }
}

このようなケースでは accounts のキーが必要な場合と不要な場合が存在する。今回のケースではキーは順序を保証するためだけの情報なので（Swift の配列は順序が保証されるので）あってもなくてもいいことになる。

ちなみにただデータを取得したいだけであればこう書ける。

struct UserInfo: Decodable {
    let userId: Int
    let userName: String
    let userEmail: String
    let createdAt: Date
    let accounts: [Int: String]
}

// 実行結果
UserInfo(userId: 100, userName: "tkgling", userEmail: "[email protected]", createdAt: 2021-04-01 09:00:00 +0000, accounts: [2: "tkgstrator", 1: "tkgling"])

オブジェクトのオブジェクト#

{
  "user_id": 100,
  "user_name": "tkgling",
  "user_email": "[email protected]",
  "created_at": 1617267600,
  "accounts": {
    "1": {
      "id": "tkgling",
      "created_at": 1617267600
    },
    "2": {
      "id": "tkgstrator",
      "created_at": 1617267600
    }
  }
}

さっきのを更に拡張するとこうなります。JSON では順序がないため順序を保持するために辞書に ID を割り振っているケースがあります。

これはやはり辞書のキーが数字のため単純に置き換えることができません。

これ、未だに自動で Decodable な struct に変換するための書き方がわからないです。

ルートがオブジェクト#

最後にこういうパターンの対応作。

[
  {
    "id": "tkgling",
    "created_at": 1617267600
  },
  {
    "id": "tkgstrator",
    "created_at": 1617267600
  }
]

単にデータをとってきたいだけなら以下のように書けば良い。

let data: [UserInfo] = try decoder.decode([UserInfo].self, from: Data(json.utf8))

struct UserInfo: Decodable {
    let id: String
    let createdAt: Date
}

// 実行結果
[Page_Contents.UserInfo(id: "tkgling", createdAt: 2021-04-01 09:00:00 +0000), Page_Contents.UserInfo(id: "tkgstrator", createdAt: 2021-04-01 09:00:00 +0000)]