キャメルケースとパスカルケースが入り混じったJSONをCodableで扱う

最近のRestfulなAPIなら無いと思いますが、業務で別の会社がサーバを担当するケースでは稀にそういったクソみたいなAPIにブチ当たる場合があります~~(というか現在進行系でぶち当たってて頭を抱えてる状態😂)~~。

例えばこんな感じ

{
    "ResponseHeader": {
        "status": "0",
        "message": "",
        "validationErrorMessages": []
    },
    "itemList": [
        {
            "name": "hoge"
        }
    ]
}

いやもうResponseHeaderってなんやねんってツッコミは置いといて、
こういうJSONをCodableで扱おうとするとCodingKeyを用意しないといけなくて面倒です。

Response.swift

struct Response: Codable {
    let responseHeader: ResponseHeader
    let itemList: [Item]

    enum CodingKeys: String, CodingKey {
        case responseHeader = "ResponseHeader"
        case itemList
    }
}

しかし、JSONDecoderのkeyDecodingStrategyを使えばなんとかできるのではなかろうかと思って検証してみました。

JSONEncoder.KeyEncodingStrategy.custom(@escaping ([CodingKey]) -> CodingKey)についてはAppleのドキュメントとこの記事が参考になります。
↑を元にまずはResponseKeyを作ります。

ResponseKey.swift

struct ResponseKey: CodingKey, ExpressibleByStringLiteral {
    typealias StringLiteralType = String

    var stringValue: String
    var intValue: Int?

    init(stringLiteral value: String) {
        self.stringValue = value
        self.intValue = nil
    }

    init?(stringValue: String) {
        self.stringValue = stringValue
        self.intValue = nil
    }

    init?(intValue: Int) {
        self.stringValue = String(intValue)
        self.intValue = intValue
    }
}

そしてJSONDecoderをこんな感じで設定してあげます。

decoder.swift

var decoder: JSONDecoder {
    let decoder = JSONDecoder()
    decoder.keyDecodingStrategy = .custom { keys in
        // 先頭文字を小文字にする
        let key = keys.last!.stringValue.lowercasingFirst
        return ResponseKey(stringLiteral: key)
    }
    return decoder
}

こうすることで、このdecoderを使ってデコードするJSONは全てのキーを先頭小文字に変換して扱ってくれるようになります。
つまり、キャメルケースであろうとパスカルケースであろうと問答無用でキャメルケースとして扱うわけです。

これで、上のResponseはCodeingKeyを定義することなく、シンプルに

Response.swift

struct Response: Codable {
    let responseHeader: ResponseHeader
    let itemList: [Item]
}

と書くことができるようになります。

ちなみにJSONDecoder.KeyDecodingStrategy.customで用意するクロージャがなぜ[CodingKey] -> CodingKeyなのかはドキュメントを読んでみてもいまいちピンと来ませんでした。

なぜだ...🤔