ios - 如何在 Swift 4 中验证 JSON？

Question

有一个 API，它将其响应包装在一个具有 status 值和 data 值的关联数组中，其中 data 包含错误对象，或预期值:

不良 react :

{
   "status":"error",
   "data":{  
      "errormessage":"Duplicate entry '101' for key 'PRIMARY'",
      "errorcode":1062
   }
}

成功响应:

{
   "status":"success",
   "data":{  
      "user": {
        "id": 1,
      }
   }
}

我想验证这些响应:

public class func validateResponse(_ data : Data) -> WebServicesError?
{
    struct WTPResponse : Decodable
    {
        let status : String
        let data : Data
    }

    do {
        let response = try JSONDecoder().decode(WTPResponse.self, from: data) // FAILS HERE
        if let wtpError = try? JSONDecoder().decode(WTPAPIError.self, from: response.data) {
            return WebServicesError.wtpError(WTPAPIError(code: wtpError.code, message: wtpError.message))
        }
    }
    catch let error {
        return WebServicesError.init(error: error)
    }

    return nil
}

尝试解码响应对象时总是失败，出现错误:Expected to decode Data but found a dictionary instead. 我在想我可以解码数据对象作为 Swift 类型 Data，但它实际上是一个 [String: Any] 字典。

1) 如何验证从 API 收到的数据？

2) 有没有办法只提取 JSON 响应的“data”部分作为 Data 类型，以便我可以解码 User 对象而不需要给它一个 status 和 data 属性？

Answer 1

正如其他答案所述，您基本上无法使用 JSONDecoder 执行此操作因为你无法解码 Data为你的 "data" key 。您需要将其解码为 Dictionary<String, Any>或者其他的东西。我可以想出一种方法来做到这一点，但它非常麻烦，即使那样，你最终也会得到一个 Dictionary , 不是 Data , 所以你必须重新编码它才能得到 Data传递给 JSONDecoder稍后。

也许这意味着你必须下降到较低级别 JSONSerialization并“用手”浏览字典。但是如果你在解码时确切地知道你正在寻找什么样的响应，那么我建议你使用 Swift Decodable系统而不是绕过它。

在顶层，您有一个响应，可以是失败也可以是成功，并且在每种情况下都携带不同的数据负载。这听起来像 Swift enum具有相关值:

enum WTPResponse {
    case failure(WTPFailure)
    case success(WTPSuccess)
}

我们希望它可以直接从 JSON 解码，但我们必须编写 Decodable手动一致性。编译器无法为 enum 自动执行此操作与关联值。在我们写 Decodable 之前一致性，让我们定义我们需要的所有其他类型。

响应类型由字符串 "error" 标识或字符串 "success" ，这听起来像是另一个 Swift enum .我们可以做这个enum一个RawRepresentable的 String , 然后 Swift 可以做到 Decodable对我们来说:

enum WTPStatus: String, Decodable {
    case error
    case success
}

对于失败响应类型，数据负载有两个字段。这听起来像 Swift struct , 因为字段是 String和 Int , Swift 可以做到 Decodable对我们来说:

struct WTPFailure: Decodable {
    var errormessage: String
    var errorcode: Int
}

对于成功响应类型，数据负载是一个用户，它有一个 id: Int field 。这听起来像两个 Swift struct s，Swift 可以生成 Decodable对我们来说:

struct WTPSuccess: Decodable {
    var user: WTPUser
}

struct WTPUser: Decodable {
    var id: Int
}

这涵盖了您的示例 JSON 中出现的所有内容。现在我们可以制作WTPResponse符合 Decodable手动，像这样:

extension WTPResponse: Decodable {
    enum CodingKeys: String, CodingKey {
        case status
        case data
    }

    init(from decoder: Decoder) throws {
        let container = try decoder.container(keyedBy: CodingKeys.self)
        switch try container.decode(WTPStatus.self, forKey: .status) {
        case .error: self = .failure(try container.decode(WTPFailure.self, forKey: .data))
        case .success: self = .success(try container.decode(WTPSuccess.self, forKey: .data))
        }
    }
}

这是一个测试:

let failureJsonString = """
    {
       "status":"error",
       "data":{
          "errormessage":"Duplicate entry '101' for key 'PRIMARY'",
          "errorcode":1062
       }
    }
"""

let successJsonString = """
    {
       "status":"success",
       "data":{
          "user": {
            "id": 1,
          }
       }
    }
"""

let decoder = JSONDecoder()
do {
    print(try decoder.decode(WTPResponse.self, from: failureJsonString.data(using: .utf8)!))
    print(try decoder.decode(WTPResponse.self, from: successJsonString.data(using: .utf8)!))
} catch {
    print(error)
}

这是输出:

failure(test.WTPFailure(errormessage: "Duplicate entry \'101\' for key \'PRIMARY\'", errorcode: 1062))
success(test.WTPSuccess(user: test.WTPUser(id: 1)))