enum DecodableをSwift 4で作成するにはどうすればよいですか?


157
enum PostType: Decodable {

    init(from decoder: Decoder) throws {

        // What do i put here?
    }

    case Image
    enum CodingKeys: String, CodingKey {
        case image
    }
}

これを完了するには何を入れますか?また、私がこれcaseをこれに変更したとしましょう:

case image(value: Int)

これをDecodableに準拠させるにはどうすればよいですか?

EDitこれが私の完全なコードです(機能しません)

let jsonData = """
{
    "count": 4
}
""".data(using: .utf8)!

        do {
            let decoder = JSONDecoder()
            let response = try decoder.decode(PostType.self, from: jsonData)

            print(response)
        } catch {
            print(error)
        }
    }
}

enum PostType: Int, Codable {
    case count = 4
}

最終編集 また、このような列挙型をどのように処理しますか?

enum PostType: Decodable {
    case count(number: Int)
}

回答:


262

それはとても簡単、ちょうど使用していますStringか、Int暗黙的に割り当てられている生の値を。

enum PostType: Int, Codable {
    case image, blob
}

image符号化されている0blobします1

または

enum PostType: String, Codable {
    case image, blob
}

image符号化されている"image"blobします"blob"


これは使い方の簡単な例です:

enum PostType : Int, Codable {
    case count = 4
}

struct Post : Codable {
    var type : PostType
}

let jsonString = "{\"type\": 4}"

let jsonData = Data(jsonString.utf8)

do {
    let decoded = try JSONDecoder().decode(Post.self, from: jsonData)
    print("decoded:", decoded.type)
} catch {
    print(error)
}

1
あなたが提案したコードを試しましたが、うまくいきません。自分がデコードしようとしているJSONを表示するようにコードを編集しました
swift nub

8
列挙型のみをエンコード/デコードすることはできません。構造体に埋め込む必要があります。例を追加しました。
バディアン

これに正しいフラグを付けます。しかし、上記の質問で答えられなかった最後の部分がありました。私の列挙型がこのようになった場合はどうなりますか?(上記で編集)
迅速なナブ2017年

関連するタイプの列挙型を使用している場合は、カスタムのエンコードおよびデコードメソッドを記述する必要があります。カスタムタイプのエンコードおよびデコード
vadian

1
「enumを単独でデコード/デコードすることはできません。」については、で解決されているようiOS 13.3です。とでテストしましたがiOS 13.3iOS 12.4.3動作が異なります。の下ではiOS 13.3、列挙型はen- / decodedのみで使用できます。
AechoLiu

111

関連する型を持つ列挙型を準拠させる方法 Codable

この回答は@Howard Lovattの回答に似ていますが、PostTypeCodableForm構造体の作成を避け、代わりにAppleが提供するKeyedEncodingContainer型をandのプロパティとして使用するため、ボイラープレートが削減されます。EncoderDecoder

enum PostType: Codable {
    case count(number: Int)
    case title(String)
}

extension PostType {

    private enum CodingKeys: String, CodingKey {
        case count
        case title
    }

    enum PostTypeCodingError: Error {
        case decoding(String)
    }

    init(from decoder: Decoder) throws {
        let values = try decoder.container(keyedBy: CodingKeys.self)
        if let value = try? values.decode(Int.self, forKey: .count) {
            self = .count(number: value)
            return
        }
        if let value = try? values.decode(String.self, forKey: .title) {
            self = .title(value)
            return
        }
        throw PostTypeCodingError.decoding("Whoops! \(dump(values))")
    }

    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        switch self {
        case .count(let number):
            try container.encode(number, forKey: .count)
        case .title(let value):
            try container.encode(value, forKey: .title)
        }
    }
}

このコードはXcode 9b3で動作します。

import Foundation // Needed for JSONEncoder/JSONDecoder

let encoder = JSONEncoder()
encoder.outputFormatting = .prettyPrinted
let decoder = JSONDecoder()

let count = PostType.count(number: 42)
let countData = try encoder.encode(count)
let countJSON = String.init(data: countData, encoding: .utf8)!
print(countJSON)
//    {
//      "count" : 42
//    }

let decodedCount = try decoder.decode(PostType.self, from: countData)

let title = PostType.title("Hello, World!")
let titleData = try encoder.encode(title)
let titleJSON = String.init(data: titleData, encoding: .utf8)!
print(titleJSON)
//    {
//        "title": "Hello, World!"
//    }
let decodedTitle = try decoder.decode(PostType.self, from: titleData)

私はこの答えが大好きです!注意として、この例はEitherコード化可能にすることに関するobjc.ioの投稿に
Ben Leggiero

最良の答え
Peter

38

.dataCorrupted不明な列挙値が検出されると、Swiftはエラーをスローします。データがサーバーからのものである場合、いつでも不明な列挙値を送信する可能性があります(バグサーバー側、APIバージョンに新しいタイプが追加され、以前のバージョンのアプリでケースを適切に処理するなど)。準備を整えて、列挙型を安全にデコードできるように「防御スタイル」をコーディングしてください。

関連する値の有無にかかわらず、これを行う方法の例を以下に示します

    enum MediaType: Decodable {
       case audio
       case multipleChoice
       case other
       // case other(String) -> we could also parametrise the enum like that

       init(from decoder: Decoder) throws {
          let label = try decoder.singleValueContainer().decode(String.self)
          switch label {
             case "AUDIO": self = .audio
             case "MULTIPLE_CHOICES": self = .multipleChoice
             default: self = .other
             // default: self = .other(label)
          }
       }
    }

そしてそれを囲んでいる構造体でどのように使用するか:

    struct Question {
       [...]
       let type: MediaType

       enum CodingKeys: String, CodingKey {
          [...]
          case type = "type"
       }


   extension Question: Decodable {
      init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         [...]
         type = try container.decode(MediaType.self, forKey: .type)
      }
   }

1
おかげで、あなたの答えははるかに理解しやすくなりました。
DazChong 2018

1
この回答は私にも役立ちました。enumを文字列から継承させることで改善でき、文字列を切り替える必要がありません
Gobe

27

@Tokaの答えを拡張するには、生の表現可能な値を列挙型に追加し、デフォルトのオプションのコンストラクターを使用して、switch:なしで列挙型を構築することもできます。

enum MediaType: String, Decodable {
  case audio = "AUDIO"
  case multipleChoice = "MULTIPLE_CHOICES"
  case other

  init(from decoder: Decoder) throws {
    let label = try decoder.singleValueContainer().decode(String.self)
    self = MediaType(rawValue: label) ?? .other
  }
}

コンストラクタをリファクタリングできるカスタムプロトコルを使用して拡張できます。

protocol EnumDecodable: RawRepresentable, Decodable {
  static var defaultDecoderValue: Self { get }
}

extension EnumDecodable where RawValue: Decodable {
  init(from decoder: Decoder) throws {
    let value = try decoder.singleValueContainer().decode(RawValue.self)
    self = Self(rawValue: value) ?? Self.defaultDecoderValue
  }
}

enum MediaType: String, EnumDecodable {
  static let defaultDecoderValue: MediaType = .other

  case audio = "AUDIO"
  case multipleChoices = "MULTIPLE_CHOICES"
  case other
}

また、デフォルトの値ではなく、無効な列挙値が指定された場合にエラーをスローするように簡単に拡張できます。この変更の要旨は、https//gist.github.com/stephanecopin/4283175fabf6f0cdaf87fef2a00c8128から入手できます
コードは、Swift 4.1 / Xcode 9.3を使用してコンパイルおよびテストされました。


1
これが私が探していた答えです。
Nathan Hosselton 2018年

7

より簡潔な@proxperoの応答の変形は、デコーダーを次のように定式化することです。

public init(from decoder: Decoder) throws {
    let values = try decoder.container(keyedBy: CodingKeys.self)
    guard let key = values.allKeys.first else { throw err("No valid keys in: \(values)") }
    func dec<T: Decodable>() throws -> T { return try values.decode(T.self, forKey: key) }

    switch key {
    case .count: self = try .count(dec())
    case .title: self = try .title(dec())
    }
}

func encode(to encoder: Encoder) throws {
    var container = encoder.container(keyedBy: CodingKeys.self)
    switch self {
    case .count(let x): try container.encode(x, forKey: .count)
    case .title(let x): try container.encode(x, forKey: .title)
    }
}

これにより、コンパイラーはケースを徹底的に検証でき、エンコードされた値がキーの期待値と一致しない場合のエラーメッセージも抑制されません。


私はこれがより良いことに同意します。
proxpero

6

実際、上記の回答は本当に素晴らしいですが、継続的に開発されているクライアント/サーバープロジェクトで多くの人々が必要とする詳細の一部が欠けています。バックエンドが時間の経過とともに継続的に進化する間にアプリを開発します。これは、一部の列挙型ケースがその進化を変えることを意味します。したがって、未知のケースを含む列挙型の配列をデコードできる列挙型デコード戦略が必要です。それ以外の場合、配列を含むオブジェクトのデコードは単に失敗します。

私がしたことは非常に簡単です:

enum Direction: String, Decodable {
    case north, south, east, west
}

struct DirectionList {
   let directions: [Direction]
}

extension DirectionList: Decodable {

    public init(from decoder: Decoder) throws {

        var container = try decoder.unkeyedContainer()

        var directions: [Direction] = []

        while !container.isAtEnd {

            // Here we just decode the string from the JSON which always works as long as the array element is a string
            let rawValue = try container.decode(String.self)

            guard let direction = Direction(rawValue: rawValue) else {
                // Unknown enum value found - ignore, print error to console or log error to analytics service so you'll always know that there are apps out which cannot decode enum cases!
                continue
            }
            // Add all known enum cases to the list of directions
            directions.append(direction)
        }
        self.directions = directions
    }
}

おまけ:実装を隠す>コレクションにする

実装の詳細を隠すことは常に良い考えです。そのためには、もう少しコードが必要になります。秘訣は、内部配列に準拠DirectionsListしてプライベートにすることです。Collectionlist

struct DirectionList {

    typealias ArrayType = [Direction]

    private let directions: ArrayType
}

extension DirectionList: Collection {

    typealias Index = ArrayType.Index
    typealias Element = ArrayType.Element

    // The upper and lower bounds of the collection, used in iterations
    var startIndex: Index { return directions.startIndex }
    var endIndex: Index { return directions.endIndex }

    // Required subscript, based on a dictionary index
    subscript(index: Index) -> Element {
        get { return directions[index] }
    }

    // Method that returns the next index when iterating
    func index(after i: Index) -> Index {
        return directions.index(after: i)
    }
}

あなたはジョンSundellことで、このブログの記事にカスタムコレクションに準拠についてもっと読むことができます:https://medium.com/@johnsundell/creating-custom-collections-in-swift-a344e25d0bb0


5

あなたがしたいことをすることができますが、それは少し複雑です:(

import Foundation

enum PostType: Codable {
    case count(number: Int)
    case comment(text: String)

    init(from decoder: Decoder) throws {
        self = try PostTypeCodableForm(from: decoder).enumForm()
    }

    func encode(to encoder: Encoder) throws {
        try PostTypeCodableForm(self).encode(to: encoder)
    }
}

struct PostTypeCodableForm: Codable {
    // All fields must be optional!
    var countNumber: Int?
    var commentText: String?

    init(_ enumForm: PostType) {
        switch enumForm {
        case .count(let number):
            countNumber = number
        case .comment(let text):
            commentText = text
        }
    }

    func enumForm() throws -> PostType {
        if let number = countNumber {
            guard commentText == nil else {
                throw DecodeError.moreThanOneEnumCase
            }
            return .count(number: number)
        }
        if let text = commentText {
            guard countNumber == nil else {
                throw DecodeError.moreThanOneEnumCase
            }
            return .comment(text: text)
        }
        throw DecodeError.noRecognizedContent
    }

    enum DecodeError: Error {
        case noRecognizedContent
        case moreThanOneEnumCase
    }
}

let test = PostType.count(number: 3)
let data = try JSONEncoder().encode(test)
let string = String(data: data, encoding: .utf8)!
print(string) // {"countNumber":3}
let result = try JSONDecoder().decode(PostType.self, from: data)
print(result) // count(3)

興味深いハック
Roman Filippov
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.