使用AFN時(shí)在自然不過的一件事了,正如在java中會(huì)使用httpClient缩宜。AFN3.0開始完全基于NSURLSession了褒颈,從此就告別了繁瑣的線程操作的一些東西,轉(zhuǎn)而更加關(guān)注于請(qǐng)求功能的實(shí)現(xiàn)颓帝。最近一段時(shí)間研究了下AFN3.0米碰,得到一些淺薄的筆記,記錄下來购城。
0. 一句話總結(jié)AFN
- 基于NSURLSession的輕量級(jí)吕座,用于發(fā)送異步請(qǐng)求(get,post瘪板,文件上傳吴趴,下載)的框架。
- 包含了對(duì)NSURLRequest的封裝侮攀,NURLResponse的處理锣枝,以及連接的創(chuàng)建厢拭、管理,https安全性的配置撇叁,網(wǎng)絡(luò)的監(jiān)測(cè)供鸠,UIKit的擴(kuò)展。
- AFN3.X版本僅僅基于NSURLSession陨闹,AFN2.X主流用法還是繼續(xù)NSURLConnection楞捂。3.X比2.X結(jié)構(gòu)更加簡單清晰。
1. AFN 是什么
AFN是一個(gè)輕量級(jí)的框架正林,它將通用的客戶端與服務(wù)器的交互的操作封裝了起來泡一,包括了請(qǐng)求的創(chuàng)建,請(qǐng)求操作的管理觅廓,響應(yīng)的序列化鼻忠,網(wǎng)絡(luò)指示器的監(jiān)測(cè),安全性杈绸,以及UI控件異步加載網(wǎng)絡(luò)數(shù)據(jù)的便捷擴(kuò)展帖蔓。
2. AFN3.X能干什么
- 發(fā)異步請(qǐng)求:
- 文件上傳
- 文件下載(小文件,大文件和斷點(diǎn)續(xù)傳等操作目前需要自己封裝)
- 網(wǎng)絡(luò)監(jiān)聽
3.AFN包含什么
AFN3.X的主要功能模塊包括:NSURLRequest的構(gòu)建瞳脓,NSURLSessionTask的創(chuàng)建和管理塑娇,進(jìn)度的監(jiān)測(cè)回調(diào),結(jié)果的回調(diào)劫侧,響應(yīng)的序列化處理
- AFN3.X
+ AFURLSessionManager
*工廠模式創(chuàng)建Task
*Task綁定TaskDelegate
*session代理回調(diào)埋酬,回調(diào)TaskDelegate響應(yīng)回調(diào)
+ AFURLSessionManagerTaskDelegate
*KVO監(jiān)測(cè)進(jìn)度,并回調(diào)
*結(jié)果回調(diào)
+ AFHTTPSessionManager(繼承前者封裝了常用的 HTTP 方法)
* GET
* POST
* POST constructBody
+ AFURLRequestSerialization 請(qǐng)求的數(shù)據(jù)格式/默認(rèn)是二進(jìn)制的
*requestWithMethod
*multipartFormRequestWithMethod
* requestBySerializingRequest
+AFJSONRequestSerializer
* requestBySerializingRequest
+AFPropertyListRequestSerializer
* requestBySerializingRequest
+ AFURLResponseSerialization :響應(yīng)的數(shù)據(jù)格式/默認(rèn)是JSON格式
+ AFSecurityPolicy
+ AFNetworkReachabilityManager
- AFHTTPSessionManager的get方法基于NSURLSessionDataTask
- AFHTTPSessionManager的post方法基于NSURLSessionDataTask
- AFHTTPSessionManager的postconstruct方法基于 NSURLSessionUpLoadTask
- NSURLSessionDownLoadTask的封裝可以自己實(shí)現(xiàn)
4. AFN3.X的功能實(shí)現(xiàn)流程
根據(jù)請(qǐng)求參數(shù)創(chuàng)建請(qǐng)求——發(fā)送請(qǐng)求——響應(yīng)處理
- 輸入:NSURLRequest烧栋,NSMutableURLRequest写妥,
NSURLSession,NSOperation审姓,NSOperationQueue - 輸出data珍特,序列化的對(duì)象
- KVO監(jiān)測(cè)下載和上傳的進(jìn)度
- AFHTTPSessionManager get方法沒有封裝DownLoadTask,需要手動(dòng)實(shí)現(xiàn)
- 上傳使用的是:uploadTaskWithStreamedRequest 魔吐,上傳的body使用的
是request.HTTPBodyStream
1)請(qǐng)求的序列化
目的:根據(jù)輸入的URL扎筒,參數(shù)字典,上傳數(shù)據(jù)(可選)酬姆,構(gòu)造NSURLRequest嗜桌。
功能:默認(rèn)構(gòu)造為application/x-www-form-urlencoded
body類型的數(shù)據(jù)。get直接拼接URL轴踱,post作為請(qǐng)求體症脂。
子類可以構(gòu)造application/json
和application/x-plist
請(qǐng)求數(shù)據(jù)。設(shè)置為httpbodyData。
上傳數(shù)據(jù)形式為multipart/form-data; boundary=XXXX
,設(shè)置的是httpbodystream
原生沒有提供 僅僅上傳單個(gè)文件诱篷,和純文本body形式的API壶唤。但是話說回來,這兩種并不常用棕所。
實(shí)現(xiàn):兩個(gè)關(guān)鍵的方法構(gòu)造請(qǐng)求:
- requestWithMethod:URLString: parameters:error:
此方法調(diào)用協(xié)議方法requestBySerializingRequest: withParameters:error:
- multipartFormRequestWithMethod:URLString:parameters:constructingBodyWithBlock:error:
前者設(shè)置的是httpBody
后者設(shè)置是httpBodystream
具體實(shí)現(xiàn)細(xì)節(jié):待續(xù)
2)響應(yīng)的反序列化
目的:根據(jù)得到的NSURLResponse和body data轉(zhuǎn)化為所需要的數(shù)據(jù)類型闸盔。
功能: responseObjectForResponse:response data:error:
方法 得到感興趣的數(shù)據(jù)類型(id )responseObject
:
默認(rèn)為data,json形式往往為NSDictionary琳省。json的序列化可以設(shè)置是否去除null value迎吵。沒有提供responseString的功能,需要自己轉(zhuǎn)化针贬。
響應(yīng)默認(rèn)為json處理形式击费,響應(yīng)非json的話一定需要顯示的設(shè)置為AFURLResponseSerialization
類型
3)請(qǐng)求的創(chuàng)建,管理桦他,維護(hù)
目的:發(fā)送請(qǐng)求蔫巩,得到響應(yīng),處理好進(jìn)度的回調(diào)快压,請(qǐng)求成功圆仔,失敗的回調(diào)
實(shí)現(xiàn):
GET:parameters: progress:success:failure:
POST:parameters: progress:success:failure:
會(huì)調(diào)用
dataTaskWithHTTPMethod:URLString:parameters:uploadProgress:downloadProgress: success:failure:
然后調(diào)用
dataTaskWithRequest: uploadProgress: downloadProgress: completionHandler
(這是工廠方法創(chuàng)建Task的其中之一)
之后
調(diào)用
addDelegateForDataTask:uploadProgress: downloadProgress: completionHandler
在這里創(chuàng)建一個(gè)自定義的taskDelegate對(duì)象,將參數(shù)賦值給它蔫劣。taskDelegate和Task是一一對(duì)應(yīng)的坪郭,Task的進(jìn)度檢測(cè),結(jié)果的回調(diào)完全都是在taskDelegate中進(jìn)行脉幢。
再調(diào)用
setDelegate:forTask:
這個(gè)方法是線程安全的歪沃,加上鎖的,功能:把delegate放入一個(gè)字典中做記錄嫌松,設(shè)置delegate的進(jìn)度指示绸罗,KVO方法監(jiān)測(cè)task的 countOfBytesReceived, countOfBytesExpectedToReceive等屬性
Session的代理方法在manager中調(diào)用:
manager中每一個(gè)代理方法都定義了一個(gè)block豆瘫。調(diào)用相應(yīng)代理方法的時(shí)候如果有相應(yīng)的block就會(huì)回調(diào)。但是實(shí)際上菊值,定義的get和post等方法并未使用外驱。
反而,在代理方法中
調(diào)用
delegateForTask:
方法(加鎖的操作)根據(jù)task取得相應(yīng)的taskDelegate然后回調(diào)相應(yīng)的taskDelegate的方法腻窒。
taskDelegate中昵宇,KVO回調(diào)方法會(huì)實(shí)時(shí)監(jiān)測(cè)進(jìn)度并回調(diào)響應(yīng)的block
在taskDelegate的 URLSession:task:didCompleteWithError:
中
獲取到之前拼接的data,根據(jù)序列化得到responseObject儿子,response直接取task的屬性
然后回調(diào) completionHandler block并發(fā)送相應(yīng)通知瓦哎。如果不設(shè)置 manager.completionQueue,就在main_queue中回調(diào)贺拣。
最后掃尾工作:移除taskDelegate的KVO和task的通知笛厦,保存task和taskDelegate的字典中移除(這個(gè)操作也需要加鎖)
POST:parameters: constructingBodyWithBlock:progress:success:failure:
調(diào)用
uploadTaskWithStreamedRequest:progress:uploadProgressBlock completionHandler:
之后的流程類似
progress回調(diào)是在sessionQueue中回調(diào)找岖,不是在mainQueue
5.常用的封裝
待續(xù)
6.需要的背景知識(shí)
1)NSURLSession簡介
- NSURLSession的創(chuàng)建需要指定模式刹悴,代理腕够,和代理的線程隊(duì)列
- NSURLSession的提供了豐富的構(gòu)建task的方法重贺,使用block的話就不會(huì)回調(diào)代理了
- NSURLSessionTask提供了開啟驾胆,中斷渠啤,取消的操作剂买,狀態(tài)惠爽,發(fā)送接收數(shù)據(jù)的屬性,request瞬哼,response婚肆,error屬性,沒有data屬性
使用代理的話坐慰,需要把data疊加 - NSURLSessionDelegate:session狀態(tài)的代理回調(diào)
- NSURLSessionDataDelegate: dataTask的方法回調(diào)
- NSURLSessionTaskDelegate:只要是TASK的方法回調(diào)
- NSURLSessionDownLoadTask:downLoadTask的方法回調(diào)