Swift 4 Decodable - словарь с перечислением как ключ

У моей структуры данных есть перечисление в качестве ключа, я бы ожидал, что ниже будет автоматически декодироваться. Это ошибка или проблема с конфигурацией?

import Foundation

enum AnEnum: String, Codable {
  case enumValue
}

struct AStruct: Codable {
  let dictionary: [AnEnum: String]
}

let jsonDict = ["dictionary": ["enumValue": "someString"]]
let data = try! JSONSerialization.data(withJSONObject: jsonDict,     options: .prettyPrinted)
let decoder = JSONDecoder()
do {
  try decoder.decode(AStruct.self, from: data)
} catch {
  print(error)
}

Ошибка, которую я получаю, это, похоже, путает dict с массивом.

typeMismatch (Swift.Array, Swift.DecodingError.Context(codingPath: [Необязательно (__ lldb_expr_85.AStruct. (CodingKeys in _0E2FD0A9B523101D0DCD67578F72D1DD).dictionary)], debugDescription: "Ожидается, что декодирует массив, но вместо этого найдет словарь".))

ОТВЕТЫ

Ответ 1

Проблема в том, что Dictionary Codable соответствие может в настоящее время корректно обрабатывать ключи String и Int. Для словаря с любым другим типом Key (где Key есть Encodable/Decodable), он кодируется и декодируется с помощью неключевого контейнера (массив JSON) со значениями переменных ключей.

Поэтому при попытке декодирования JSON:

{"dictionary": {"enumValue": "someString"}}

в AStruct, ожидается, что значение для ключа "dictionary" будет массивом.

Итак,

let jsonDict = ["dictionary": ["enumValue", "someString"]]

будет работать, что даст JSON:

{"dictionary": ["enumValue", "someString"]}

который затем будет декодирован в:

AStruct(dictionary: [AnEnum.enumValue: "someString"])

Однако, действительно, я думаю, что соответствие Dictionary Codable должно иметь возможность правильно обрабатывать любой CodingKey соответствующий тип как его Key (который может быть AnEnum) - поскольку он может просто кодировать и декодировать в контейнер с ключом с ключом (не стесняйтесь указать ошибку, запрашивая для этого).

До реализации (если вообще) мы всегда можем создать тип оболочки:

struct CodableDictionary<Key : Hashable, Value : Codable> : Codable where Key : CodingKey {

    let decoded: [Key: Value]

    init(_ decoded: [Key: Value]) {
        self.decoded = decoded
    }

    init(from decoder: Decoder) throws {

        let container = try decoder.container(keyedBy: Key.self)

        decoded = Dictionary(uniqueKeysWithValues:
            try container.allKeys.lazy.map {
                (key: $0, value: try container.decode(Value.self, forKey: $0))
            }
        )
    }

    func encode(to encoder: Encoder) throws {

        var container = encoder.container(keyedBy: Key.self)

        for (key, value) in decoded {
            try container.encode(value, forKey: key)
        }
    }
}

а затем выполните так:

enum AnEnum : String, CodingKey {
    case enumValue
}

struct AStruct: Codable {

    let dictionary: [AnEnum: String]

    private enum CodingKeys : CodingKey {
        case dictionary
    }

    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        dictionary = try container.decode(CodableDictionary.self, forKey: .dictionary).decoded
    }

    func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(CodableDictionary(dictionary), forKey: .dictionary)
    }
}

(или просто иметь свойство Dictionary типа CodableDictionary<AnEnum, String> и использовать автогенерированное соответствие Codable), а затем просто говорить в терминах dictionary.decoded)

Теперь мы можем декодировать вложенный объект JSON, как и ожидалось:

let data = """
{"dictionary": {"enumValue": "someString"}}
""".data(using: .utf8)!

let decoder = JSONDecoder()
do {
    let result = try decoder.decode(AStruct.self, from: data)
    print(result)
} catch {
    print(error)
}

// AStruct(dictionary: [AnEnum.enumValue: "someString"])

Хотя все сказанное можно утверждать, что все, что вы достигаете со словарем с enum в качестве ключа, это просто struct с дополнительными свойствами (и если вы ожидаете, что заданное значение всегда будет там, сделайте это необязательным).

Поэтому вы можете просто хотеть, чтобы ваша модель выглядела так:

struct BStruct : Codable {
    var enumValue: String?
}

struct AStruct: Codable {

    private enum CodingKeys : String, CodingKey {
        case bStruct = "dictionary"
    }

    let bStruct: BStruct
}

Что будет работать с вашим текущим JSON:

let data = """
{"dictionary": {"enumValue": "someString"}}
""".data(using: .utf8)!

let decoder = JSONDecoder()
do {
    let result = try decoder.decode(AStruct.self, from: data)
    print(result)
} catch {
    print(error)
}

// AStruct(bStruct: BStruct(enumValue: Optional("someString")))

Ответ 2

Чтобы решить вашу проблему, вы можете использовать один из двух следующих фрагментов кода площадки.

# 1. Использование Decodable init(from:) инициализатора

import Foundation

enum AnEnum: String, Codable {
    case enumValue
}

struct AStruct {
    enum CodingKeys: String, CodingKey {
        case dictionary
    }
    enum EnumKeys: String, CodingKey {
        case enumValue
    }

    let dictionary: [AnEnum: String]
}

extension AStruct: Decodable {

    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        let dictContainer = try container.nestedContainer(keyedBy: EnumKeys.self, forKey: .dictionary)

        var dictionary = [AnEnum: String]()
        for enumKey in dictContainer.allKeys {
            guard let anEnum = AnEnum(rawValue: enumKey.rawValue) else {
                let context = DecodingError.Context(codingPath: [], debugDescription: "Could not parse json key to an AnEnum object")
                throw DecodingError.dataCorrupted(context)
            }
            let value = try dictContainer.decode(String.self, forKey: enumKey)
            dictionary[anEnum] = value
        }
        self.dictionary = dictionary
    }

}

Использование:

let jsonString = """
{
  "dictionary" : {
    "enumValue" : "someString"
  }
}
"""

let data = jsonString.data(using: String.Encoding.utf8)!
let decoder = JSONDecoder()
let aStruct = try! decoder.decode(AStruct.self, from: data)
dump(aStruct)

/*
 prints:
 ▿ __lldb_expr_148.AStruct
   ▿ dictionary: 1 key/value pair
     ▿ (2 elements)
       - key: __lldb_expr_148.AnEnum.enumValue
       - value: "someString"
 */

# 2. Используя метод KeyedDecodingContainerProtocol decode(_:forKey:)

import Foundation

public enum AnEnum: String, Codable {
    case enumValue
}

struct AStruct: Decodable {
    enum CodingKeys: String, CodingKey {
        case dictionary
    }

    let dictionary: [AnEnum: String]
}

public extension KeyedDecodingContainer  {

    public func decode(_ type: [AnEnum: String].Type, forKey key: Key) throws -> [AnEnum: String] {
        let stringDictionary = try self.decode([String: String].self, forKey: key)
        var dictionary = [AnEnum: String]()

        for (key, value) in stringDictionary {
            guard let anEnum = AnEnum(rawValue: key) else {
                let context = DecodingError.Context(codingPath: codingPath, debugDescription: "Could not parse json key to an AnEnum object")
                throw DecodingError.dataCorrupted(context)
            }
            dictionary[anEnum] = value
        }

        return dictionary
    }

}

Использование:

let jsonString = """
{
  "dictionary" : {
    "enumValue" : "someString"
  }
}
"""

let data = jsonString.data(using: String.Encoding.utf8)!
let decoder = JSONDecoder()
let aStruct = try! decoder.decode(AStruct.self, from: data)
dump(aStruct)

/*
 prints:
 ▿ __lldb_expr_148.AStruct
   ▿ dictionary: 1 key/value pair
     ▿ (2 elements)
       - key: __lldb_expr_148.AnEnum.enumValue
       - value: "someString"
 */