使用NSURLSession

寫此文時突發靈感作詩一首, 而後置頂, 歡迎品鑑.

有的程式設計師老了,還沒聽過NSURLSession
有的程式設計師還嫩,沒用過NSURLConnection
有的程式設計師很單純,他只知道AFN.

NSURLConnection在iOS9被宣佈棄用,NSURLSession從13年發展到現在,終於迎來了它獨步江湖的時代.NSURLSession是蘋果在iOS7後為HTTP資料傳輸提供的一系列介面,比NSURLConnection強大,坑少,好用.今天從使用的角度介紹下.

除了NSURLSession,文中還會頻繁地出現NSURLSessionConfiguration和NSURLSessionTask兩個類.先認識一下,混個臉熟吧.

使用NSURLSession,攏共分兩步:

• 第一步 通過NSURLSession的例項建立task
• 第二部 執行task

既然兩步裡面都出現了task,就先說說它吧.
NSURLSessionTask可以簡單理解為任務:如資料請求任務,下載任務,上傳任務and so on.我們使用的是他的子類們:

• NSURLSessionTask(抽象類)
  • NSURLSessionDataTask
    • NSURLSessionUploadTask
  • NSURLSessionDownloadTask

從這幾個子類的名字就可以大概猜出他們的作用了.接下來我們就從不同型別的任務出發,來使用session.

NSURLSessionDataTask

字面上看是和資料相關的任務,但其實dataTask完全可以勝任downloadTask和uploadTask的工作.這可能也是我們使用最多的task種類.

簡單GET請求

如果請求的資料比較簡單,也不需要對返回的資料做一些複雜的操作.那麼我們可以使用帶block

// 快捷方式獲得session物件
NSURLSession *session = [NSURLSession sharedSession];
NSURL *url = [NSURL URLWithString:@"http://www.daka.com/login?username=daka&pwd=123"];
// 通過URL初始化task,在block內部可以直接對返回的資料進行處理
NSURLSessionTask *task = [session dataTaskWithURL:url
                               completionHandler:^(NSData *data, NSURLResponse *response, NSError error) {
    NSLog(@"%@", [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]);
}];

// 啟動任務
[task resume];

Tips:

• 所有型別的task都要呼叫resume方法才會開始進行請求.

簡單POST請求

POST和GET的區別就在於request,所以使用session的POST請求和GET過程是一樣的,區別就在於對request的處理.

NSURL *url = [NSURL URLWithString:@"http://www.daka.com/login"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
request.HTTPMethod = @"POST";
request.HTTPBody = [@"username=daka&pwd=123" dataUsingEncoding:NSUTF8StringEncoding];

NSURLSession *session = [NSURLSession sharedSession];
// 由於要先對request先行處理,我們通過request初始化task
NSURLSessionTask *task = [session dataTaskWithRequest:request
                                   completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) { NSLog(@"%@", [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]); }];
[task resume];

NSURLSessionDataDelegate代理方法

NSURLSession提供了block方式處理返回資料的簡便方式,但如果想要在接收資料過程中做進一步的處理,仍然可以呼叫相關的協議方法.NSURLSession的代理方法和NSURLConnection有些類似,都是分為接收響應、接收資料、請求完成幾個階段.

// 使用代理方法需要設定代理,但是session的delegate屬性是隻讀的,要想設定代理只能通過這種方式建立session
NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration]
                                                      delegate:self
                                                 delegateQueue:[[NSOperationQueue alloc] init]];

// 建立任務(因為要使用代理方法,就不需要block方式的初始化了)
NSURLSessionDataTask *task = [session dataTaskWithRequest:[NSURLRequest requestWithURL:[NSURL URLWithString:@"http://www.daka.com/login?userName=daka&pwd=123"]]];

// 啟動任務
[task resume];

//對應的代理方法如下:

// 1.接收到伺服器的響應
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler {
    // 允許處理伺服器的響應，才會繼續接收伺服器返回的資料
    completionHandler(NSURLSessionResponseAllow);
}

// 2.接收到伺服器的資料（可能呼叫多次）
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data {
    // 處理每次接收的資料
}

// 3.請求成功或者失敗（如果失敗，error有值）
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error {
    // 請求完成,成功或者失敗的處理
}

Tips:

關鍵點在程式碼註釋裡面都有提及,重要的地方再強調一下:

• 如果要使用代理方法,需要設定代理,但從NSURLSession的標頭檔案發現session的delegate屬性是隻讀的.因此設定代理要通過session的初始化方法賦值:sessionWithConfiguration:delegate:delegateQueue:其中:
  • configuration引數(文章開始提到的)需要傳遞一個配置,我們暫且使用預設的配置[NSURLSessionConfiguration defaultSessionConfiguration]就好(後面會說下這個配置是幹嘛用的);
  • delegateQueue參數列示協議方法將會在哪個佇列(NSOperationQueue)裡面執行.
• NSURLSession在接收到響應的時候要先對響應做允許處理:completionHandler(NSURLSessionResponseAllow);,才會繼續接收伺服器返回的資料,進入後面的代理方法.值得一提的是,如果在接收響應的時候需要對返回的引數進行處理(如獲取響應頭資訊等),那麼這些處理應該放在前面允許操作的前面.

NSURLSessionDownloadTask

檔案下載可以使用NSURLSessionDownloadTask這個子類.

簡單下載

NSURLSessionDownloadTask同樣提供了通過NSURL和NSURLRequest兩種方式來初始化並通過block進行回撥的方法.下面以NSURL初始化為例:

SURLSession *session = [NSURLSession sharedSession];
NSURL *url = [NSURL URLWithString:@"http://www.daka.com/resources/image/icon.png"] ;
NSURLSessionDownloadTask *task = [session downloadTaskWithURL:url completionHandler:^(NSURL *location, NSURLResponse *response, NSError *error) {
    // location是沙盒中tmp資料夾下的一個臨時url,檔案下載後會存到這個位置,由於tmp中的檔案隨時可能被刪除,所以我們需要自己需要把下載的檔案挪到需要的地方
    NSString *path = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:response.suggestedFilename];
    // 剪下檔案
    [[NSFileManager defaultManager] moveItemAtURL:location toURL:[NSURL fileURLWithPath:path] error:nil];
}];
    // 啟動任務
    [task resume];

Tips:

• 需要注意的就是需要將下載到tmp資料夾的檔案轉移到需要的目錄.原因在程式碼中已經貼出.
• response.suggestedFilename是從相應中取出檔案在伺服器上儲存路徑的最後部分,如資料在伺服器的url為http://www.daka.com/resources/image/icon.png, 那麼其suggestedFilename就是icon.png.

NSURLSessionDownloadDelegate代理方法

同樣的,downloadTask也提供了配套的代理方法

// 每次寫入呼叫(會呼叫多次)
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite {
// 可在這裡通過已寫入的長度和總長度算出下載進度
CGFloat progress = 1.0 * totalBytesWritten / totalBytesExpectedToWrite; NSLog(@"%f",progress);
}

// 下載完成呼叫
- (void)URLSession:(NSURLSession *)session
      downloadTask:(NSURLSessionDownloadTask *)downloadTask
      didFinishDownloadingToURL:(NSURL *)location {
    // location還是一個臨時路徑,需要自己挪到需要的路徑(caches下面)
    NSString *filePath = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:downloadTask.response.suggestedFilename];
    [[NSFileManager defaultManager] moveItemAtURL:location toURL:[NSURL fileURLWithPath:filePath] error:nil];
}

// 任務完成呼叫
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error {

}

NSURLSessionUploadTask

在NSURLSession中,檔案上傳方式主要有以下兩種:

NSURLSessionUploadTask *task =
[[NSURLSession sharedSession] uploadTaskWithRequest:request
                                           fromFile:fileName
                                  completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
}];

和

 [self.session uploadTaskWithRequest:request
                            fromData:body
                   completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
 NSLog(@"-------%@", [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]);
 }];

處於安全性考慮,通常我們會使用POST方式進行檔案上傳,所以較多使用第二種方式.

但是,NSURLSession並沒有為我們提供比NSURLConnection更方便的檔案上傳方式.方法中body處的引數需要填寫request的請求體(http協議規定格式的大長串).因為你有90%的可能性用了AFNetworking,即使是自己寫的應該也是copy,所以程式碼就不貼了我們只說方法呵呵噠.

斷點下載

NSURLSessionDownloadTask提供了與斷點下載相關的幾個方法:

// 使用這種方式取消下載可以得到將來用來恢復的資料,儲存起來
[self.task cancelByProducingResumeData:^(NSData *resumeData) {
    self.resumeData = resumeData;
}];

// 由於下載失敗導致的下載中斷會進入此協議方法,也可以得到用來恢復的資料
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
{
    // 儲存恢復資料
    self.resumeData = error.userInfo[NSURLSessionDownloadTaskResumeData];
}

// 恢復下載時接過儲存的恢復資料
self.task = [self.session downloadTaskWithResumeData:self.resumeData];
// 啟動任務
[self.task resume];

以目前我對NSURLSession的理解這種斷點下載只支援應用內斷點,如果程式在下載過程中途關閉,則不能恢復下載.(暫時對NSURLSession理解還不全面,不敢妄下斷論,如有不妥簡友們可以溝通下)

其他

此外,task們自身有都擁有下面幾個方法

- (void)suspend;
- (void)resume;
- (void)cancel;

suspend可以讓當前的任務暫停
resume方法不僅可以啟動任務,還可以喚醒suspend狀態的任務
cancel方法可以取消當前的任務,你也可以向處於suspend狀態的任務傳送cancel訊息,任務如果被取消便不能再恢復到之前的狀態.

NSURLSessionConfiguration

簡單地說,就是session的配置資訊.如:

NSURLSessionConfiguration *config = [NSURLSessionConfiguration defaultSessionConfiguration];
// 超時時間
config.timeoutIntervalForRequest = 10;
// 是否允許使用蜂窩網路(後臺傳輸不適用)
config.allowsCellularAccess = YES;
// 還有很多可以設定的屬性

有沒有發現我們使用的Configuration都是預設配置:[NSURLSessionConfiguration defaultSessionConfiguration],其實它的配置有三種型別:

+ (NSURLSessionConfiguration *)defaultSessionConfiguration;
+ (NSURLSessionConfiguration *)ephemeralSessionConfiguration;
+ (NSURLSessionConfiguration *)backgroundSessionConfigurationWithIdentifier:(NSString *)identifier

表示了NSURLSession幾種不同的工作模式.
預設的配置會將快取儲存在磁碟上,第二種瞬時會話模式不會建立永續性儲存的快取,第三種後臺會話模式允許程式在後臺進行上傳下載工作.

除了支援任務的暫停和斷點續傳,我覺得NSURLSession之於NSURLConnection的最偉大的進步就是支援後臺上傳下載任務,這又是一個可以深入討論的話題.但在這方面我還沒有進行深入的研究,待後續瞭解之後另行開貼.

PS:AFNetWorking從2.0版本就有了基於NSURLSession的系列封裝,感興趣的童鞋自行前往瞭解.