iOS-HTTP:NSURLSession类簇详解

苹果官方提供的用于加载网络资源的类,可以分为以下几大类


iOS-HTTP:NSURLSession类簇详解_第1张图片
URL loading system类簇
NSURLSession是iOS7新引进的类,用于取代NSURLConnection,一个NSURLSession可以管理多个task,提供了状态和进度属性,支持取消,挂起,重新开始任务;可以恢复失败、取消、挂起的任务。

使用方式为创建一个 NSURLConnection,然后使用这个NSURLConnection对象创建一个task,然后启动task。

NSURLSessionConfiguration *sessionConfiguration= [NSURLSessionConfiguration defaultSessionConfiguration];

NSURLSession *session = [NSURLSession 
sessionWithConfiguration:sessionConfiguration delegate:self delegateQueue:self.operationQueue];
NSURLSessionDataTask *task = [session dataTaskWithURL:[NSURL URLWithString:@""]];
[task resume];

处理响应,你可以简单的提供一个回调block,或者实现代理来处理。如果你提供了回调block,那么久不会调用代理的处理请求结果的方法了。

NSURLSession有3种类型,对应3种不同的配置

Default sessions:普通模式,会使用磁盘缓存以及钥匙串中的证书
Ephemeral session:无痕模式,不管是缓存还是证书都只会保存在内存中,在释放的时候就会被清空。
Background sessions:后台模式

使用NSURLSessionConfiguration类提供的类方法创建

iOS-HTTP:NSURLSession类簇详解_第2张图片
image.png

支持3种不同的task类型

Data task:使用NSData保存发送和接收数据,使用与数据量较小的情况(比如通常的业务接口请求),可以分很多次返回和结束一次性返回。
Download tasks:顾名思义,这种模式适用于下载大的文件,会直接保存到硬盘里面。并且支持后台下载。
Upload tasks: 上传模式,类似于下载模式,使用磁盘文件、支持后台模式。
Stream Task: 基于stream的任务。

提供block

利用session创建task的时候可以提供completionHandler,如果你提供 handler ,那么代理的关于处理请求结果的方法就不会被调用。

NSURLSessionDataTask *task = [session dataTaskWithURL:[NSURL URLWithString:urlStr] completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
        NSLog(@"completionHandler");
    }];

代理一览

iOS-HTTP:NSURLSession类簇详解_第3张图片
image.png

- (void)URLSession:(NSURLSession *)session didBecomeInvalidWithError:(nullable NSError *)error;
这个方法在session失效后会调用。
通过调用session的 finishTasksAndInvalidate会使其失效,并且等待session剩余的任务完成或者失败的时候就会调用此方法

- (void)URLSession:(NSURLSession *)session didReceiveChallenge:(NSURLAuthenticationChallenge *)challenge completionHandler:(void (^)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential * _Nullable credential))completionHandler
这个代理用来处理身份验证。在https通信中,可以在这里自定义处理是否信任服务器。如果你没有实现这个方法,就会调用
URLSession:task:didReceiveChallenge:completionHandler:

- (void)URLSessionDidFinishEventsForBackgroundURLSession:(NSURLSession *)session API_AVAILABLE(ios(7.0), watchos(2.0), tvos(9.0)) API_UNAVAILABLE(macos)
后台模式会用到

- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task willBeginDelayedRequest:(NSURLRequest *)request completionHandler:(void (^)(NSURLSessionDelayedRequestDisposition disposition, NSURLRequest * _Nullable newRequest))completionHandler API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0))
iOS11新增。
用于后台任务。这个方法告诉代理一个延迟的task(通过设置earliestBeginDate)要开始执行了
只有在等待网络或者需要被新的请求替代而导致当前请求可能会变过时的时候才需要实现这个方法
你需要调用此方法参数中的completionHandler,并提供disposition指示如何做下一步处理,
disposition提供3个值

NSURLSessionDelayedRequestContinueLoading: 继续执行
NSURLSessionDelayedRequestUseNewRequest: 用新的request替换旧的
NSURLSessionDelayedRequestCancel: 取消请求

disposition传NSURLSessionDelayedRequestCancel和直接调用task的cancel方法效果是一样。

- (void)URLSession:(NSURLSession *)session taskIsWaitingForConnectivity:(NSURLSessionTask *)task API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0))
iOS11新增,当前网络不可用的时候会调用,前提是 NSURLSessionConfiguration的waitsForConnectivity属性为YES.每个task只会最多调一次,并且只有当任务开始的时候网络不可用才有效。后台任务不会调用此方法。

- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task willPerformHTTPRedirection:(NSHTTPURLResponse *)response newRequest:(NSURLRequest *)request completionHandler:(void (^)(NSURLRequest * _Nullable))completionHandler
用于处理重定向,调用completionHandler决定怎么处理重定向。

- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didReceiveChallenge:(NSURLAuthenticationChallenge *)challenge completionHandler:(void (^)(NSURLSessionAuthChallengeDisposition disposition, NSURLCredential * _Nullable credential))completionHandler
用于处理身份认证,前面的URLSession:didReceiveChallenge:completionHandler: 为session级,这个为task级。
如果是session级的身份认证,则会先调session级的代理方法,如果没有提供session级的方法,就会调用task级的。
如果你需要自己处理身份认证,你必须2个方法都实现,

- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task needNewBodyStream:(void (^)(NSInputStream * _Nullable bodyStream))completionHandler
当需要新的body stream的时候会调用。只有才用stream的形式发起的请求才会调用此方法(用uploadTaskWithStreamedRequest:创建的task)。使用file url 或者NSData提供body的不会调用此方法。

- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didSendBodyData:(int64_t)bytesSent totalBytesSent:(int64_t)totalBytesSent totalBytesExpectedToSend:(int64_t)totalBytesExpectedToSend
通知代理请求body的发送进度

- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didFinishCollectingMetrics:(NSURLSessionTaskMetrics *)metrics API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0))
用来统计task生命期内的一些信息,统计信息保存在NSURLSessionTaskMetrics对象里面

iOS-HTTP:NSURLSession类簇详解_第4张图片
image.png

NSURLSessionTaskMetrics总共有3个属性

transactionMetrics:子过程的统计信息,类型为数组;比如重定向就有2个请求,这里就会有2条记录
taskInterval:task花费的时间
redirectCount:重定向的次数

- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(nullable NSError *)error
请求完成的回调,error为nil的代表请求成功,不为nil表示客户端发生了错误(比如地址不正确)。

NSURLSessionDataDelegate

- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveResponse:(NSURLResponse *)response completionHandler:(void (^)(NSURLSessionResponseDisposition disposition))completionHandler
当接受完服务器返回的响应头部分会调用此方法,调用completionHandler指示下一步工作,有4种处理方式
NSURLSessionResponseCancel = 0
NSURLSessionResponseAllow = 1,
NSURLSessionResponseBecomeDownload = 2,
NSURLSessionResponseBecomeStream = 3

- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didBecomeDownloadTask:(NSURLSessionDownloadTask *)downloadTask
如果你在- URLSession:dataTask:didReceiveResponse:completionHandler中决定把task从data task变为download task后,就会调用此代理,会给你提供新的task对象

- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didBecomeStreamTask:(NSURLSessionStreamTask *)streamTask
task类型变为stream时会调用此方法

- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data
告诉代理接收到了一些data

- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask willCacheResponse:(NSCachedURLResponse *)proposedResponse completionHandler:(void (^)(NSCachedURLResponse * _Nullable cachedResponse))completionHandler
当接受完所有的数据后,会调用此代理询问是否缓存此次请求的内容。如果没有实现此方法,默认就会使用session的configuration里面的缓存策略

NSURLSessionDownloadDelegate

- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location
通知代理 download task已经完成了,开发者注意在这里把文件从location移到合适的地方,应为如果不移动,location对应的文件会在方法返回的时候删除

- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite
用来通知跟新下载task的进度

- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didResumeAtOffset:(int64_t)fileOffset expectedTotalBytes:(int64_t)expectedTotalBytes
通知旧的下载任务恢复下载了
当一个可恢复的任务取消或者失败时,你可以保存resume data,然后将这为参数调用downloadTaskWithResumeData:downloadTaskWithResumeData:completionHandler:来创建新的task就可以在之前的进度上继续。此任务开始时就会调用这个代理方法。
resume data 的获取方式
1.通过调用task的-cancelByProducingResumeData:方法来取消
2.任务失败的时候,系统调会用任务完成的代理或block,从传过来的NSError对象的userInfo字典里面取key为NSURLSessionDownloadTaskResumeData的值

NSURLSessionStreamDelegate

- (void)URLSession:(NSURLSession *)session readClosedForStreamTask:(NSURLSessionStreamTask *)streamTask
通知底层socket的read端已经关闭了

- (void)URLSession:(NSURLSession *)session writeClosedForStreamTask:(NSURLSessionStreamTask *)streamTask
通知底层socket的write端已经关闭了

- (void)URLSession:(NSURLSession *)session betterRouteDiscoveredForStreamTask:(NSURLSessionStreamTask *)streamTask
通知代理一条更好的路由被发现了,你可以在这里创建新的stream task来利用新路由的优势

- (void)URLSession:(NSURLSession *)session streamTask:(NSURLSessionStreamTask *)streamTask didBecomeInputStream:(NSInputStream *)inputStream outputStream:(NSOutputStream *)outputStream
通知代理stream task完成了

你可能感兴趣的:(iOS-HTTP:NSURLSession类簇详解)