NSURLSession 接口翻译 (一)
博客上篇文章时NSURLSessionConfiguration,这篇就到NSURLSession啦!
NSURLSession 类和相关类通过HTTP下载内容的API。该API提供了丰富的代理方法,用于支持身份验证,并使您的应用程序能够在您的应用程序未运行时执行后台下载,或者在iOS中停止应用时执行后台下载。 摘自官网
打开Xcode 类文档可以看到1000多行内容,下面就找一些我能力能看懂的来看吧。
@property (class, readonly, strong) NSURLSession *sharedSession; 实用的是全局共享的NSURLCache(缓存),NSHTTPCookieStorage(cookie),NSURLCredentialStorage(认证信息)
+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration; 通过configuration初始化一个URLSession 类的类方法 ,上一篇内容已经翻译了NSURLSessionConfiguration,用这个方法意味着不能用代理了和自定义的线程属性,因为这两个属性是只读的,下面会指出
+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration delegate:(nullable id)delegate delegateQueue:(nullable NSOperationQueue *)queue;//这个方法增加了代理,和线程。
@property (readonly, retain) NSOperationQueue *delegateQueue; //readonly!,线程
@property (nullable, readonly, retain) id<NSURLSessionDelegate>delegate;//只读,代理
@property (readonly, copy) NSURLSessionConfiguration *configuration;//只读,configuration
@property (nullable, copy) NSString *sessionDescription;//session的描述,需要自己添加描述,因为session 有可能公用的!
- (void)finishTasksAndInvalidate; //这个方法停止任务用的,立即执行,但是不会影响到正在执行的任务。不可以创建新的任务了。session的代理回调也会执行,除非执行了- (void)URLSession:(NSURLSession *)session didBecomeInvalidWithError:(nullable NSError *)error;这个方法!
在后台模式下,如果- (void)URLSession:(NSURLSession *)session didBecomeInvalidWithError:(nullable NSError *)error方法没执行,就利用相同的identifier 去创建新的session 是不安全的。(identifier创建后台模式的configuration)。实际测试:代理模式用一个session 重复加载2个任务,在完成的代理方法URLSession:downloadTask:didFinishDownloadingToURL:,第二个任务不会执行!,鉴于篇幅较大就不贴代码了!最后在URLSession:didBecomeInvalidWithError:方法里面释放代理session= nil,避免内存泄漏
- (void)invalidateAndCancel;//和上个方法类似,但是这个方法只要执行会取消所有任务,包括正在执行的,测试方法:代理模式用一个session 重复加载2个任务,在下载过程的方法里URLSession:downloadTask:didWriteData:totalBytesWritten:totalBytesExpectedToWrite: 里面加上[session invalidateAndCancel]会发现当前任务也被终止了,最后在URLSession:didBecomeInvalidWithError:方法里面释放代理session = nil,避免内存泄漏
- (void)resetWithCompletionHandler:(void (^)(void))completionHandler;//清空所有的cookies、cache、credential!
- (void)flushWithCompletionHandler:(void (^)(void))completionHandler;//清空当前缓存,
- (void)getTasksWithCompletionHandler:(void (^)(NSArray*dataTasks, NSArray*uploadTasks, NSArray*downloadTasks))completionHandler;//获取当前执行任务的task,但是不包括已经完成被释放了、失败的、或者被取消的
- (void)getAllTasksWithCompletionHandler:(void (^)(NSArray<__kindof NSURLSessionTask *> *tasks))completionHandler API_AVAILABLE(macos(10.11), ios(9.0), watchos(2.0), tvos(9.0));//iOS 9.0方法,获取所有的任务放在数组里面,注意事项和上一个方法相同
- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request;//开启一个任务请求,获取链接资源
- (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url;//直接从指定的url 获取资源
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL;//上传文件方法,从制定的NSURL 加载数据
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(NSData *)bodyData;//上传二进制的数据
- (NSURLSessionUploadTask *)uploadTaskWithStreamedRequest:(NSURLRequest *)request; //数据封装在request的HTTPBody/HTTPBodyStream 里面上传
- (NSURLSessionDownloadTask *)downloadTaskWithRequest:(NSURLRequest *)request; //通过request 下载
- (NSURLSessionDownloadTask *)downloadTaskWithURL:(NSURL *)url;//通过url 下载
- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData;//下载暂停之后,带上之前的下载的data 继续创建新任务下载 (怎样取消任务并且获取之前的data 利用cancelByProducingResumeData这个函数就可以!
- (NSURLSessionStreamTask *)streamTaskWithHostName:(NSString *)hostname port:(NSInteger)port;//通过tcp/ip协议和特点的主机hostname 和端口来建立长链接
- (NSURLSessionStreamTask *)streamTaskWithNetService:(NSNetService *)service;//和上面方法一样属于tcp/ip 场链接,只不过参数都封装在系统提供的NSNetService 类里面!