iOS NSURLSession 詳解

最近公司項目中，之前做的上傳下載列表被用戶吐槽，不能後臺下載，不能鎖屏下載。於是就開始尋找解決辦法。
因爲在iOS7 就推出了NSURLSession ，我也知道它能夠實現後臺下載。(之前一個哥們在做某視頻軟件時的需求就是要求後臺也可以下載)。
我就直接定位到了NSURLSession，開始着手重寫app的上傳下載模塊。找了資料研究了一下NSURLSession。
資料：https://www.shinobicontrols.com/blog/ios7-day-by-day-day-1-nsurlsession
NSURLSession提供的功能：
1、通過URL將數據下載到內存
2、通過URL將數據下載到文件系統
3、將數據上傳到指定URL
4、在後臺完成上述功能
NSURLSession狀態同時對應着多個連接，不像之前使用共享的一個全局狀態。會話是通過工廠方法來創建配置對象。
總共有三種會話：
1. 默認的，進程內會話
2. 短暫的（內存），進程內會話
3. 後臺會話
如果是簡單的下載，我們只需要使用默認模式即可：
NSURLSessionConfiguration *sessionConfig = [NSURLSessionConfiguration defaultSessionConfiguration];
配置對象有很多屬性。例如，可以設置TLS安全等級，TLS決定你可以使用cookies和超時時間。還有兩個非常有趣的屬性：allowsCellularAccess和discretionary。前一個屬性表示當只有一個3G網絡時，網絡是否允許訪問。設置 discretionary屬性可以控制系統在一個合適的時機訪問網絡，比如有可用的WiFi，有充足的電量。這個屬性主要針對後臺回話的，所以在後臺會話模式下默認是打開的。
當我們創建了一個會話配置對象後，就可以用它來創建會話對象了：

NSURLSession *inProcessSession;

inProcessSession = [NSURLSession sessionWithConfiguration:sessionConfig
                                       delegate:self delegateQueue:nil]；

注意：這裏我們把自己設置爲代理了。通過代理方法可以告訴我們數據傳輸進度以及獲取認證信息。下面我們會實現一些合適的代理。

數據傳輸時封裝在任務裏面的，這裏有三種類型：
1. 數據任務 (NSURLSessionDataTask)
2. 上傳任務 (NSURLSessionUploadTask)
3. 下載任務(NSURLSessionDownloadTask)
在會話中傳輸數據時，我們需要實現某一種任務。比如下載：

NSString *url = @"http://appropriate/url/here";


NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:url]];
NSURLSessionDownloadTask *cancellableTask = 
                              [inProcessSession downloadTaskWithRequest:request];

[cancellableTask resume];

現在會話將會異步下載此url的文件內容。

我們需要實現一個代理方法來獲取這個下載的內容：

-(void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location
{
    NSFileManager *fileManager = [NSFileManager defaultManager];
    NSArray *URLs = [fileManager URLsForDirectory:NSDocumentDirectory inDomains:NSUserDomainMask];
    NSURL *documentsDirectory = URLs[0];
    NSURL *destinationPath =
    [documentsDirectory URLByAppendingPathComponent:[location lastPathComponent]];
    
    NSError *error;
    [fileManager removeItemAtURL:destinationPath error:NULL];
    
    BOOL success = [fileManager copyItemAtURL:location toURL:destinationPath error:&error];
    if (success){
        
        dispatch_async(dispatch_get_main_queue(), ^{
            UIImage *image = [UIImage imageWithContentsOfFile:[destinationPath path]]; self.imageView.image = image;
            self.imageView.contentMode = UIViewContentModeScaleAspectFill;
            
            self.imageView.hidden = NO;
        });
    }
    else {
        NSLog(@"Couldn't copy the downloaded file");
    }
    
    if(downloadTask == cancellableTask)
        
    {
        
        cancellableTask = nil;
        
    }
    
}

這個方法在NSURLSessionDownloadTaskDelegate代理中。在代碼中，我們獲取到下載文件的臨時目錄，並把它保存到文檔目錄下（因爲有個圖片），然後顯示給用戶。

上面的代理是下載成功的回調方法。下面代理方法也在NSURLSessionDownloadTaskDelegate代理中，不管任務是否成功，在完成後都會回調這個代理方法。

- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error{
    dispatch_async(dispatch_get_main_queue(), ^{
        self.progressIndicator.hidden = YES;
    });
}

如果error是nil，則證明下載是成功的，否則就要通過它來查詢失敗的原因。如果下載了一部分，這個error會包含一個NSData對象，如果後面要恢復任務可以用到。

傳輸進度
上一節結尾，你可能注意到我們有一個進度來標示每個任務完成度。更新進度條可能不是很容易，會有一個額外的代理來做這件事情，當然它會被調用多次。

-(void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten BytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
{
    double currentProgress = totalBytesWritten / (double)totalBytesExpectedToWrite; dispatch_async(dispatch_get_main_queue(), ^{
        self.progressIndicator.hidden = NO; self.progressIndicator.progress = currentProgress;
    });
}

這是NSURLSessionDownloadTaskDelegate的另一個代理方法，我們用來計算進度並更新進度條。

取消下載
NSURLConnection一旦發送是沒法取消的。但是，我們可以很容易的取消掉一個NSURLSessionTask任務：

- (IBAction)cancelCancellable:(id)sender
{
    if(cancellableTask)
    {
        [cancellableTask cancel];
        cancellableTask = nil;
    }
}

非常容易！當取消後，會回調這個URLSession:task:didCompleteWithError:代理方法，通知你去及時更新UI。當取消一個任務後，也十分可能會再一次回調這個代理方法 URLSession:downloadTask:didWriteData:BytesWritten:totalBytesExpectedToWrite: 。當然，didComplete 方法肯定是最後一個回調的。

恢復下載
恢復下載也非常容易。這裏重寫了個取消方法，會生成一個NSData對象，可以在以後用來繼續下載。如果服務器支持恢復下載，這個data對象會包含已經下載了的內容。

- (IBAction)cancelCancellable:(id)sender
{
    if(self.resumableTask)
    {
        [self.resumableTask cancelByProducingResumeData:^(NSData *resumeData)
         {
             partialDownload = resumeData; self.resumableTask = nil;
         }];
    }
}

上面方法中，我們把待恢復的數據保存到一個變量中，方便後面恢復下載使用。
當新創建一個下載任務的時候，除了使用一個新的請求，我們也可以使用待恢復的下載數據：

if(!self.resumableTask)

{
    if(partialDownload)
        
    {
        self.resumableTask = [inProcessSession downloadTaskWithResumeData:partialDownload];
    }
    
    else
       
    {
        NSString *url = @"http://url/for/image";
        NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:url]]; self.resumableTask = [inProcessSession downloadTaskWithRequest:request];
    }

    [self.resumableTask resume];

}

如果我們有這個partialDownload這個數據對象，就可以用它來創建一個新的任務。如果沒有，就按以前的步驟來創建任務。
記住：當使用partialDownload創建任務完成後，需要把partialDownload設置爲nil。

後臺下載
NSURLSession另一個重要的特性：即使當應用不在前臺時，你也可以繼續傳輸任務。當然，我們的會話模式也要爲後臺模式：

- (NSURLSession *)backgroundSession
{
    static NSURLSession *backgroundSession = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        NSURLSessionConfiguration *config = [NSURLSessionConfiguration backgroundSessionConfiguration:@"com.shinobicontrols.BackgroundDownload.BackgroundSession"];
        backgroundSession = [NSURLSession sessionWithConfiguration:config delegate:self delegateQueue:nil]; });
    return backgroundSession;
}

需要非常注意的是，通過給的後臺token，我們只能創建一個後臺會話，所以這裏使用dispatch once block。token的目的是爲了當應用重啓後，我們可以通過它獲取會話。創建一個後臺會話，會啓動一個後臺傳輸守護進程，這個進程會管理數據並傳輸給我們。即使當應用掛起或者終止，它也會繼續運行。

開啓後臺下載任務和之前一樣，所有的後臺功能都是NSURLSession自己管理的。

NSString *url = @"http://url/for/picture";
NSURLRequest *request = [NSURLRequest requestWithURL:[NSURL URLWithString:url]]; self.backgroundTask = [self.backgroundSession downloadTaskWithRequest:request]; [self.backgrounTask resume];

現在，即使你按home鍵離開應用，下載也會在後臺繼續（受開始提到的配置項控制）。

當下載完成後，你的應用將被重啓，並傳輸內容過來。
將會調用app delegate的這個方法：

-(void)application:(UIApplication *)application handleEventsForBackgroundURLSession:(NSString *)identifier completionHandler:(void (^)())completionHandler
{
    self.backgroundURLSessionCompletionHandler = completionHandler;
}

這裏，我們獲取內容通過completionHandler，當我們接收下載的數據並更新UI時會調用completionHandler。我們保存了 completionHandler（注意需要copy），讓正在加載的View Controller來處理數據。當View Controller加載成功後，創建後臺會話（並設置代理）。因此之前使用的相同代理方法就會被調用。

- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location
{ // Save the file off as before, and set it as an image view//...
    if (session == self.backgroundSession)
    {
        self.backgroundTask = nil;
        SCAppDelegate *appDelegate = (SCAppDelegate *)[[UIApplication sharedApplication] delegate];
        if(appDelegate.backgroundURLSessionCompletionHandler)
        { // Need to copy the completion handlervoid (^handler)() = appDelegate.backgroundURLSessionCompletionHandler; appDelegate.backgroundURLSessionCompletionHandler = nil;
            handler();
        }
    }
}

需要注意的幾個地方：
1. 不能用downloadTask和self.backgroundTask來比較。因爲我們不能確定self.backgroundTask是不是已經有了，有可能是應用新的一次重啓。比較session是可行的。
2. 這裏使用app delegate來獲取completion handler 的。其實，有很多方式來獲取completion handler 的。
3. 當保存完文件並顯示完成後，如果有completion handler，需要移除然後調用。這個是爲了告訴系統我們已經完成了，可以處理新的下載任務了。