Как я могу использовать Codable Swift для кодирования в словарь?
У меня есть структура, которая реализует Swift 4 Codable, Есть ли простой встроенный способ кодирования этой структуры в словарь?
let struct = Foo(a: 1, b: 2)
let dict = something(struct)
// now dict is ["a": 1, "b": 2]
12 ответов
Если вы не возражаете против небольшого смещения данных, вы можете использовать что-то вроде этого:
extension Encodable {
func asDictionary() throws -> [String: Any] {
let data = try JSONEncoder().encode(self)
guard let dictionary = try JSONSerialization.jsonObject(with: data, options: .allowFragments) as? [String: Any] else {
throw NSError()
}
return dictionary
}
}
Или необязательный вариант
extension Encodable {
var dictionary: [String: Any]? {
guard let data = try? JSONEncoder().encode(self) else { return nil }
return (try? JSONSerialization.jsonObject(with: data, options: .allowFragments)).flatMap { $0 as? [String: Any] }
}
}
Если предположить, Foo соответствует Codable или действительно Encodable тогда вы можете сделать это.
let struct = Foo(a: 1, b: 2)
let dict = try struct.asDictionary()
let optionalDict = struct.dictionary
Если хочешь пойти другим путем (init(any)), посмотрите на этот Init объект, соответствующий Codable со словарем / массивом
Вот простые реализации DictionaryEncoder / DictionaryDecoder эта упаковка JSONEncoder, JSONDecoder а также JSONSerialization, которые также обрабатывают стратегии кодирования / декодирования...
class DictionaryEncoder {
private let encoder = JSONEncoder()
var dateEncodingStrategy: JSONEncoder.DateEncodingStrategy {
set { encoder.dateEncodingStrategy = newValue }
get { return encoder.dateEncodingStrategy }
}
var dataEncodingStrategy: JSONEncoder.DataEncodingStrategy {
set { encoder.dataEncodingStrategy = newValue }
get { return encoder.dataEncodingStrategy }
}
var nonConformingFloatEncodingStrategy: JSONEncoder.NonConformingFloatEncodingStrategy {
set { encoder.nonConformingFloatEncodingStrategy = newValue }
get { return encoder.nonConformingFloatEncodingStrategy }
}
var keyEncodingStrategy: JSONEncoder.KeyEncodingStrategy {
set { encoder.keyEncodingStrategy = newValue }
get { return encoder.keyEncodingStrategy }
}
func encode<T>(_ value: T) throws -> [String: Any] where T : Encodable {
let data = try encoder.encode(value)
return try JSONSerialization.jsonObject(with: data, options: .allowFragments) as! [String: Any]
}
}
class DictionaryDecoder {
private let decoder = JSONDecoder()
var dateDecodingStrategy: JSONDecoder.DateDecodingStrategy {
set { decoder.dateDecodingStrategy = newValue }
get { return decoder.dateDecodingStrategy }
}
var dataDecodingStrategy: JSONDecoder.DataDecodingStrategy {
set { decoder.dataDecodingStrategy = newValue }
get { return decoder.dataDecodingStrategy }
}
var nonConformingFloatDecodingStrategy: JSONDecoder.NonConformingFloatDecodingStrategy {
set { decoder.nonConformingFloatDecodingStrategy = newValue }
get { return decoder.nonConformingFloatDecodingStrategy }
}
var keyDecodingStrategy: JSONDecoder.KeyDecodingStrategy {
set { decoder.keyDecodingStrategy = newValue }
get { return decoder.keyDecodingStrategy }
}
func decode<T>(_ type: T.Type, from dictionary: [String: Any]) throws -> T where T : Decodable {
let data = try JSONSerialization.data(withJSONObject: dictionary, options: [])
return try decoder.decode(type, from: data)
}
}
Использование похоже на JSONEncoder / JSONDecoder...
let dictionary = try DictionaryEncoder().encode(object)
а также
let object = try DictionaryDecoder().decode(Object.self, from: dictionary)
Для удобства я положил все это в репозиторий… https://github.com/ashleymills/SwiftDictionaryCoding
Я создал библиотеку с именем CodableFirebase, и ее первоначальная цель состояла в том, чтобы использовать ее с базой данных Firebase, но на самом деле она делает то, что вам нужно: она создает словарь или любой другой тип, как в JSONDecoder но вам не нужно делать двойное преобразование здесь, как в других ответах. Так это будет выглядеть примерно так:
import CodableFirebase
let model = Foo(a: 1, b: 2)
let dict = try! FirebaseEncoder().encode(model)
Нет встроенного способа сделать это. Как указано выше, если у вас нет проблем с производительностью, вы можете принять JSONEncoder + JSONSerialization реализация.
Но я бы предпочел, чтобы стандартная библиотека предоставляла объект кодера / декодера.
class DictionaryEncoder {
private let jsonEncoder = JSONEncoder()
/// Encodes given Encodable value into an array or dictionary
func encode<T>(_ value: T) throws -> Any where T: Encodable {
let jsonData = try jsonEncoder.encode(value)
return try JSONSerialization.jsonObject(with: jsonData, options: .allowFragments)
}
}
class DictionaryDecoder {
private let jsonDecoder = JSONDecoder()
/// Decodes given Decodable type from given array or dictionary
func decode<T>(_ type: T.Type, from json: Any) throws -> T where T: Decodable {
let jsonData = try JSONSerialization.data(withJSONObject: json, options: [])
return try jsonDecoder.decode(type, from: jsonData)
}
}
Вы можете попробовать это с помощью следующего кода:
struct Computer: Codable {
var owner: String?
var cpuCores: Int
var ram: Double
}
let computer = Computer(owner: "5keeve", cpuCores: 8, ram: 4)
let dictionary = try! DictionaryEncoder().encode(computer)
let decodedComputer = try! DictionaryDecoder().decode(Computer.self, from: dictionary)
Я стараюсь сделать пример короче. В рабочем коде вы должны правильно обрабатывать ошибки.
let dict = try JSONSerialization.jsonObject(with: try JSONEncoder().encode(struct), options: []) as? [String: Any]
Я не уверен, что это лучший способ, но вы определенно можете сделать что-то вроде:
struct Foo: Codable {
var a: Int
var b: Int
init(a: Int, b: Int) {
self.a = a
self.b = b
}
}
let foo = Foo(a: 1, b: 2)
let dict = try JSONDecoder().decode([String: Int].self, from: JSONEncoder().encode(foo))
print(dict)
Я изменил PropertyListEncoder из проекта Swift в DictionaryEncoder, просто удалив окончательную сериализацию из словаря в двоичный формат. Вы можете сделать то же самое самостоятельно, или вы можете взять мой код отсюда
Это можно использовать так:
do {
let employeeDictionary: [String: Any] = try DictionaryEncoder().encode(employee)
} catch let error {
// handle error
}
В каком-то проекте я использовал быстрое отражение. Но будьте осторожны, вложенные кодируемые объекты тоже не отображаются там.
let dict = Dictionary(uniqueKeysWithValues: Mirror(reflecting: foo).children.map{ ($0.label!, $0.value) })
Я определенно думаю, что есть возможность просто использовать Codable кодировать в / из словарей, не намереваясь когда-либо нажимать на JSON/Plists/ что угодно. Существует множество API-интерфейсов, которые просто возвращают вам словарь или ожидают словарь, и приятно иметь возможность легко обмениваться ими со структурами или объектами Swift без необходимости писать бесконечный шаблонный код.
Я поиграл с кодом, основанным на исходном коде JSONEncoder.swift Foundation (который на самом деле реализует кодирование / декодирование словаря внутри, но не экспортирует его).
Код можно найти здесь: https://github.com/elegantchaos/DictionaryCoding
Это все еще довольно грубо, но я немного расширил его, чтобы, например, он мог заполнить пропущенные значения значениями по умолчанию при декодировании.
Вот решение на основе протокола:
protocol DictionaryEncodable {
func encode() throws -> Any
}
extension DictionaryEncodable where Self: Encodable {
func encode() throws -> Any {
let jsonData = try JSONEncoder().encode(self)
return try JSONSerialization.jsonObject(with: jsonData, options: .allowFragments)
}
}
protocol DictionaryDecodable {
static func decode(_ dictionary: Any) throws -> Self
}
extension DictionaryDecodable where Self: Decodable {
static func decode(_ dictionary: Any) throws -> Self {
let jsonData = try JSONSerialization.data(withJSONObject: dictionary, options: [])
return try JSONDecoder().decode(Self.self, from: jsonData)
}
}
typealias DictionaryCodable = DictionaryEncodable & DictionaryDecodable
А вот как им пользоваться:
class AClass: Codable, DictionaryCodable {
var name: String
var age: Int
init(name: String, age: Int) {
self.name = name
self.age = age
}
}
struct AStruct: Codable, DictionaryEncodable, DictionaryDecodable {
var name: String
var age: Int
}
let aClass = AClass(name: "Max", age: 24)
if let dict = try? aClass.encode(), let theClass = try? AClass.decode(dict) {
print("Encoded dictionary: \n\(dict)\n\ndata from decoded dictionary: \"name: \(theClass.name), age: \(theClass.age)\"")
}
let aStruct = AStruct(name: "George", age: 30)
if let dict = try? aStruct.encode(), let theStruct = try? AStruct.decode(dict) {
print("Encoded dictionary: \n\(dict)\n\ndata from decoded dictionary: \"name: \(theStruct.name), age: \(theStruct.age)\"")
}
Я написал краткую суть, чтобы справиться с этим (не используя протокол Codable). Будьте осторожны, он не проверяет какие-либо значения и не работает рекурсивно с кодируемыми значениями.
class DictionaryEncoder {
var result: [String: Any]
init() {
result = [:]
}
func encode(_ encodable: DictionaryEncodable) -> [String: Any] {
encodable.encode(self)
return result
}
func encode<T, K>(_ value: T, key: K) where K: RawRepresentable, K.RawValue == String {
result[key.rawValue] = value
}
}
protocol DictionaryEncodable {
func encode(_ encoder: DictionaryEncoder)
}
Вот словарь -> объект. Свифт 5.
extension Dictionary where Key == String, Value: Any {
func object<T: Decodable>() -> T? {
if let data = try? JSONSerialization.data(withJSONObject: self, options: []) {
return try? JSONDecoder().decode(T.self, from: data)
} else {
return nil
}
}
}
Там нет прямого способа сделать это в Codable. Вам нужно реализовать протокол Encodable/Decodable для вашей структуры. Для вашего примера вам может потребоваться написать, как показано ниже
typealias EventDict = [String:Int]
struct Favorite {
var all:EventDict
init(all: EventDict = [:]) {
self.all = all
}
}
extension Favorite: Encodable {
struct FavoriteKey: CodingKey {
var stringValue: String
init?(stringValue: String) {
self.stringValue = stringValue
}
var intValue: Int? { return nil }
init?(intValue: Int) { return nil }
}
func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: FavoriteKey.self)
for eventId in all {
let nameKey = FavoriteKey(stringValue: eventId.key)!
try container.encode(eventId.value, forKey: nameKey)
}
}
}
extension Favorite: Decodable {
public init(from decoder: Decoder) throws {
var events = EventDict()
let container = try decoder.container(keyedBy: FavoriteKey.self)
for key in container.allKeys {
let fav = try container.decode(Int.self, forKey: key)
events[key.stringValue] = fav
}
self.init(all: events)
}
}
Я сделал стручок здесь https://github.com/levantAJ/AnyCodable для облегчения декодирования и кодирования [String: Any] а также [Any]
pod 'DynamicCodable', '1.0'
И вы можете декодировать и кодировать [String: Any] а также [Any]
import DynamicCodable
struct YourObject: Codable {
var dict: [String: Any]
var array: [Any]
var optionalDict: [String: Any]?
var optionalArray: [Any]?
enum CodingKeys: String, CodingKey {
case dict
case array
case optionalDict
case optionalArray
}
init(from decoder: Decoder) throws {
let values = try decoder.container(keyedBy: CodingKeys.self)
dict = try values.decode([String: Any].self, forKey: .dict)
array = try values.decode([Any].self, forKey: .array)
optionalDict = try values.decodeIfPresent([String: Any].self, forKey: .optionalDict)
optionalArray = try values.decodeIfPresent([Any].self, forKey: .optionalArray)
}
func encode(to encoder: Encoder) throws {
var container = encoder.container(keyedBy: CodingKeys.self)
try container.encode(dict, forKey: .dict)
try container.encode(array, forKey: .array)
try container.encodeIfPresent(optionalDict, forKey: .optionalDict)
try container.encodeIfPresent(optionalArray, forKey: .optionalArray)
}
}
После исследования мы обнаружили, что если мы используем ключевое слово Any в классе, унаследованном от Codable & Decodable, это приведет к ошибке. Итак, если вы хотите использовать словарь пользователя с типами данных, поступающих с сервера. Например, сервер отправляет словарь типа [String: Int], затем используйте [String: Int], если вы попробуете [String: Any], это не сработает.
Если вы используете SwiftyJSON, вы можете сделать что-то вроде этого:
JSON(data: JSONEncoder().encode(foo)).dictionaryObject
Примечание. Вы также можете передать этот словарь как
parametersна запросы Alamofire.
Если подумать, у вопроса нет ответа в общем случае, так как Encodable экземпляр может быть чем-то не сериализуемым в словарь, например массивом:
let payload = [1, 2, 3]
let encoded = try JSONEncoder().encode(payload) // "[1,2,3]"
Кроме этого, я написал нечто подобное в качестве основы.