Swiftの構造体に自分で定義したenum型があるとうまくデコードできない→解決

自分で定義したenum型が含まれているstructをJSONからデコードする方法で少し悩んだので、解決方法を共有します。

Type 'Character' does not conform to protocol 'Decodable'

次のように、Characterというstructの中にStatusというenum型のプロパティを定義した場合に、Type 'Character' does not conform to protocol 'Decodable'というエラーが出てビルドができない。なんでだ！と悩みました。

enum Status {
case normal
case sleep
case confuse
}

struct Character: Decodable {
let name: String
let attack: Int
let defence: Int
let status: Status
}

自分で定義したenum型もDecodableにする

上述のビルドエラーを解消するには、StatusにDecodableを継承させます。

import Foundation

enum Status: Decodable {
case normal
case sleep
case confuse
}

struct Character: Decodable {
let name: String
let attack: Int
let defence: Int
let status: Status
}

Decodableとして定義したstructに含まれるプロパティもまた、Decodableを実装している必要があるというルールによるものです。

デコード時にエラー

StatusにDecodableを継承させることでビルドエラーは消えますが、実際にJSONDecoderなどを使ってデコードしてみると、うまくいきません。

let json = """
{
"name": "jimaru",
"attack": 2,
"defence": 3,
"status": "sleep"
}
""".data(using: .utf8)!

let decoder = JSONDecoder()
let character = try! decoder.decode(Character.self, from: json)
// 次のエラーが発生：
// 'try!' expression unexpectedly raised an error:
// Swift.DecodingError.typeMismatch(Swift.Dictionary,
// Swift.DecodingError.Context(
// codingPath: [CodingKeys(stringValue: "status", intValue: nil)],
// debugDescription: "Expected to decode Dictionary but found a string instead.",
// underlyingError: nil))

これはJSON内のstatusのデータが何であったらStatus.normalとしてデコードするのか、Status.sleepとしてデコードするのか、という情報が不足しているためです。

StatusのrawValueを文字列で設定すれば、このrawValueの値からデコードしてくれるようになります。

enum Status: String, Decodable {
case normal = "normal"
case sleep = "sleep"
case confuse = "confuse"
}

rawValueについてのドキュメントはThe Swift Programming Language > Enumerations > Raw Valuesです。