关于Codable协议处理数据实体属性缺省值问题

在软件开发中，我们经常需要处理数据实体，这些数据实体通常通过 JSON 格式进行传输和存储。在 Swift 中，Codable 协议允许我们轻松地将 JSON 数据与数据实体进行相互转换。然而，在实际使用中，我们可能会遇到一些字段在 JSON 中是选填的，但本地的代码逻辑需要兼容这种选填的情况。在这种情况下，我们需要在 JSON 解析时将缺省的属性补上默认值，以保证代码的健壮性。

问题

为了更好地理解这个问题，我们先来看一个简单的例子。假设我们有一个名为 Person 的数据实体，它包含以下属性：

struct Person: Codable {
    let name: String
    let age: Int? // 注意，age 属性是可选的
}

我们从 JSON 文件中读取数据并将其反序列化为 Person 对象。如果 JSON 文件中包含以下内容：

{
  "name": "John Doe"
}

则解析后的 Person 对象将具有以下属性值：

name: "John Doe"
age: nil // 注意，age 属性的值为 nil

显然，由于 JSON 文件中没有提供 age 属性的值，因此解析后的 Person 对象的 age 属性被设置为 nil。这可能会导致我们在使用 age 属性时遇到问题，因为 nil 值可能会导致程序崩溃或产生不正确的结果。

解决方法

为了解决这个问题，我们可以使用 Codable 协议提供的 CodingKeys 枚举来指定哪些属性是可选的。在 Person 结构体中，我们可以添加以下 CodingKeys 枚举：

enum CodingKeys: String, CodingKey {
    case name
    case age = "optional_age" // 注意，我们使用了 "optional_age" 作为 age 属性的键名
}

在 CodingKeys 枚举中，我们将 age 属性的键名设置为 "optional_age"，这表示在 JSON 文件中，age 属性的键名应该是 "optional_age"。在反序列化 JSON 数据时，Codable 协议会自动将 "optional_age" 键名对应的值赋给 age 属性。

如果我们再次从 JSON 文件中读取数据并将其反序列化为 Person 对象，则解析后的 Person 对象将具有以下属性值：

name: "John Doe"
age: nil // 注意，age 属性的值仍然为 nil

虽然 age 属性的值仍然为 nil，但现在我们知道这是因为 JSON 文件中没有提供 age 属性的值，而不是因为解析过程出了问题。

为了给 age 属性设置默认值，我们可以使用 Decodable 协议提供的 init(from decoder: Decoder) 方法。在这个方法中，我们可以使用 decoder 参数来获取 JSON 数据，然后根据需要设置属性的默认值。在 Person 结构体中，我们可以添加以下 init(from decoder: Decoder) 方法：

init(from decoder: Decoder) throws {
    let container = try decoder.container(keyedBy: CodingKeys.self)
    name = try container.decode(String.self, forKey: .name)
    age = try container.decodeIfPresent(Int.self, forKey: .age) ?? 0 // 如果 age 属性不存在，则将默认值设置为 0
}

在 init(from decoder: Decoder) 方法中，我们首先使用 decoder.container(keyedBy: CodingKeys.self) 方法获取 JSON 数据的容器。然后，我们使用 container.decode(String.self, forKey: .name) 方法获取 name 属性的值。对于 age 属性，我们使用 container.decodeIfPresent(Int.self, forKey: .age) ?? 0 方法获取它的值。如果 age 属性不存在，则将默认值设置为 0。

现在，当我们再次从 JSON 文件中读取数据并将其反序列化为 Person 对象时，解析后的 Person 对象将具有以下属性值：

name: "John Doe"
age: 0 // 注意，age 属性的值现在是 0，而不是 nil

总结

通过使用 Codable 协议提供的 CodingKeys 枚举和 init(from decoder: Decoder) 方法，我们可以轻松地处理数据实体属性缺省值的问题。这样，我们就能够确保在 JSON 解析时将缺省的属性补上默认值，从而保证代码的健壮性。