Сделать класс, соответствующий Codable по умолчанию в Swift - PullRequest
Новая
       37

Сделать класс, соответствующий Codable по умолчанию в Swift

0 голосов
/ 31 августа 2018

Такая функция Swift, как Codable (Decodable & Encodable) очень полезна. Но я нашел такую ​​проблему: Пусть у нас есть класс Parent, соответствующий Codable: 

class Parent: Codable {
    var name: String
    var email: String?
    var password: String?
}

Хорошо, этот класс соответствует протоколу Codable «из коробки», вам не нужно писать инициализаторы, он готов к инициализации из JSON следующим образом: 

{ "name": "John", "email": "johndoe@yahoo.com", "password": <null>}

Но, скажем, нам нужен другой класс, Child наследует от Parent и соответствует Codable: 

class Child: Parent {
   var token: String
   var date: Date?
}

поэтому класс Child должен соответствовать Codable в соответствии с Parent, НО свойства класса Child не будут правильно инициализированы из JSON. Решение, которое я нашел, это написать все кодируемые вещи для класса Child самостоятельно, например: 

class Child: Parent {
    var token: String
    var date : Date?

    enum ChildKeys: CodingKey {
        case token, date
    }

    required init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: ChildKeys.self)
        self.token = try container.decode(String.self, forKey: .token)
        self.date = try container.decodeIfPresent(Date.self, forKey: .date)
    }

    override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: ChildKeys.self)
        try container.encode(self.token, forKey: .token)
        try container.encodeIfPresent(self.date, forKey: .date)
    }
}

Но я чувствую, что это не может быть правильно, я что-то пропустил? Как сделать, чтобы класс Child соответствовал Codable должным образом без написания всего этого?

1 Ответ

0 голосов
/ 31 августа 2018

Вот хороший пост в блоге, который включает ответ на ваш вопрос: источник

Прокрутите вниз до наследования, и вы увидите следующее:

Предполагая, что у нас есть следующие классы: 

class Person : Codable {
    var name: String?
}

class Employee : Person {
    var employeeID: String?
}

Мы получаем соответствие Codable путем наследования от класса Person, но что произойдет, если мы попытаемся закодировать экземпляр Employee? 

let employee = Employee()
employee.employeeID = "emp123"
employee.name = "Joe"

let encoder = JSONEncoder()
encoder.outputFormatting = .prettyPrinted
let data = try! encoder.encode(employee)
print(String(data: data, encoding: .utf8)!)

{
  "name" : "Joe"
}

Это не ожидаемый результат, поэтому мы должны добавить пользовательскую реализацию, подобную этой: 

class Person : Codable {
    var name: String?

    private enum CodingKeys : String, CodingKey {
        case name
    }

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

Та же история для подкласса: 

class Employee : Person {
    var employeeID: String?

    private enum CodingKeys : String, CodingKey {
        case employeeID = "emp_id"
    }

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

Результат будет: 

{
  "emp_id" : "emp123"
}

Что опять-таки не является ожидаемым результатом, поэтому здесь мы используем наследование , вызывая super . 

// Employee.swift
    override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encode(employeeID, forKey: .employeeID)
    }

Что в итоге дает нам то, чего мы действительно хотели с самого начала: 

{
    "name": "Joe",
    "emp_id": "emp123"
}

Если вас не устраивает сглаженный результат, есть совет, как этого избежать.

Все благодарности парню, который написал пост в блоге, и мое спасибо. Надеюсь, это поможет вам, ура!

...