SDWebImage学习笔记之NSURLSession

NSURLSession概述

NSURLSession是从iOS7开始用，使用于替代NSURLConnection进行网络数据传输的类。著名的AFNetworking库的2.0版本采使用的NSURLConnection，但是从3.0版本开始，已经使用NSURLSession替换了NSURLConnection。

NSURLSession可以与delegate(代理商)绑定，在一个会话的生命周期内，delegate会被某些事件调使用，例如服务端认证或者者确定加载的资源能否应该转化为下载。

NSURLSession实例是线程安全的，它会创立NSURLSessionTask对象来执行数据的加载。被创立的NSURLSessionTask对象初始化状态是suspend（挂起），需要调使用resume（恢复）方法来执行。

NSURLSessionTask

NSURLSessionTask有四个子类：NSURLSessionDataTask、NSURLSessionUploadTask和NSURLSessionDownloadTask，NSURLSessionStreamTask。

1. NSURLSessionDataTask使用于执行普通的任务，例如请求或者上传数据。
2. NSURLSessionUploadTask继承自NSURLSessionUploadTask使用于上传文件或者数据到服务器。
3. NSURLSessionDownloadTask会直接将响应数据写入临时文件，默认下载到沙盒的temp目录下。下载完成后，delegate会接收到URLSession:downloadTask:didFinishDownloadingToURL: 消息。
4. NSURLSessionStreamTask使用于建立一个 TCP/IP 连接，自iOS9以后开始用。

NSURLSessionConfiguration

NSURLSessionConfiguration是NSURLSession的配置类，使用于生成NSURLSession对象。
NSURLSessionConfiguration有三种初始化方式：

1. defaultSessionConfiguration。返回的全局会话用磁盘来缓存credential, cache and cookie。
2. ephemeralSessionConfiguration。返回的临时会话用内存而不用磁盘来缓存credential, cache and cookie，app一旦退出，数据会被清空。
3. backgroundSessionConfiguration。返回的后端
   会话可以在app被挂起时执行网络操作，但必需要传入一个NSString类型的identifier。

NSURLSession用

NSURLSession提供了两种方法来创立会话：

+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration;+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration delegate:(nullable id <NSURLSessionDelegate>)delegate delegateQueue:(nullable NSOperationQueue *)queue;

第二个方法可以传入delegate来监听会话事件，delegate需要遵循NSURLSessionDelegate协议且会被强引使用，还可以传入NSOperationQueue对象来指定delegate在哪个队列被调使用，传入值为nil时，session会默认创立一个串行队列来执行delegate的方法。

创立完会话之后，需要创立一个任务来执行具体的网络传输操作。

// NSURLSessionDataTask- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request;- (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url;// NSURLSessionUploadTask- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL;- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(NSData *)bodyData;- (NSURLSessionUploadTask *)uploadTaskWithStreamedRequest:(NSURLRequest *)request;// NSURLSessionDownloadTask- (NSURLSessionDownloadTask *)downloadTaskWithRequest:(NSURLRequest *)request;- (NSURLSessionDownloadTask *)downloadTaskWithURL:(NSURL *)url;- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData;// NSURLSessionStreamTask- (NSURLSessionStreamTask *)streamTaskWithHostName:(NSString *)hostname port:(NSInteger)port API_AVAILABLE(macos(10.11), ios(9.0), tvos(9.0)) __WATCHOS_PROHIBITED;- (NSURLSessionStreamTask *)streamTaskWithNetService:(NSNetService *)service API_AVAILABLE(macos(10.11), ios(9.0), tvos(9.0)) __WATCHOS_PROHIBITED;

普通任务获取资讯列表：

// 配置URLNSURL *url = [NSURL URLWithString:@"http://toutiao-ali.juheapi.com/toutiao/index"];// 配置URLRequestNSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:url];[urlRequest setValue:@"APPCODE fd4e0a674e274e46ad3e26ab508ff21c" forHTTPHeaderField:@"Authorization"];// 配置全局会话NSURLSessionConfiguration *sessionConfiguration = [NSURLSessionConfiguration defaultSessionConfiguration];NSURLSession *session = [NSURLSession sessionWithConfiguration:sessionConfiguration];// 返回挂起的普通任务NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {    // 解析数据    NSString *string = [[NSString alloc]initWithData:data encoding:NSUTF8StringEncoding];    NSLog(@"%@", string);}];// 恢复普通任务[dataTask resume];

执行resume方法后任务才会开始加载数据，并在回调中返回响应，不然task永远是挂起状态。

下载任务下载图片资源：

// 配置URLNSURL *url = [NSURL URLWithString:@"https://alpic.fanquanwang.com/kx3x/uppic/tgr5qtqwtlk15611669.jpg&thumburl=https%3A%2F%2Fss1.bdstatic.com%2F70cFuXSh_Q1YnxGkpoWK1HF6hhy%2Fit%2Fu%3D4194403647%2C3630027324%26fm%3D27%26gp%3D0.jpg"];// 配置全局会话NSURLSessionConfiguration *sessionConfiguration = [NSURLSessionConfiguration defaultSessionConfiguration];NSURLSession *session = [NSURLSession sessionWithConfiguration:sessionConfiguration delegate:self delegateQueue:nil];// 返回挂起的下载任务NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:url completionHandler:^(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error) {    // 返回沙盒tmp目录的临时文件    NSLog(@"%@", location);}];// 恢复下载任务[downloadTask resume];

通过代理商方法实现数据加载

// 配置URLNSURL *url = [NSURL URLWithString:@"https://alpic.fanquanwang.com/kx3x/uppic/tgr5qtqwtlk15611669.jpg&thumburl=https%3A%2F%2Fss1.bdstatic.com%2F70cFuXSh_Q1YnxGkpoWK1HF6hhy%2Fit%2Fu%3D4194403647%2C3630027324%26fm%3D27%26gp%3D0.jpg"];// 配置全局会话NSURLSessionConfiguration *sessionConfiguration = [NSURLSessionConfiguration defaultSessionConfiguration];// 传入代理商对象NSURLSession *session = [NSURLSession sessionWithConfiguration:sessionConfiguration delegate:self delegateQueue:nil];// 返回挂起的普通任务，不使用completionHandler返回数据NSURLSessionDataTask *dataTask = [session dataTaskWithURL:url];// 恢复下载任务[dataTask resume];

会话初始化时将self作为代理商对象传入，代理商对象需要遵循NSURLSessionDataDelegate协议和NSURLSessionTaskDelegate协议，任务在执行过程中通知代理商对象具体的执行步骤。

#pragma mark NSURLSessionDataDelegate/** 任务收到服务器的初始响应 @param session 使用户创立的会话 @param dataTask 使用户创立的数据任务 @param response 服务器响应 @param completionHandler 回调，告知系统能否继续传输 */- (void)URLSession:(NSURLSession *)session          dataTask:(NSURLSessionDataTask *)dataTaskdidReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition disposition))completionHandler{    // 能否允许继续传输数据    NSURLSessionResponseDisposition disposition = NSURLSessionResponseAllow;    // 响应内容的预期长度，若预期长度未知，返回-1    NSInteger expected = (NSInteger)response.expectedContentLength;    expected = expected > 0 ? expected : 0;    // 不执行此行代码，默认取消传输    completionHandler(disposition);}/** 任务收到服务器返回的数据（可能屡次调使用） @param session 使用户创立的会话 @param dataTask 使用户创立的数据任务 @param data 当次返回的数据 */- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data{    if (!self.jjData) {        self.jjData = [[NSMutableData alloc] init];    }    // 拼接当次返回的数据    [self.jjData appendData:data];    // 计算当前总数据长度    const NSInteger totalSize = self.jjData.length;    NSLog(@"当前数据大小：%ld", totalSize);}#pragma mark NSURLSessionTaskDelegate/** 任务完成数据传输 @param session 使用户创立的会话 @param task 使用户创立的任务 @param error 错误信息 */- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error{    if (nil == error) {        NSLog(@"总数据大小：%ld", self.jjData.length);    }}

如果需要实时显示加载进度，在
URLSession:dataTask:didReceiveResponse:responsecompletionHandler:方法中获取响应内容的预期大小，在URLSession:dataTask:didReceiveData:方法的中获取当前数据的大小，最后在URLSession:task:didCompleteWithError:方法中关闭加载进度。

除了resmue方法，URLSessionTask还提供了暂停和取消的方法。

// 暂停任务- (void)suspend;// 取消任务- (void)cancel;

总结

学习NSURLSession的目的是为了之后学习SDWebImage的Downloader板块，Downloader是SDWebimage的核心板块，包含了两大类SDWebImageDownloader和SDWebImageDownloaderOperation。在学习SDWebImageDownloaderOperation时，会对NSURLSession的应使用做进一步的阐述。

AFNetworking库也是基于NSURLSession封装的，等学习完SDWebImage的源码，笔者会研究AFNetworking的源码，希望今天的学习能起到少量帮助作使用。