Swift 4 Decodable - словарь с enum в качестве ключа

Взгляните на backgrounder и посмотрите, подходит ли оно вашим потребностям.

24
задан Jack 3 November 2017 в 07:05
поделиться

2 ответа

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

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

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

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

Таким образом,

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

будет работать, давая JSON:

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

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

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

Однако, на самом деле я думаю, что Codable соответствие [1120] должно быть способным правильно работать с любым 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: [114], value: try container.decode(Value.self, forKey: [114]))
            }
        )
    }

    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")))
23
ответ дан Hamish 3 November 2017 в 07:05
поделиться

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


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

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"
 */
3
ответ дан Imanou Petit 3 November 2017 в 07:05
поделиться
Другие вопросы по тегам:

Похожие вопросы: