Alamofire 4.0 迁移指南

// Alamofire 3
Alamofire.request(.GET, urlString).response { request, response, data, error in
 print(request)
 print(response)
 print(data)
 print(error)
}

// Alamofire 4
Alamofire.request(urlString).response { response in // 默认为 `.get` 方法
 debugPrint(response)
}

// Alamofire 3
let parameters: [String: AnyObject] = ["foo": "bar"]

Alamofire.request(.GET, urlString, parameters: parameters, encoding: .JSON)
 .progress { bytesRead, totalBytesRead, totalBytesExpectedToRead in
 print("Bytes: /(bytesRead), Total Bytes: /(totalBytesRead), Total Bytes Expected: /(totalBytesExpectedToRead)")
 }
 .validate { request, response in
 // 自定义的校验闭包 (访问不到服务器返回的数据)
 return .success
 }
 .responseJSON { response in
 debugPrint(response)
 }

// Alamofire 4
let parameters: Parameters = ["foo": "bar"]

Alamofire.request(urlString, method: .get, parameters: parameters, encoding: JSONEncoding.default)
 .downloadProgress(queue: DispatchQueue.global(qos: .utility)) { progress in
 print("进度: /(progress.fractionCompleted)")
 }
 .validate { request, response, data in
 // 自定义的校验闭包, 现在加上了 `data` 参数(允许你提前转换数据以便在必要时挖掘到错误信息)
 return .success
 }
 .responseJSON { response in
 debugPrint(response)
 }

// Alamofire 3
let destination = DownloadRequest.suggestedDownloadDestination()

Alamofire.download(.GET, urlString, destination: destination).response { request, response, data, error in
 // fileURL 在哪, 怎么获取?
 print(request)
 print(response)
 print(data)
 print(error)
}

// Alamofire 4
let destination = DownloadRequest.suggestedDownloadDestination()

Alamofire.download(urlString, to: destination).response { response in // 默认为 `.get` 方法
 print(response.request)
 print(response.response)
 print(response.temporaryURL)
 print(response.destinationURL)
 print(response.error)
}

// Alamofire 3
let destination = DownloadRequest.suggestedDownloadDestination()

Alamofire.download(urlRequest, destination: destination).validate().responseData { response in
 // fileURL 在哪里, 太难获取了
 debugPrint(response)
}

// Alamofire 4
Alamofire.download(urlRequest, to: destination).validate().responseData { response in
 debugPrint(response)
 print(response.temporaryURL)
 print(response.destinationURL)
}

// Alamofire 3
let fileURL: NSURL
let destination: Request.DownloadFileDestination = { _, _ in fileURL }
let parameters: [String: AnyObject] = ["foo": "bar"]

Alamofire.download(.GET, urlString, parameters: parameters, encoding: .JSON, to: destination)
 .progress { bytesRead, totalBytesRead, totalBytesExpectedToRead in
 print("Bytes: /(bytesRead), Total Bytes: /(totalBytesRead), Total Bytes Expected: /(totalBytesExpectedToRead)")
 }
 .validate { request, response in
 // 自定义的校验实现(获取不到临时下载位置和目标下载位置)
 return .success
 }
 .responseJSON { response in
 print(fileURL) // 只有在闭包捕获了的情况才能获取到, 不够理想
 debugPrint(response)
 }

// Alamofire 4
let fileURL: URL
let destination: DownloadRequest.DownloadFileDestination = { _, _ in
 return (fileURL, [.createIntermediateDirectories, .removePreviousFile])
}
let parameters: Parameters = ["foo": "bar"]

Alamofire.download(urlString, method: .get, parameters: parameters, encoding: JSONEncoding.default, to: destination)
 .downloadProgress(queue: DispatchQueue.global(qos: .utility)) { progress in
 print("进度: /(progress.fractionCompleted)")
 }
 .validate { request, response, temporaryURL, destinationURL in
 // 自定义的校验闭包, 现在包含了 fileURL (必要时可以获取到错误信息)
 return .success
 }
 .responseJSON { response in
 debugPrint(response)
 print(response.temporaryURL)
 print(response.destinationURL)
 }

// Alamofire 3
Alamofire.upload(.POST, urlString, data: data).response { request, response, data, error in
 print(request)
 print(response)
 print(data)
 print(error)
}

// Alamofire 4
Alamofire.upload(data, to: urlString).response { response in // 默认为 `.post` 方法
 debugPrint(response)
}

// Alamofire 3
Alamofire.upload(urlRequest, file: fileURL).validate().responseData { response in
 debugPrint(response)
}

// Alamofire 4
Alamofire.upload(fileURL, with: urlRequest).validate().responseData { response in
 debugPrint(response)
}

// Alamofire 3
Alamofire.upload(.PUT, urlString, file: fileURL)
 .progress { bytes, totalBytes, totalBytesExpected in
 // 这里的进度是上传还是下载的?
 print("Bytes: /(bytesRead), Total Bytes: /(totalBytesRead), Total Bytes Expected: /(totalBytesExpectedToRead)")
 }
 .validate { request, response in
 // 自定义的校验实现(获取不到服务端的数据)
 return .success
 }
 .responseJSON { response in
 debugPrint(response)
 }

// Alamofire 4
Alamofire.upload(fileURL, to: urlString, method: .put)
 .uploadProgress(queue: DispatchQueue.global(qos: .utility)) { progress in
 print("上传进度: /(progress.fractionCompleted)")
 }
 .downloadProgress { progress in // 默认在主队列调用
 print("下载进度: /(progress.fractionCompleted)")
 }
 .validate { request, response, data in
 // 自定义的校验闭包, 现在加上了 `data` 参数(允许你提前转换数据以便在必要时挖掘到错误信息)
 return .success
 }
 .responseJSON { response in
 debugPrint(response)
 }

public protocol URLStringConvertible{
 var URLString: String { get }
}

public protocol URLConvertible{
 func asURL() throws -> URL
}

let urlRequest = URLRequest(url: URL(string: "https://httpbin.org/get")!)
let urlString = urlRequest.urlString

let urlRequest = URLRequest(url: URL(string: "https://httpbin.org/get")!)
let urlString = urlRequest.url?.absoluteString

public protocol URLRequestConvertible{
 var URLRequest: URLRequest { get }
}

public protocol URLRequestConvertible{
 func asURLRequest() throws -> URLRequest
}

public protocol RequestAdapter{
 func adapt(_ urlRequest: URLRequest) throws -> URLRequest
}

class AccessTokenAdapter: RequestAdapter{
 private let accessToken: String

 init(accessToken: String) {
 self.accessToken = accessToken
 }

 func adapt(_ urlRequest: URLRequest) throws -> URLRequest {
 var urlRequest = urlRequest

 if urlRequest.urlString.hasPrefix("https://httpbin.org") {
 urlRequest.setValue("Bearer " + accessToken, forHTTPHeaderField: "Authorization")
 }

 return urlRequest
 }
}

let sessionManager = SessionManager()
sessionManager.adapter = AccessTokenAdapter(accessToken: "1234")

sessionManager.request("https://httpbin.org/get")

public typealias RequestRetryCompletion = (_ shouldRetry: Bool, _ timeDelay: TimeInterval) -> Void

public protocol RequestRetrier{
 func should(_ manager: SessionManager, retry request: Request, with error: Error, completion: @escaping RequestRetryCompletion)
}

class OAuth2Handler: RequestAdapter, RequestRetrier{
 public func should(_ manager: SessionManager, retry request: Request, with error: Error, completion: RequestRetryCompletion) {
 if let response = request.task.response as? HTTPURLResponse, response.statusCode == 401 {
 completion(true, 1.0) // 1秒后重试
 } else {
 completion(false, 0.0) // 不重连
 }
 }
}

let sessionManager = SessionManager()
sessionManager.retrier = OAuth2Handler()

sessionManager.request(urlString).responseJSON { response in
 debugPrint(response)
}

Alamofire.request(urlString).response { response in
 debugPrint(response.metrics)
}

Alamofire.request(urlString).response { response in
 if #available(iOS 10.0, *) {
 debugPrint(response.metrics)
 }
}

Alamofire.request(urlString).responseJSON { response in
 guard case let .failure(error) = response.result else { return }

 if let error = error as? AFError {
 switch error {
 case .invalidURL(let url):
 print("无效 URL: /(url) - /(error.localizedDescription)")
 case .parameterEncodingFailed(let reason):
 print("参数编码失败: /(error.localizedDescription)")
 print("失败理由: /(reason)")
 case .multipartEncodingFailed(let reason):
 print("Multipart encoding 失败: /(error.localizedDescription)")
 print("失败理由: /(reason)")
 case .responseValidationFailed(let reason):
 print("Response 校验失败: /(error.localizedDescription)")
 print("失败理由: /(reason)")

 switch reason {
 case .dataFileNil, .dataFileReadFailed:
 print("无法读取下载文件")
 case .missingContentType(let acceptableContentTypes):
 print("文件类型不明: /(acceptableContentTypes)")
 case .unacceptableContentType(let acceptableContentTypes, let responseContentType):
 print("文件类型: /(responseContentType) 无法读取: /(acceptableContentTypes)")
 case .unacceptableStatusCode(let code):
 print("请求返回状态码出错: /(code)")
 }
 case .responseSerializationFailed(let reason):
 print("请求返回内容序列化失败: /(error.localizedDescription)")
 print("失败理由: /(reason)")
 }

 print("错误: /(error.underlyingError)")
 } else if let error = error as? URLError {
 print("URL 错误: /(error)")
 } else {
 print("未知错误: /(error)")
 }
}

public typealias Parameters = [String: Any]

public protocol ParameterEncoding{
 func encode(_ urlRequest: URLRequestConvertible, with parameters: Parameters?) throws -> URLRequest
}

let parameters: Parameters = ["foo": "bar"]

Alamofire.request(urlString, parameters: parameters) // Encoding => URLEncoding(destination: .methodDependent)
Alamofire.request(urlString, parameters: parameters, encoding: URLEncoding(destination: .queryString))
Alamofire.request(urlString, parameters: parameters, encoding: URLEncoding(destination: .httpBody))

// Static convenience properties (we'd like to encourage everyone to use this more concise form)
// 便利的静态属性 (我们想鼓励大家使用这种更简洁的形式)
Alamofire.request(urlString, parameters: parameters, encoding: URLEncoding.default)
Alamofire.request(urlString, parameters: parameters, encoding: URLEncoding.queryString)
Alamofire.request(urlString, parameters: parameters, encoding: URLEncoding.httpBody)

let parameters: Parameters = ["foo": "bar"]

Alamofire.request(urlString, parameters: parameters, encoding: JSONEncoding(options: []))
Alamofire.request(urlString, parameters: parameters, encoding: JSONEncoding(options: .prettyPrinted))

// Static convenience properties (we'd like to encourage everyone to use this more concise form)
// 便利的静态属性 (我们想鼓励大家使用这种更简洁的形式)
Alamofire.request(urlString, parameters: parameters, encoding: JSONEncoding.default)
Alamofire.request(urlString, parameters: parameters, encoding: JSONEncoding.prettyPrinted)

let parameters: Parameters = ["foo": "bar"]

Alamofire.request(urlString, parameters: parameters, encoding: PropertyListEncoding(format: .xml, options: 0))
Alamofire.request(urlString, parameters: parameters, encoding: PropertyListEncoding(format: .binary, options: 0))

// Static convenience properties (we'd like to encourage everyone to use this more concise form)
// 便利的静态属性 (我们想鼓励大家使用这种更简洁的形式)
Alamofire.request(urlString, parameters: parameters, encoding: PropertyListEncoding.xml)
Alamofire.request(urlString, parameters: parameters, encoding: PropertyListEncoding.binary)

open class Request{
 // 包含了共有的属性, 验证, 和状态方法
 // 遵守 CustomStringConvertible 和 CustomDebugStringConvertible
}

open class DataRequest: Request{
 // 包含了数据流(不要跟 StreamRequest 混淆)和下载进度的方法
}

open class DownloadRequest: Request{
 // 包含了下载位置和选项, 已下载的数据以及进度方法
}

open class UploadRequest: DataRequest{
 // 继承了所有 DataRequest 的方法, 并且包含了上传进度的方法
}

open class StreamRequest: Request{
 // 只继承了 Request, 目前暂时没有任何自定义的 API
}

Alamofire.request(urlString)
 .downloadProgress { progress in
 // 默认在主队列调用
 print("下载进度: /(progress.fractionCompleted)")
 }
 .responseJSON { response in
 debugPrint(response)
 }

Alamofire.download(urlString, to: destination)
 .downloadProgress(queue: DispatchQueue.global(qos: .utility)) { progress in
 // 在 .utility 队列里调用
 print("下载进度: /(progress.fractionCompleted)")
 }
 .responseJSON { response in
 debugPrint(response)
 }

Alamofire.upload(data, to: urlString, withMethod: .post)
 .uploadProgress { progress in
 // 默认在主队列调用
 print("上传进度: /(progress.fractionCompleted)")
 }
 .downloadProgress { progress in
 // 默认在主队列调用
 print("下载进度: /(progress.fractionCompleted)")
 }
 .responseData { response in
 debugPrint(response)
 }

Alamofire.download(urlString).responseData { response in
 print("临时文件的 URL: /(response.temporaryURL)")
}

public typealias DownloadFileDestination = (
 _ temporaryURL: URL,
 _ response: HTTPURLResponse)
 -> (destinationURL: URL, options: DownloadOptions)

let destination: DownloadRequest.DownloadFileDestination = { _, _ in
 return (fileURL, [.removePreviousFile, .createIntermediateDirectories])
}

Alamofire.download(urlString, to: destination).response { response in
 debugPrint(response)
}

extension DataRequest{
 public typealias Validation = (URLRequest?, HTTPURLResponse, Data?) -> ValidationResult
}

Alamofire.request(urlString)
 .validate { request, response, data in
 guard let data = data else { return .failure(customError) }

 // 1) 验证返回的数据保证接下来的操作不会出错
 // 2) 如果验证失败, 你可以把错误信息返回出去, 甚至加上自定义的 error

 return .success
 }
 .response { response in
 debugPrint(response)
 }

extension DownloadRequest{
 public typealias Validation = (
 _ request: URLRequest?,
 _ response: HTTPURLResponse,
 _ temporaryURL: URL?,
 _ destinationURL: URL?)
 -> ValidationResult
}

Alamofire.download(urlString)
 .validate { request, response, temporaryURL, destinationURL in
 guard let fileURL = temporaryURL else { return .failure(customError) }

 do {
 let _ = try Data(contentsOf: fileURL)
 return .success
 } catch {
 return .failure(customError)
 }
 }
 .response { response in
 debugPrint(response)
 }

public struct DefaultDataResponse{
 public let request: URLRequest?
 public let response: HTTPURLResponse?
 public let data: Data?
 public let error: Error?
 public var metrics: URLSessionTaskMetrics? { return _metrics as? URLSessionTaskMetrics }
}

Alamofire.request(urlString).response { response in
 debugPrint(response)
}

Alamofire.upload(file, to: urlString).response { response in
 debugPrint(response)
}

public struct DataResponse<Value>{
 public let request: URLRequest?
 public let response: HTTPURLResponse?
 public let data: Data?
 public let result: Result<Value>
 public let timeline: Timeline
 public var metrics: URLSessionTaskMetrics? { return _metrics as? URLSessionTaskMetrics }
}

Alamofire.request(urlString).responseJSON { response in
 debugPrint(response)
 print(response.result.isSuccess)
}

Alamofire.upload(fileURL, to: urlString).responseData { response in
 debugPrint(response)
 print(response.result.isSuccess)
}

public struct DefaultDownloadResponse{
 public let request: URLRequest?
 public let response: HTTPURLResponse?
 public let temporaryURL: URL?
 public let destinationURL: URL?
 public let resumeData: Data?
 public let error: Error?
 public var metrics: URLSessionTaskMetrics? { return _metrics as? URLSessionTaskMetrics }
}

Alamofire.download(urlString).response { response in
 debugPrint(response)
 print(response.temporaryURL)
}

Alamofire.download(urlString, to: destination)
 .responseData { response in
 debugPrint(response)
 }
 .responseString { response in
 debugPrint(response)
 }
 .responseJSON { response in
 debugPrint(response)
 }
 .responsePropertyList { response in
 debugPrint(response)
 }