json - 在 Swift 中使类默认符合 Codable

Question

Swift 的Codable (Decodable&Encodable) 协议(protocol)非常有用。但是我发现了这样的问题:让我们有符合 Codable 的 Parent 类:

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

好的，该类“开箱即用”地符合 Codable 协议(protocol)，您不需要编写任何初始化程序，它已准备好从 JSON 中初始化，如下所示:

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

但是假设我们需要其他类，Child 继承自 Parent 并符合 Codable:

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

所以类 Child 必须通过符合 Parent 来符合 Codable，但是类 Child 的属性不会从 JSON 正确初始化。我发现的决定是自己为 Child 类编写所有 Codable 内容，例如:

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？

Answer 1

这是一篇很好的博客文章，其中包含对您问题的回答:source

向下滚动到继承，您将看到以下内容:

假设我们有以下类:

class Person : Codable {
    var name: String?
}

class Employee : Person {
    var employeeID: String?
}

我们通过从 Person 类继承来获得 Codable 一致性，但是如果我们尝试对 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"
}

如果您对扁平化的结果不满意，这里也有关于如何避免这种情况的提示。

所有的功劳都归功于写这篇博文的人，我非常感谢。希望对你也有帮助，干杯!