Alamofire4.x开源代码分析(一)使用方法

输入图片说明本着了解框架的实现思路和学习Swift的目的开启本系列的博客.本系列参考Alamofire官方文档和自己的一些理解,欢迎指正和指教.

配置要求

iOS 8.0+, macOS 10.10.0+, tvOS 9.0+ and watchOS 2.0+
Xcode 8.1+
Swift 3.0+

简单使用

1Alamofire.request("https://httpbin.org/get").responseJSON { response in
2            print("Request: \(String(describing: response.request))")   // // 原始的请求
3
4            print("Response: \(String(describing: response.response))") // http 请求响应
5            print("Result: \(response.result)")                         // 响应结果标识
6            
7            if let json = response.result.value {
8                print("JSON: \(json)") // JSON序列化的数据
9            }
10            
11            if let data = response.data, let utf8Text = String(data: data, encoding: .utf8) {
12                print("Data: \(utf8Text)") // 经过UTF-8编码的数据
13            }
14        }
15

不难看出alamofire用了链式编程的思想.

响应数据类型

请求返回五种response

1 // Response Handler -直接返回URL session delegate的数据
2         func response(
3         queue: DispatchQueue?,
4         completionHandler: @escaping (DefaultDataResponse) -> Void)
5         -> Self
6         
7         // Response Data Handler - 序列化为Data
8         func responseData(
9         queue: DispatchQueue?,
10         completionHandler: @escaping (DataResponse<Data>) -> Void)
11         -> Self
12         
13         // Response String Handler - 序列化成String字符串
14         func responseString(
15         queue: DispatchQueue?,
16         encoding: String.Encoding?,
17         completionHandler: @escaping (DataResponse<String>) -> Void)
18         -> Self
19         
20         // Response JSON Handler - 序列化成JSON
21         func responseJSON(
22         queue: DispatchQueue?,
23         completionHandler: @escaping (DataResponse<Any>) -> Void)
24         -> Self
25         
26         // Response PropertyList (plist) Handler - 序列化成plist
27         func responsePropertyList(
28         queue: DispatchQueue?,
29         completionHandler: @escaping (DataResponse<Any>) -> Void))
30         -> Self

被序列化的数据可以用通过resonse中的result.value来获取数据

1 //也可以同时使用,内部通过线程队列实现
2        Alamofire.request("https://httpbin.org/get")
3            .responseString { response in
4                print("Response String: \(response.result.value)")
5            }
6            .responseJSON { response in
7                print("Response JSON: \(response.result.value)")
8        }

Response是默认在主线程队列执行异步回调,

(queue ?? DispatchQueue.main).async

这里的队列也是可以自定义的, 例如:

1let utilityQueue = DispatchQueue.global(qos: .utility)
2
3Alamofire.request("https://httpbin.org/get").responseJSON(queue: utilityQueue) { response in
4    print("Executing response handler on utility queue")
5}

响应验证

validate可以在结果返回之前验证响应状态或类型是否正确,也可以使用默认方式验证.validate()

1Alamofire.request("https://httpbin.org/get")
2    .validate(statusCode: 200..<300)
3    .validate(contentType: ["application/json"])
4    .responseData { response in
5        switch response.result {
6        case .success:
7            print("Validation Successful")
8        case .failure(let error):
9            print(error)
10        }
11    }

Response缓存

Response缓存基于系统的URLCache,如果需要自定义参数在后面 Session Manager Configurations章节中会讲到

系列目录