在 Swift Codable 中安全使用枚举类型的可靠指南

2023-09-06 22:46:25

在 Swift Codable 中安全地使用枚举

Swift 中的 Codable 协议简化了数据建模和 JSON 处理，但它对枚举类型却隐藏着一种鲜为人知的风险，可能导致意外的解码失败。本文将深入探讨此风险，并提供一种可靠的解决方案，以确保您应用程序的数据处理既健壮又可靠。

枚举类型与 Codable 的风险

枚举类型在 Swift 中很常见，用于表示一组有限的可能值。当使用 Codable 协议将枚举编码为 JSON 时，其原始值（通常是整数）将存储在 JSON 中。解码时，Codable 会尝试将 JSON 中的原始值反序列化为枚举的相应值。

但如果 JSON 中的原始值超出了枚举类型的声明范围，就会发生解码失败。例如，如果一个枚举有三个值：.caseA, .caseB, .caseC，而 JSON 中的原始值为 4，解码器将找不到匹配的值，从而导致失败。

这种失败可能是灾难性的，因为它可能导致应用程序崩溃或产生错误的结果。因此，在处理枚举类型时，规避此风险至关重要。

可靠的解决方案

一种可靠的解决方案是使用关联值来扩展枚举类型。关联值允许枚举类型存储额外数据，在这种情况下，我们可以使用它来存储原始值。修改后的枚举类型如下：

enum MyEnum: String, Codable {
    case caseA
    case caseB
    case caseC

    init(from decoder: Decoder) throws {
        let container = try decoder.singleValueContainer()
        let rawValue = try container.decode(Int.self)
        guard let value = MyEnum(rawValue: rawValue) else {
            throw DecodingError.dataCorruptedError(in: container, debugDescription: "Invalid raw value for MyEnum: \(rawValue)")
        }
        self = value
    }
}