Swift JSON如何解码空对象

发布于04月09日

我正在解码来自API的响应，当我有期望的数据时，它就可以工作. 但是服务器通常会以{}或{}\n来响应，这是一个空对象.这是意料之中的.

在try 解码预期数据之前，我希望捕捉这些响应.

我采用了下面的方案，但我觉得应该有一种更有原则的方法来解码空json对象.

    let empty1 = "{}".data(using: .utf8)!
    let empty2 = "{}\n".data(using: .utf8)!

    let (data, response) = try await URLSession.shared.data(for: request)
    if data == empty1 || data == empty2 {
        print("empty json response")
        return nil
    }

    // what I would like to do
    let decoded = try JSONDecoder().decode(xxxx, from: data)  // what to decode here
    
    // how to test for emptyness

我还可以比较数据的String表示，但这与我当前的方案是一样的.

推荐答案

我假设您希望JSONDecoder().decode调用在数据不为空时抛出一个错误.你可以通过

创建一个自定义编码密钥，可以代表JSON中的任何密钥
得到由上述键控的键控解码容器
判断解码容器是否包含任何密钥—如果包含，则JSON不为空.

struct EmptyJSON: Decodable {
    struct AnyKey: CodingKey {
        var stringValue: String
        
        init?(stringValue: String) {
            self.stringValue = stringValue
        }
        
        var intValue: Int?
        
        init?(intValue: Int) {
            self.intValue = intValue
            self.stringValue = "\(intValue)"
        }
        
    }
    
    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: AnyKey.self)
        if !container.allKeys.isEmpty {
            throw CustomDecodingError.shouldBeEmpty
        }
    }

    enum CustomDecodingError: Error {
        case shouldBeEmpty
    }
}

然后你可以这样做:

if let decoded = try? JSONDecoder().decode(EmptyJSON.self, from: data) {
    // JSON is empty
} else {
    // JSON is not empty
}

这也会将JSON数组视为"空".您可以捕获特定错误以获得更多的控制

do {
    try JSONDecoder().decode(EmptyJSON.self, from: data)
    // empty object
} catch EmptyJSON.CustomDecodingError.shouldBeEmpty {
    // non-empty object
} catch {
    // something else, e.g. array (both empty and non-empty), string, number
}