一. 背景
NSURLSession是苹果在iOS7后推出的通过HTTP协议下载数据的API,该类提供了大量的代理方法，来支持认证和后台下载功能。
使用NSURLSession须知：
a> 我们的应用会创建一系列的对话，每个对话负责一组的数据传输任务，并且会添加一系列的任务，每个任务代表着一个URL请求。
b> NSURLSession的API是异步的。
c> NSURLSession的使用分成：1.系统代理的方式（需要提供一个请求完成后处理的block）2. 自定义代理的方式（执行代理方法来处理请求成功或失败）
d> NSURLSession支持取消、恢复、挂起操作，以及断掉续传的功能
二. NSURLSession
NSURLSession根据配置对象（NSURLSessionConfiguration）分为三大类型
- 默认会话（defaultSessionConfiguration）：存储cookie(缓存)在磁盘中，存储证书在用户keychain
- 后台会话（backgroundSessionConfiguration）：存储cookie(缓存)在磁盘中，存储证书在用户keychain。后台会添加独立的进程来处理数据传输任务
- 短暂会话（ephemeralSessionConfiguration）：缓存和证书都存在RAM中，会话结束，它们就自动释放
任务类型也分为三大类
- dataTask:使用NSData对象进行上传和下载数据；数据可一次性返回，也可以分片段返回；返回的数据不是进行文件存储，所以不支持后台会话（iOS8后支持 备注：主要用于一些小数据请求，或大文件的断点续传下载
- downloadTask:以文件的形式接收数据，当程序不运行时支持后台下载
- uploadTask:以文件的形式上传数据，支持后台下载
简单使用
1. 系统代理的方式
a>. dataTask
// 1.创建NSURLSession单例对象
NSURLSession *session = [NSURLSession sharedSession];
// 2.添加dataTask任务（1>. 通过NSURLRequest方式 ；2>. 通过NSURL方式（内部进行封装成NSURLRequest对象））
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://xxx"]];
/*
POST请求请加这两句
request.HTTPMethod = @"POST";
request.HTTPBody = [@"参数" dataUsingEncoding:NSUTF8StringEncoding];
*/
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
/*
data:请求成功后返回的数据
response：请求头
error:如果有值说明请求失败
*/
}];
//或则
// NSURLSessionDataTask *dataTask = [session dataTaskWithURL:[NSURL URLWithString:@"http://xxx"] completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
//
// }];
// 3.开始任务
[dataTask resume];
b>. downLoadTask
内部已经实现边下载边写入temp文件中，由于temp中的文件易清除，所以须手动将文件剪切到合适的沙河目录 缺点：无法监控下载进度
// 1.创建NSURLSession单例对象
NSURLSession *session = [NSURLSession sharedSession];
// 2.添加downloadTask任务（1>. 通过NSURLRequest方式 ；2>. 通过NSURL方式（内部进行封装成NSURLRequest对象））
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://xxx"]];
/*
POST请求请加这两句
request.HTTPMethod = @"POST";
request.HTTPBody = [@"参数" dataUsingEncoding:NSUTF8StringEncoding];
*/
NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithRequest:request completionHandler:^(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error) {
/*
location:下载的文件的保存地址,默认是temp
*/
}];
//或则
// NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:[NSURL URLWithString:@"http://xxx"] completionHandler:^(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error) {
//
// }];
// 3.开始任务
[downloadTask resume];
c>. upLoadTask
// 1.创建NSURLSession单例对象
NSURLSession *session = [NSURLSession sharedSession];
// 2.添加uploadTask任务
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://xxx"]];
NSURLSessionUploadTask *uploadTask = [session uploadTaskWithRequest:request fromFile:[NSURL URLWithString:@"daf.af.af.3422"] completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
}];
// 3.开始任务
[uploadTask resume];
2.通过设置配置实现代理方法的方式
a>. dataTask下载文件
// 1.创建默认配置的NSURLSession对象
NSURLSession *session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[NSOperationQueue mainQueue]];
/*
NSURLSessionConfiguration：session对象的全局配置设置，一般使用默认配置就可以
delegate：设置代理
delegateQueue：代理方法在哪个队列中执行（在哪个线程中调用）,如果是主队列那么在主线程中执行，如果是非主队列，那么在子线程中执行
*/
// 2.创建一个Task, 请求方法为get和post均可
NSURLSessionDataTask *dataTask = [session dataTaskWithURL:[NSURL URLWithString:@"http://xxxx"]];
// 3.执行任务（可暂停、取消、恢复等）
[dataTask resume]; // [dataTask suspend] [dataTask cancel];
// 4. 遵守代理协议，实现代理方法（3个相关的代理方法）
/* 1.当接收到服务器响应的时候调用 */
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition))completionHandler {
// 通过该block回调，告诉服务器端是否接收返回的数据
completionHandler(NSURLSessionResponseAllow);
/*
NSURLSessionResponseCancel = 0, 取消任务
NSURLSessionResponseAllow = 1, 接收任务
NSURLSessionResponseBecomeDownload = 2, 转变成下载
NSURLSessionResponseBecomeStream NS_ENUM_AVAILABLE(10_11, 9_0) = 3, 转变成流
*/
}
/* 2.当接收到服务器返回的数据时调用 该方法可能会被调用多次 */
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data {
}
/* 3.当请求完成之后调用该方法 不论是请求成功还是请求失败都调用该方法，如果请求失败，那么error对象有值，否则那么error对象为空 */
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error {
}
b>. downloadTask下载文件
和dataTask一样只是代理方法有所区别
// 4. 遵守代理协议，实现代理方法（3个相关的代理方法）
/* 1.可以在该方法中监听文件下载的进度，该方法会被调用多次
*/
-(void)URLSession:(nonnull NSURLSession *)session downloadTask:(nonnull NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite {
}
/* 2.恢复下载的时候调用该方法 */
-(void)URLSession:(nonnull NSURLSession *)session downloadTask:(nonnull NSURLSessionDownloadTask *)downloadTask didResumeAtOffset:(int64_t)fileOffset expectedTotalBytes:(int64_t)expectedTotalBytes {
}
/* 3.下载完成之后调用该方法 */
-(void)URLSession:(nonnull NSURLSession *)session downloadTask:(nonnull NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(nonnull NSURL *)location {
}
/* 4.请求完成之后调用如果请求失败，那么error有值 */
-(void)URLSession:(nonnull NSURLSession *)session task:(nonnull NSURLSessionTask *)task didCompleteWithError:(nullable NSError *)error {
}
注意：
- 如果通过［downloadTask cancel]取消任务，那么任务不能恢复了
- 通过以下方法暂停，那么该方法会以resumeData保存当前文件的已经下载数据，任务可以恢复下载
[self.downloadTask cancelByProducingResumeData:^(NSData * __nullable resumeData) {
self.resumeData = resumeData;
}];
恢复下载方法
self.downloadTask=[self.session downloadTaskWithResumeData:self.resumeData];
[self.downloadTask resume];
- 缺点
01 如果用户点击暂停之后退出程序，那么需要把恢复下载的数据写一份到沙盒，代码复杂度更
02 如果用户在下载中途未保存恢复下载数据即退出程序，则不具备可操作性
c>. uploadTask上传文件
//1.创建session
self.session = [NSURLSession sessionWithConfiguration:[NSURLSessionConfiguration defaultSessionConfiguration] delegate:self delegateQueue:[NSOperationQueue mainQueue]];
//2.创建task
//2.1 创建请求对象
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://xxxxx"]];
//2.2 设置请求方法
request.HTTPMethod = @"POST";
//2.3.设置请求头
NSString *header = [NSString stringWithFormat:@"multipart/form-data; boundary=%@",str];
[request setValue:header forHTTPHeaderField:@"Content-Type"];
//2.4设置文件上传的文件内容
NSURLSessionUploadTask *uploadTask = [self.session uploadTaskWithRequest:request fromData:data];
[uploadTask resume];
// 4. 遵守代理协议，实现代理方法
-(void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didSendBodyData:(int64_t)bytesSent totalBytesSent:(int64_t)totalBytesSent totalBytesExpectedToSend:(int64_t)totalBytesExpectedToSend
{
}
-(void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
{
}
后台会话
当我们的运用退出，如果后台下载任务完成或则需要证书时，后台自动重启我们的运用，同时调用UIApplicationDelegate对象application:handlerEventsForBackgroundURLSession:completionHandler:方法，这个方法会提供session的标识，然后我们要利用session的标识创建后台配置，继而创建新的后台会话，与后台的activity关联。当后台下载任务完成时，会调用后台session的代理方法URLSessioinDidFinishEventsForBackgroundURLSession:然后调用存储的完成处理
如果在程序挂起时有任何任务完成，则会调用URLSession:downloadTask:didFinishDownloadingToURL:方法。同样的，如果任务需要证书，则NSURLSession对象会在适当的时候调用URLSession:task:didReceiveChallenge:completionHandler: 和URLSession:didReceiveChallenge:completionHandler:方法。
(void)application:(UIApplication *)application handleEventsForBackgroundURLSession:(NSString *)identifier completionHandler:(void (^)())completionHandler
{
NSURLSessionConfiguration *backgroundConfigObject = [NSURLSessionConfiguration backgroundSessionConfiguration:identifier];
URLSession *sessionDelegate = [[URLSession alloc] init];
NSURLSession *backgroundSession = [NSURLSession sessionWithConfiguration:backgroundConfigObject
delegate:sessionDelegate
delegateQueue:[NSOperationQueue mainQueue]];
[sessionDelegate addCompletionHandler:completionHandler forSession:identifier];
}
- (void)URLSessionDidFinishEventsForBackgroundURLSession:(NSURLSession *)session
{
NSLog(@"background url session %@", session);
if (session.configuration.identifier)
{
[self callCompletionHandlerForSession:session.configuration.identifier];
}
}
- (void)callCompletionHandlerForSession:(NSString *)identifier
{
CompletionHandlerType handler = [self.completionHandlerDictionary objectForKey:identifier];
if (handler) {
[self.completionHandlerDictionary removeObjectForKey:identifier];
handler();
}
}
注意：
NSURLSession对象的释放
-(void)dealloc {
//在最后的时候应该把session释放，以免造成内存泄露
// NSURLSession设置过代理后，需要在最后（比如控制器销毁的时候）调用session的invalidateAndCancel或者resetWithCompletionHandler，才不会有内存泄露
// [self.session invalidateAndCancel];
[self.session resetWithCompletionHandler:^{
NSLog(@"释放---");
}];
