允许 JSONDecoder() 接受空数组作为空字典答案

【问题标题】：Allow JSONDecoder() to accept empty array as empty dictionary允许 JSONDecoder() 接受空数组作为空字典
【发布时间】：2019-10-16 01:47:05
【问题描述】：

鉴于此结构：

public struct Error: Codable {
    public let code: String
    public let message: String
    public let params: [String: String]?
}

还有这个 JSON：

[
  {
    "message" : "The requested user could not be found.",
    "params" : [],
    "code" : "requested_user_not_found"
  }
]

有没有办法在 Swift 中使用 JSONDecoder() 类对此进行解码？ params 键应该是一个字典，但由于生成此 JSON 的外部 API 的实现方式（在 PHP 中），空字典在 JSON 中呈现为空数组。

目前，尝试将提供的 JSON 解码为提供的结构的实例会引发错误。

【问题讨论】：

要将params 存储为字典还是数组？

标签： ios json swift

【解决方案1】：

首先，PHP 不需要这样做，因此如果可能，应该更正 PHP。 PHP 中表示“空对象”的方式是new \stdClass()。 Elastic has a nice explanation.

也就是说，如果您无法更正服务器，您可以在客户端进行修复。这里的许多答案都是基于尝试解码该值，如果失败则假设它是一个空数组。这行得通，但这意味着意外的 JSON 不会产生好的错误。相反，我会将这个问题提取到一个函数中：

/// Some PHP developers emit [] to indicate empty object rather than using stdClass().
/// This returns a default value in that case.
extension KeyedDecodingContainer {
    func decodePHPObject<T>(_ type: T.Type, forKey key: Key, defaultValue: T) throws -> T
        where T : Decodable
    {
        // Sadly neither Void nor Never conform to Decodable, so we have to pick a random type here, String.
        // The nicest would be to decode EmptyCollection, but that also doesn't conform to Decodable.
        if let emptyArray = try? decode([String].self, forKey: key), emptyArray.isEmpty {
            return defaultValue
        }

        return try decode(T.self, forKey: key)
    }

    // Special case the common dictionary situation.
    func decodePHPObject<K, V>(_ type: [K: V].Type, forKey key: Key) throws -> [K: V]
        where K: Codable, V: Codable
    {
        return try decodePHPObject([K:V].self, forKey: key, defaultValue: [:])
    }
}

这提供了一个.decodePHPObject(_:forKey:) 方法，您可以在自定义解码器中使用该方法。

public struct ErrorValue: Codable {
    public let code: String
    public let message: String
    public let params: [String: String]

    public init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        self.code = try container.decode(String.self, forKey: .code)
        self.message = try container.decode(String.self, forKey: .message)

        // And use our new decodePHPObject.
        self.params = try container.decodePHPObject([String: String].self, forKey: .params)
    }
}

（我已重命名此 ErrorValue 以消除与 stdlib 类型 Error 的冲突，并且我已将 params 设为非可选，因为您通常不应该有可选集合，除非“空”将与 nil 区别对待。）

【讨论】：

【解决方案2】：

尝试下面的 sn-p，在这里您将尝试将参数解码为字典。如果失败，我们将为其分配一个空字典。

public struct Error: Codable {
    public let code: String
    public let message: String
    public let params: [String:String]

    public init(from decoder: Decoder) throws {
        let keyedContainer = try decoder.container(keyedBy: CodingKeys.self)

        self.code = try keyedContainer.decode(String.self, forKey: .code)
        self.message = try keyedContainer.decode(String.self, forKey: .message)
        if let params = try? keyedContainer.decodeIfPresent([String: String].self, forKey: .params) {
            self.params = params
        } else {
            self.params = [:]
        }
    }
}

希望这会有所帮助。

【讨论】：