Swift Codable 编码解码，自定义数据类型编码规则

2023-10-20 01:18:31

自定义 Swift Codable 类型：深入探索

在 Swift 中，Codable 协议为编码和解码自定义类型提供了便利。但是，有时您可能需要超越内置功能，自定义编码和解码规则以满足特定的业务需求。本文将深入探讨自定义 Codable 类型的步骤、技术和最佳实践，帮助您应对各种编码和解码场景。

自定义 Codable 类型的步骤

自定义 Codable 类型涉及三个关键步骤：

定义 Codable 类型： 声明一个遵守 Codable 协议的类型，该类型包含您需要编码和解码的属性。
实现 encode(to:) 方法： 定义将类型编码为 JSON 数据的规则。
实现 init(from:) 方法： 定义将 JSON 数据解码为类型的规则。

自定义编码和解码规则

自定义规则允许您对编码和解码过程进行更细粒度的控制。以下是一些可用的技术：

使用 Property Wrapper： 利用 Property Wrapper 在编译时定制属性的行为，包括编码和解码规则。
使用 Key Coding： 直接访问和操作编码或解码过程中使用的键。
使用 KeyPath： 访问和操作属性的路径，简化属性的编码和解码。
使用 FailableInitializer： 在初始化类型时指定失败条件，确保数据的完整性。
使用 Mutating： 修改类型的属性，在编码或解码过程中执行特定操作。
使用 Subscript： 访问和操作类型的下标，处理复杂数据结构。
使用 AssociatedType： 定义与类型相关的附加类型，增强编码和解码的灵活性。
使用 Protocols： 建立类型行为的规则，统一编码和解码过程。

技巧和示例

为了帮助您充分利用自定义 Codable 类型，这里有一些有用的技巧和示例：

使用 @JSONKey 属性包装器指定 JSON 键名称：

struct Person: Codable {
    @JSONKey("person_name") var name: String
    @JSONKey("person_age") var age: Int
}

使用 KeyPath 访问属性路径：

struct Address: Codable {
    let street: String
    let city: String
}

struct Person: Codable {
    let name: String
    let address: Address
    
    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        name = try container.decode(String.self, forKey: \.name)
        address = try container.decode(Address.self, forKey: \.address)
    }

使用 FailableInitializer 指定失败条件：

struct Temperature: Codable {
    let value: Double
    
    init(from decoder: Decoder) throws {
        let container = try decoder.singleValueContainer()
        value = try container.decode(Double.self)
        guard value >= -273.15 else {
            throw DecodingError.dataCorruptedError(in: container, debugDescription: "Temperature cannot be below absolute zero")
        }
    }