URLSession.shared.dataTask正确接收数据的方式

问题描述 投票:2回答:1

美好的一天!

我在尝试从dataTask检查接收(数据,响应,错误)并执行一些特殊错误处理时找到正确的序列时有点困惑。

通常我们的URLSession看起来像这样:

class HTTPRequest {
    static func request(urlStr: String, parameters: [String: String], completion: @escaping (_ data: Data?,_ response: URLResponse?, _ error: Error?) -> ()) {
        var url = OpenExchange.base_URL + urlStr
        url += getParameters(param: parameters)
        let request = URLRequest(url: URL(string: url)!)
        let task = URLSession.shared.dataTask(with: request) { (data, response, error) in
            if error != nil {
                print("URLSession Error: \(String(describing: error?.localizedDescription))")
                completion(nil,nil,error)
            } else {
                completion(data,response,nil)
            }
        }
        task.resume()
    }

    static func getParameters(param: [String: String]) -> String {
        var data = [String]()
        for (key,value) in param {
            data.append(key + "=\(value)")
        }
        return data.map { String($0) }.joined(separator: "&")
    }

}

我有另一个函数,其中包含HTTPRequest,将所有内容包装到我正在使用的对象类型:

 static func networkOperation(urlStr: String, parameters: [String: String], completion: @escaping (ReturnedData) -> () ) {
        var recieved = ReturnedData()
        HTTPRequest.request(urlStr: urlStr, parameters: parameters) { (data, resp, err) in
            if let data = data, let response = resp {

// TODO: try JSONDecoder() if data is API Error Struct; Moderate this section depending on results of decoding;

                recieved.data = data
                recieved.response = response 
                recieved.result = .Success
                completion(recieved)
                return
            } else if err == nil {
                recieved.result = .ErrorUnknown
                completion(recieved)
                return
            }
            recieved.error = err as NSError?
            completion(recieved)
        }
       }

public struct ReturnedData {
    public var data: Data?
    public var response: URLResponse?
    public var error: Error?
    public var result: RequestResult = .ErrorHTTP
}

public enum RequestResult: String {
    case Success
    case ErrorAPI
    case ErrorHTTP
    case ErrorUnknown
}

使用上面的代码,我可以轻松地创建不同的networkOperation调用,以执行不同的API方法并处理返回的不同数据模型。我想要实现的是API错误检查。由于我的API有一些错误描述,例如,当您的APP_ID错误或当前APP_ID无权获取信息等时。所以如果发生任何这些,数据将如下所示:

  {
  "error": true,
  "status": 401,
  "message": "invalid_app_id",
  "description": "Invalid App ID provided - please sign up at https://openexchangerates.org/signup, or contact [email protected]."
  }

我认为用networkOperations“// TODO”标记中的Error struct解码每个接收到的数据是不行的,也许有一些很好的方法来实现它?

ios swift api error-handling nsurlsessiondatatask
1个回答
3
投票

您应该让API错误返回错误对象。

例如。你可以这样做:

enum NetworkRequestError: Error {
    case api(_ status: Int, _ code: ApiResultCode, _ description: String)
}

你把你的回答编码到一个名为enumApiResultCode中,如下所示:

enum ApiResultCode {
    case invalidAppId
    case recordNotFound   // just an example
    ...
    case unknown(String)
}

extension ApiResultCode {
    static func code(for string: String) -> ApiResultCode {
        switch string {
        case "invalid_app_id":   return .invalidAppId
        case "record_not_found": return .recordNotFound
        ...
        default:                 return .unknown(string)
        }
    }
}

这个枚举可以让你检查message代码,而不会乱码你的代码与字符串文字。

如果你解析API错误,你可以返回它。例如。

if responseObject.error {
    let error = NetworkRequestError.api(responseObject.status, ApiResultCode.code(for: responseObject.message), responseObject.description)
    ... now pass this `error`, just like any other `Error` object
}

如果您对更广泛的重新设计持开放态度,我个人建议

  • 重构RequestResult来提取那些单独的错误类型(调用者只想知道它是成功还是失败......如果失败了,它应该查看Error对象以确定它失败的原因);
  • 但是这个新的Result枚举包括相关的值,即成功的Data和失败的Error;和
  • 既然枚举包含了我们在其相关值中所需要的东西,我们就可以完全消除ReturnedData

所以,首先,让我们扩展RequestResult以包括失败时的错误和成功时的有效负载:

public enum Result {
    case success(Data)
    case failure(Error)
}

实际上,现代惯例是使这个通用,其中上面成为Result<Data, Error>使用以下:

public enum Result<T, U> {
    case success(T)
    case failure(U)
}

(Swift 5实际上包含了这个通用。)

然后我会扩展ResultError以处理API错误以及任何未知错误:

enum NetworkRequestError: Error {
    case api(_ status: Int, _ code: ApiResultCode, _ description: String)
    case unknown(Data?, URLResponse?)
}

所以,完成这个,你可以改变request传回一个Result<Data, Error>

static func request(urlString: String, parameters: [String: String], completion: @escaping (Result<Data, Error>) -> ()) {
    let request = URLRequest(url: URL(string: urlString)!)
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
        guard let responseData = data, error == nil else {
            completion(.failure(error ?? NetworkRequestError.unknown(data, response)))
            return
        }

        completion(.success(responseData))
    }
    task.resume()
}

然后调用者会这样做:

request(...) { result in
    switch result {
    case .failure(let error):
        // do something with `error`

    case .success(let data):
        // do something with `data`
    }
}

这个Result泛型的美妙之处在于它成为您可以在整个代码中使用的一致模式。例如,假设您有一些方法将FooData中返回的request解析:

func retrieveFoo(completion: @escaping (Result<Foo, Error>) -> Void) {
    request(...) { result in
        switch result {
        case .failure(let error):
            completion(.failure(error))

        case .success(let data):
            do {
                let responseObject = try JSONDecoder().decode(ResponseObject.self, from: data)
                if responseObject.error {
                    completion(.failure(NetworkRequestError.api(responseObject.status, ApiResultCode.code(for: responseObject.message), responseObject.description)))
                    return
                }

                let foo = responseObject.foo
                completion(.success(foo))
            } catch {
                completion(.failure(error))
            }
        }
    }
}

或者,如果您想测试特定的API错误,例如.recordNotFound

retrieveFoo { result in
    switch result {
    case .failure(NetworkRequestError.api(_, .recordNotFound, _)):
        // handle specific “record not found” error here

    case .failure(let error):
        // handle all other errors here

    case .success(let foo):
        // do something with `foo`
    }
}
© www.soinside.com 2019 - 2024. All rights reserved.