NSURLSession使用详解

NSURLSession使用详解

1.前言

NSURLSession诞生于2013年，但其在前几年一直生活在NSURLConnection的阴影下，直到iOS9的出现，NSURLConnection被官方宣布弃用，才正式走向舞台。NSURLSession老程序员原来很少用，
NSURLConnection新程序员甚至不知道，还有些程序员只知道AFN。

2.相关类

a、NSURLSession

b、NSURLSessionConfiguration

c、NSURLSessionTask

3.NSURLSession的使用

使用NSURLSession,共分两步:

第一步 通过NSURLSession的实例创建task
第二步 执行task
task是什么东西？

NSURLSessionTask可以简单理解为任务:如数据请求任务,下载任务,上传任务and so on.我们使用的是他的子类们:

NSURLSessionTask(抽象类)
NSURLSessionDataTask（数据任务类）
NSURLSessionUploadTask（上传任务类）
NSURLSessionDownloadTask（下载任务类）

NSURLSessionDataTask

字面上看是和数据相关的任务,但其实dataTask完全可以胜任downloadTask和uploadTask的工作.这也是我们使用最多的task种类.

简单GET请求

如果请求的数据比较简单,也不需要对返回的数据做一些复杂的操作.那么我们可以使用带block

// 快捷方式获得session对象

NSURLSession *session = [NSURLSession sharedSession];

NSURL url = [NSURL URLWithString:@"http://ws.webxml.com.cn/WebServices/MobileCodeWS.asmx/getMobileCodeInfo?mobileCode=1330000&userID="];

// 通过URL初始化task,在block内部可以直接对返回的数据进行处理

NSURLSessionTask task = [session dataTaskWithURL:url

                               completionHandler:^(NSData data, NSURLResponse response, NSError error) {

    NSLog(@"%@", [NSJSONSerialization JSONObjectWithData:data options:0 error:nil]);

}];

 

// 启动任务

[task resume];

注意:所有类型的task都要调用resume方法才会开始进行请求.
简单POST请求
POST和GET的区别就在于request,所以使用session的POST请求和GET过程是一样的，区别就在于对request的处理。

NSURL url = [NSURL URLWithString:@"http://ws.webxml.com.cn/WebServices/MobileCodeWS.asmx/getMobileCodeInfo"];
NSMutableURLRequest request = [NSMutableURLRequest requestWithURL:url];
request.HTTPMethod = @"POST";
request.HTTPBody = [@"mobileCode=1330000&userID=" 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:0 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://ws.webxml.com.cn/WebServices/MobileCodeWS.asmx/getMobileCodeInfo?mobileCode=1330000&userID="]]];
// 启动任务
[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 {

    // 请求完成,成功或者失败的处理
}

注意:

关键点在代码注释里面都有提及,重要的地方再强调一下：
如果要使用代理方法,需要设置代理,但从NSURLSession的头文件发现session的delegate属性是只读的.因此设置代理要通过session的初始化方法赋值:sessionWithConfiguration:delegate:delegateQueue:其中:
configuration参数(文章开始提到的)需要传递一个配置,我们暂且使用默认的配置[NSURLSessionConfiguration defaultSessionConfiguration]就好;
delegateQueue参数表示协议方法将会在哪个队列(NSOperationQueue)里面执行.
NSURLSession在接收到响应的时候要先对响应做允许处理:completionHandler(NSURLSessionResponseAllow);,才会继续接收服务器返回的数据,进入后面的代理方法.值得一提的是,如果在接收响应的时候需要对返回的参数进行处理(如获取响应头信息等),那么这些处理应该放在前面允许操作的前面。
NSURLSessionDownloadTask
文件下载可以使用NSURLSessionDownloadTask这个子类。
简单下载
NSURLSessionDownloadTask同样提供了通过NSURL和NSURLRequest两种方式来初始化并通过block进行回调的方法.下面以NSURL初始化为例：

NSURLSession session = [NSURLSession sharedSession];

NSURL url = [NSURL URLWithString:@"http://bvideo.spriteapp.cn/video/2016/0601/574dddfa521ec_wpd.mp4"] ;

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];

注意: 需要注意的就是需要将下载到tmp文件夹的文件转移到需要的目录.原因在代码中已经贴出。
response.suggestedFilename是从相应中取出文件在服务器上存储路径的最后部分,如数据在服务器的url为http://bvideo.spriteapp.cn/video/2016/0601/574dddfa521ec_wpd.mp4，
那么其suggestedFilename就是574dddfa521ec_wpd.mp4。

断点下载

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];

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方式进行文件上传,所以较多使用第二种方式。
其他

此外,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;

+ (NSURLSessionConfiguration *)defaultSessionConfiguration;

+ (NSURLSessionConfiguration *)ephemeralSessionConfiguration;

+ (NSURLSessionConfiguration *)backgroundSessionConfigurationWithIdentifier:(NSString *)identifier

表示了NSURLSession几种不同的工作模式. 默认的配置会将缓存存储在磁盘上，第二种瞬时会话模式不会创建持久性存储的缓存,第三种后台会话模式允许程序在后台进行上传下载工作。