Як можна використовувати Codable Swift для кодування до словника?

Відповіді:

231

Якщо ви не заперечуєте над тим, щоб перенести дані навколо, ви можете використовувати щось подібне:

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, зі словником / масивом

— Кріс Мітчелмор
джерело
22

Ось прості реалізації 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

— Ешлі Міллз
джерело
Дякую велике!, Альтернативою було б використання успадкування, але сайт, що викликає, не міг би вивести тип як словник, оскільки було б 2 функції різних типів повернення.
— користувач1046037
17

Я створив бібліотеку під назвою CodableFirebase, і її початковою метою було використання її з Firebase Database, але вона робить насправді те, що вам потрібно: вона створює словник або будь-який інший тип, як у, JSONDecoderале вам не потрібно робити подвійне перетворення тут як у інших відповідях. Так би виглядало приблизно так:

import CodableFirebase

let model = Foo(a: 1, b: 2)
let dict = try! FirebaseEncoder().encode(model)
— Нообас
джерело
7

Я не впевнений, що це найкращий спосіб, але ви точно можете зробити щось на кшталт:

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)
— Lawliet
джерело
8
Це працювало б лише для структур із усіма властивостями одного типу
— Лео Дабус
1
Я щойно спробував "нехай dict = спробуйте JSONDecoder (). Decode ([String: Int] .self, від: JSONEncoder (). Кодувати (foo))", і я отримав "Очікується розшифрувати словник <String, Any>, але знайшов замість цього масив. " Ви могли б допомогти pls
— Itan Hant
6

Не існує побудованого способу зробити це. Як було сказано вище, якщо у вас немає проблем із продуктивністю, ви можете прийняти позначку 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)

Я намагаюся тут зробити приклад коротшим. У виробничому коді слід поводитися з помилками належним чином.

— 5кілка
джерело
4

У якомусь проекті я використовував швидке роздуми. Але будьте обережні, вкладені кодирувані об'єкти також не відображаються там.

let dict = Dictionary(uniqueKeysWithValues: Mirror(reflecting: foo).children.map{ ($0.label!, $0.value) })
— Микола Капустін
джерело
2

Я, безумовно, думаю, що є деяка цінність у тому, щоб просто використовувати Codableможливість кодування до / зі словників, без наміру ніколи потрапляти на JSON / Plists / що завгодно. Існує безліч API, які просто повертають вам словник або очікують словник, і приємно мати можливість легко обмінюватися ними зі структурами або об'єктами Swift, не потребуючи написання нескінченного кодового коду.

Я розігрувався з деяким кодом на основі джерела Foundation JSONEncoder.swift (який насправді реалізує кодування / декодування словника внутрішньо, але не експортує його).

Код можна знайти тут: https://github.com/elegantchaos/DictionaryCoding

Це все ще досить грубо, але я його трохи розширив, щоб, наприклад, він міг заповнювати пропущені значення зі значеннями за замовчуванням при декодуванні.

— Сем Дін
джерело
2

Я змінив PropertyListEncoder з проекту Swift в DictionaryEncoder, просто видаливши остаточну серіалізацію зі словника у двійковий формат. Ви можете зробити те саме, або ви можете взяти мій код звідси

Його можна використовувати так:

do {
    let employeeDictionary: [String: Any] = try DictionaryEncoder().encode(employee)
} catch let error {
    // handle error
}
— Мармої
джерело
0

Я написав швидку суть, щоб вирішити це (не використовуючи протокол 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)
}
— Сид Мані
джерело
0

Немає прямого способу зробити це в 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)
    }
}
— Краммінг
джерело
0

Тут я створив поділ 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)
    }
}
— Тай Ле
джерело
1
Ваш приклад не показує, як вирішити проблему
— Саймон Мошенко
0

Якщо ви використовуєте SwiftyJSON , ви можете зробити щось подібне:

JSON(data: JSONEncoder().encode(foo)).dictionaryObject

Примітка: Ви також можете передати цей словник як parametersдля запитів Alamofire .

— Якуб Трулахр
джерело
0

Ось рішення на основі протоколу:

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)\"")
}
— спазбіл
джерело
0

Ось словник -> об'єкт. Швидкий 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
        }
    }
}
— Майк Глухов
джерело
-5

Подумайте про це, питання не має відповіді в загальному випадку, оскільки Encodableекземпляр може бути чимось не серіалізаційним у словнику, наприклад, масив:

let payload = [1, 2, 3]
let encoded = try JSONEncoder().encode(payload) // "[1,2,3]"

Крім цього, я написав щось подібне як рамку .

— зул
джерело
Я мушу визнати, що досі не розумію, чому це спростовується :–) Невже застереження не відповідає дійсності? Або рамки не корисні?
— Зуль
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.