在Swift中默认使类符合Codable

时间:2018-08-31 13:05:39

标签: json swift inheritance codable

Swift作为CodableDecodableEncodable)协议的这种功能非常有用。 但是我发现了这样的问题: 让我们让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?
}

因此,子类别必须通过符合父项来符合Codable, 无法从JSON正确初始化Child类的BUT属性。 我发现的决定是自己为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 :(得分:4)

这是一篇不错的博客文章,其中包含您的问题的答案: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"
}

如果您对展平的结果不满意,那么也有一些技巧来避免这种情况。

所有致谢撰写博客文章的人和我的感谢。 希望它也对您有帮助,加油!