前言：iOS開(kāi)發(fā)從業(yè)幾年來(lái)一直沒(méi)有好好總結(jié)下。現(xiàn)在把知識(shí)梳理一下，助人助己吧。
在NSURLConfiguration小節(jié)中講到，NSURLConfiguration是創(chuàng)建NSURLSession的“設(shè)計(jì)圖”，并講了如何繪制設(shè)計(jì)圖。這一節(jié)任務(wù)是根據(jù)設(shè)計(jì)圖創(chuàng)建NSURLSession對(duì)象，并分析其屬性和方法。
NSURLSession的所有的屬性和方法按功能大致可分為三類：
- 創(chuàng)建NSURLSession對(duì)象
- 配置NSURLSession對(duì)象
- 使用NSURLSession對(duì)象
創(chuàng)建NSURLSession對(duì)象
創(chuàng)建NSURSession有三個(gè)創(chuàng)建的方法，下面將分別分析。
創(chuàng)建默認(rèn)session對(duì)象
// 方法1
NSURLSession *session = NSURLSession.sharedSession;
默認(rèn)的Session工廠方法，通過(guò)類屬性sharedSession方法獲得。通過(guò)此對(duì)象生成的task會(huì)共享全局的NSURLCache、NSHTTPCookieStorage和NSURLCredentialStorage。如果想配置自定義的configuration需要用下面的兩個(gè)方法來(lái)生成NSURLSession對(duì)象。
創(chuàng)建個(gè)性化Session對(duì)象
使用單獨(dú)的configuration對(duì)象可以創(chuàng)建個(gè)性化的session對(duì)象。系統(tǒng)為我們提供了下面兩個(gè)方法：
// 方法2
+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration;
// 方法3
+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration
delegate:(id<NSURLSessionDelegate>)delegate
delegateQueue:(NSOperationQueue *)queue;
方法二創(chuàng)建的NSURLSession其cache、cookie和https校驗(yàn)證書(shū)將由NSURLConfiguration決定。方法三比方法二多的功能是創(chuàng)建的NSURLSession可以在指定的delegate中收到其回調(diào)方法。在回調(diào)方法中可以對(duì)通信過(guò)程中的每一步都做自定義處理。
session的通信過(guò)程都是在子線程進(jìn)行的。所以block方法和delegate方法都會(huì)在子線程調(diào)用。如果delegateQueue傳nil系統(tǒng)默認(rèn)創(chuàng)建一個(gè)NSOperationQueue，所有的delegate方法的調(diào)用都將在默認(rèn)的NSOperationQueue中處理。否則就在我們指定的NSOperationQueue中處理數(shù)據(jù)。當(dāng)然我們配置NSOperationQueue時(shí)可以指定其并發(fā)數(shù)，如果并發(fā)數(shù)指定為1，與AFNetwork一樣，那么同時(shí)就只能一個(gè)NSURLSessionTask對(duì)象進(jìn)行收或發(fā)數(shù)據(jù)。關(guān)于這個(gè)將在AFNetwork篇中詳細(xì)說(shuō)明。
使用中的不同是方法1和方法2只能通過(guò)block完成數(shù)據(jù)的接收，只能得到數(shù)據(jù)接收的結(jié)果。方法3可以監(jiān)控并修改整個(gè)數(shù)據(jù)交換的過(guò)程。
可以這么理解方法一內(nèi)部調(diào)用的方法二，只是將Configuration傳的是默認(rèn)值。方法二是調(diào)用的方法三只是將delegate和delegateQueue設(shè)為了nil。偽碼如下:
// 方法1偽碼實(shí)現(xiàn)
+ (instancetype)sharedSession {
NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
return [self sessionWithConfiguration:configuration];
}
// 方法2偽碼實(shí)現(xiàn)
+ (instancetype)sessionWithConfiguration:(NSURLSessionConfiguration*)configuration {
return [self sessionWithConfiguration:configuration delegate:nil delegateQueue:nil];
}
配置Session對(duì)象
說(shuō)是配置session對(duì)象，其實(shí)不太準(zhǔn)確。應(yīng)該是配置和操作session對(duì)象，如果用上一節(jié)的比喻，session對(duì)象是負(fù)責(zé)生產(chǎn)和運(yùn)輸dataTask對(duì)象的工廠，那么下面的方法就是為工廠添加機(jī)器、開(kāi)關(guān)等工作。這類方法大致分為兩種：配置session對(duì)象，操作session對(duì)象。
配置session對(duì)象
配置session對(duì)象有以下四個(gè)屬性：
- delegate
- delegatequeue
- configuration
- sessionDescription
除了sessionDescription外，其他的三個(gè)在生成session對(duì)象后都不可再更改，只可訪問(wèn)。其中configuration在上一節(jié)已經(jīng)說(shuō)過(guò)其作用。
配置了delegate并實(shí)現(xiàn)了delegate的方法，那么客戶端和服務(wù)器通信的過(guò)程都會(huì)訪問(wèn)delegate。需要注意的是，即使采用block接受數(shù)據(jù)，delegate依舊會(huì)被調(diào)用部分。只是NSURLSessionTaskDelegate的方法不調(diào)用。具體過(guò)程會(huì)在下一節(jié)中講到。
delegatequeue是確定delegate在哪個(gè)線程中調(diào)用。如不配置默認(rèn)在全局線程中調(diào)用。
操作session對(duì)象
操作session對(duì)象有下面六個(gè)方法：
- (void)finishTasksAndInvalidate;
- (void)invalidateAndCancel;
- (void)resetWithCompletionHandler:(void (^)(void))completionHandler;
- (void)flushWithCompletionHandler:(void (^)(void))completionHandler;
- (void)getTasksWithCompletionHandler: (^)(NSArray<NSURLSessionDataTask *> *dataTasks, NSArray<NSURLSessionUploadTask *> *uploadTasks, NSArray<NSURLSessionDownloadTask *> *downloadTasks))completionHandler
- (void)getAllTasksWithCompletionHandler:(void (^)(NSArray<__kindof NSURLSessionTask *> *tasks))completionHandler
finishTaskAndInvalidate會(huì)等待應(yīng)答返回或超時(shí)后才會(huì)讓session失效。invalidateAndCancel會(huì)立即讓session失效，并調(diào)用失敗的delegate。其余四個(gè)方法都與完成時(shí)的completionHandler有關(guān)，不太常用，這里暫不討論。
添加任務(wù)到session
創(chuàng)建session對(duì)象，完成了配置，終于其干活的地步了，即生成dataTask對(duì)象并發(fā)送。session有兩種方式完成dataTask的數(shù)據(jù)交換：
- 通過(guò)block接收數(shù)據(jù)；
- 通過(guò)delegate接收數(shù)據(jù)；
查看NSURLSession文件時(shí)會(huì)發(fā)現(xiàn)剩下的一堆方法都是用作此功能的。接下來(lái)會(huì)說(shuō)明這些方法的作用。
block接收數(shù)據(jù)
蘋(píng)果提供了7個(gè)方法用來(lái)實(shí)現(xiàn)通過(guò)block接收數(shù)據(jù)。
官方稱這些方法為便利方式添加Datatask到session。這里需要注意：
- 所有便利方法都是實(shí)例方法，所以必須要我們先生成session對(duì)象。蘋(píng)果沒(méi)有提供把datatask添加到默認(rèn)session對(duì)象的方法。
- 該便利方法只會(huì)添加datatask到session，而不是發(fā)送請(qǐng)求。發(fā)送請(qǐng)求HIA需要用返回的DataTask對(duì)象手動(dòng)調(diào)用resume。
這一堆方法中大致可分為三種：數(shù)據(jù)請(qǐng)求，數(shù)據(jù)上傳，數(shù)據(jù)下載。
/*
* 數(shù)據(jù)請(qǐng)求的兩個(gè)方法
*/
- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request completionHandler:(void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
- (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url completionHandler:(void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
/*
* 數(shù)據(jù)上傳的兩個(gè)方法
*/
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL completionHandler:(void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(nullable NSData *)bodyData completionHandler:(void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
/*
* 數(shù)據(jù)下載的三個(gè)方法
* When a download successfully completes,
* the NSURL will point to a file that must be read or
* copied during the invocation of the completion routine.
* The file will be removed automatically.
*/
- (NSURLSessionDownloadTask *)downloadTaskWithRequest:(NSURLRequest *)request completionHandler:(void (^)(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
- (NSURLSessionDownloadTask *)downloadTaskWithURL:(NSURL *)url completionHandler:(void (^)(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData completionHandler:(void (^)(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
上面介紹delegate時(shí)提到過(guò)，采用block接收數(shù)據(jù)時(shí)，如果session創(chuàng)建時(shí)配置了delegate也會(huì)調(diào)用delegate的方法。
delegate接受數(shù)據(jù)
蘋(píng)果提供了10個(gè)方法用于delegate接收數(shù)據(jù):2個(gè)數(shù)據(jù)數(shù)據(jù)請(qǐng)求，3個(gè)數(shù)據(jù)上傳，3個(gè)數(shù)據(jù)下載，2個(gè)數(shù)據(jù)流方法。這里的方法與block唯一的不同就是請(qǐng)求的數(shù)據(jù)在delegate中接收。
數(shù)據(jù)請(qǐng)求方法
數(shù)據(jù)請(qǐng)求的兩個(gè)方法，也是我們常用的兩個(gè)方法：
- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request;
- (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url;
看蘋(píng)果注釋也可以注意到：POST請(qǐng)求必須用第一個(gè)方法；GET請(qǐng)求可以用第二個(gè)方法。下載的上傳、下載、數(shù)據(jù)流不常用暫時(shí)不介紹了。
其余方法
數(shù)據(jù)上傳、下載和數(shù)據(jù)流方法暫時(shí)沒(méi)研究，以后有時(shí)間了再詳細(xì)研究。
// 數(shù)據(jù)上傳
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL;
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(NSData *)bodyData;
- (NSURLSessionUploadTask *)uploadTaskWithStreamedRequest:(NSURLRequest *)request;
// 數(shù)據(jù)下載
- (NSURLSessionDownloadTask *)downloadTaskWithRequest:(NSURLRequest *)request;
- (NSURLSessionDownloadTask *)downloadTaskWithURL:(NSURL *)url;
- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData;
// 數(shù)據(jù)流方法
- (NSURLSessionStreamTask *)streamTaskWithHostName:(NSString *)hostname port:(NSInteger)port NS_AVAILABLE(10_11, 9_0) __WATCHOS_PROHIBITED;
- (NSURLSessionStreamTask *)streamTaskWithNetService:(NSNetService *)service NS_AVAILABLE(10_11, 9_0) __WATCHOS_PROHIBITED;
不可缺少的request
在生成DataTask的過(guò)程中必定需要url以及request。NSURLSessionDataTask只代表了一次客戶端與服務(wù)器的數(shù)據(jù)請(qǐng)求任務(wù)。每個(gè)任務(wù)的詳細(xì)信息都需要由NSURLRequest對(duì)象來(lái)決定，比如請(qǐng)求方法POST/GET，請(qǐng)求頭，請(qǐng)求體等。至于NSURLSessionDownloadTask和NSURLSessionUploadTask對(duì)NSURLRequest對(duì)象的要求比如是否忽略請(qǐng)求頭，請(qǐng)求體等以后再詳細(xì)探究。
