前言:iOS开发从业几年来一直没有好好总结下。现在把知识梳理一下,助人助己吧。
在NSURLConfiguration小节中讲到,NSURLConfiguration是创建NSURLSession的“设计图”,并讲了如何绘制设计图。这一节任务是根据设计图创建NSURLSession对象,并分析其属性和方法。
NSURLSession的所有的属性和方法按功能大致可分为三类:
- 创建NSURLSession对象
- 配置NSURLSession对象
- 使用NSURLSession对象
创建NSURLSession对象
创建NSURSession有三个创建的方法,下面将分别分析。
创建默认session对象
// 方法1
NSURLSession *session = NSURLSession.sharedSession;
默认的Session工厂方法,通过类属性sharedSession方法获得。通过此对象生成的task会共享全局的NSURLCache、NSHTTPCookieStorage和NSURLCredentialStorage。如果想配置自定义的configuration需要用下面的两个方法来生成NSURLSession对象。
创建个性化Session对象
使用单独的configuration对象可以创建个性化的session对象。系统为我们提供了下面两个方法:
// 方法2
+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration;
// 方法3
+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration
delegate:(id<NSURLSessionDelegate>)delegate
delegateQueue:(NSOperationQueue *)queue;
方法二创建的NSURLSession其cache、cookie和https校验证书将由NSURLConfiguration决定。方法三比方法二多的功能是创建的NSURLSession可以在指定的delegate中收到其回调方法。在回调方法中可以对通信过程中的每一步都做自定义处理。
session的通信过程都是在子线程进行的。所以block方法和delegate方法都会在子线程调用。如果delegateQueue传nil系统默认创建一个NSOperationQueue,所有的delegate方法的调用都将在默认的NSOperationQueue中处理。否则就在我们指定的NSOperationQueue中处理数据。当然我们配置NSOperationQueue时可以指定其并发数,如果并发数指定为1,与AFNetwork一样,那么同时就只能一个NSURLSessionTask对象进行收或发数据。关于这个将在AFNetwork篇中详细说明。
使用中的不同是方法1和方法2只能通过block完成数据的接收,只能得到数据接收的结果。方法3可以监控并修改整个数据交换的过程。
可以这么理解方法一内部调用的方法二,只是将Configuration传的是默认值。方法二是调用的方法三只是将delegate和delegateQueue设为了nil。伪码如下:
// 方法1伪码实现
+ (instancetype)sharedSession {
NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
return [self sessionWithConfiguration:configuration];
}
// 方法2伪码实现
+ (instancetype)sessionWithConfiguration:(NSURLSessionConfiguration*)configuration {
return [self sessionWithConfiguration:configuration delegate:nil delegateQueue:nil];
}
配置Session对象
说是配置session对象,其实不太准确。应该是配置和操作session对象,如果用上一节的比喻,session对象是负责生产和运输dataTask对象的工厂,那么下面的方法就是为工厂添加机器、开关等工作。这类方法大致分为两种:配置session对象,操作session对象。
配置session对象
配置session对象有以下四个属性:
- delegate
- delegatequeue
- configuration
- sessionDescription
除了sessionDescription外,其他的三个在生成session对象后都不可再更改,只可访问。其中configuration在上一节已经说过其作用。
配置了delegate并实现了delegate的方法,那么客户端和服务器通信的过程都会访问delegate。需要注意的是,即使采用block接受数据,delegate依旧会被调用部分。只是NSURLSessionTaskDelegate的方法不调用。具体过程会在下一节中讲到。
delegatequeue是确定delegate在哪个线程中调用。如不配置默认在全局线程中调用。
操作session对象
操作session对象有下面六个方法:
- (void)finishTasksAndInvalidate;
- (void)invalidateAndCancel;
- (void)resetWithCompletionHandler:(void (^)(void))completionHandler;
- (void)flushWithCompletionHandler:(void (^)(void))completionHandler;
- (void)getTasksWithCompletionHandler: (^)(NSArray<NSURLSessionDataTask *> *dataTasks, NSArray<NSURLSessionUploadTask *> *uploadTasks, NSArray<NSURLSessionDownloadTask *> *downloadTasks))completionHandler
- (void)getAllTasksWithCompletionHandler:(void (^)(NSArray<__kindof NSURLSessionTask *> *tasks))completionHandler
finishTaskAndInvalidate会等待应答返回或超时后才会让session失效。invalidateAndCancel会立即让session失效,并调用失败的delegate。其余四个方法都与完成时的completionHandler有关,不太常用,这里暂不讨论。
添加任务到session
创建session对象,完成了配置,终于其干活的地步了,即生成dataTask对象并发送。session有两种方式完成dataTask的数据交换:
- 通过block接收数据;
- 通过delegate接收数据;
查看NSURLSession文件时会发现剩下的一堆方法都是用作此功能的。接下来会说明这些方法的作用。
block接收数据
苹果提供了7个方法用来实现通过block接收数据。
官方称这些方法为便利方式添加Datatask到session。这里需要注意:
- 所有便利方法都是实例方法,所以必须要我们先生成session对象。苹果没有提供把datatask添加到默认session对象的方法。
- 该便利方法只会添加datatask到session,而不是发送请求。发送请求HIA需要用返回的DataTask对象手动调用resume。
这一堆方法中大致可分为三种:数据请求,数据上传,数据下载。
/*
* 数据请求的两个方法
*/
- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request completionHandler:(void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
- (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url completionHandler:(void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
/*
* 数据上传的两个方法
*/
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL completionHandler:(void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(nullable NSData *)bodyData completionHandler:(void (^)(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
/*
* 数据下载的三个方法
* When a download successfully completes,
* the NSURL will point to a file that must be read or
* copied during the invocation of the completion routine.
* The file will be removed automatically.
*/
- (NSURLSessionDownloadTask *)downloadTaskWithRequest:(NSURLRequest *)request completionHandler:(void (^)(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
- (NSURLSessionDownloadTask *)downloadTaskWithURL:(NSURL *)url completionHandler:(void (^)(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData completionHandler:(void (^)(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error))completionHandler;
上面介绍delegate时提到过,采用block接收数据时,如果session创建时配置了delegate也会调用delegate的方法。
delegate接受数据
苹果提供了10个方法用于delegate接收数据:2个数据数据请求,3个数据上传,3个数据下载,2个数据流方法。这里的方法与block唯一的不同就是请求的数据在delegate中接收。
数据请求方法
数据请求的两个方法,也是我们常用的两个方法:
- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request;
- (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url;
看苹果注释也可以注意到:POST请求必须用第一个方法;GET请求可以用第二个方法。下载的上传、下载、数据流不常用暂时不介绍了。
其余方法
数据上传、下载和数据流方法暂时没研究,以后有时间了再详细研究。
// 数据上传
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL;
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(NSData *)bodyData;
- (NSURLSessionUploadTask *)uploadTaskWithStreamedRequest:(NSURLRequest *)request;
// 数据下载
- (NSURLSessionDownloadTask *)downloadTaskWithRequest:(NSURLRequest *)request;
- (NSURLSessionDownloadTask *)downloadTaskWithURL:(NSURL *)url;
- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData;
// 数据流方法
- (NSURLSessionStreamTask *)streamTaskWithHostName:(NSString *)hostname port:(NSInteger)port NS_AVAILABLE(10_11, 9_0) __WATCHOS_PROHIBITED;
- (NSURLSessionStreamTask *)streamTaskWithNetService:(NSNetService *)service NS_AVAILABLE(10_11, 9_0) __WATCHOS_PROHIBITED;
不可缺少的request
在生成DataTask的过程中必定需要url以及request。NSURLSessionDataTask只代表了一次客户端与服务器的数据请求任务。每个任务的详细信息都需要由NSURLRequest对象来决定,比如请求方法POST/GET,请求头,请求体等。至于NSURLSessionDownloadTask和NSURLSessionUploadTask对NSURLRequest对象的要求比如是否忽略请求头,请求体等以后再详细探究。