NSURLSession学习整理

时间  2021-08-14
标签 php html json 缓存 安全 服务器 markdown cookie 网络 session 栏目 网站开发 繁體版
原文   原文链接

前言

苹果在 iOS9 以后已经放弃了NSURLConnection，使用的是 iOS7 以后推出的 NSURLSession。php

NSURLSession 有以下优点：html

1.NSURLSession 支持 http2.0 协议json

2.在处理下载任务的时候，能够直接把数据下载到磁盘（经过配置） 3.支持后台下载|上传（经过配置） 4.同一个 session 发送多个请求，只需创建一次链接（复用了TCP） 5.提供了全局的 session 而且能够统一配置，使用更加方便 6.下载的时候是多线程异步处理，效率更高缓存

不少人都用过AFNetWorking和SDWebImage，其实底层就是封装了NSURLSession来请求任务。如今学习一下。安全

AFNetWorking 能够自动将服务端返回的 JSON 数据识别并解析出来，而使用 NSURLSession 则须要本身来完成。服务器

NSURLSession简介

NSURLSession 提供了与各类协议（如HTTP、HTTPS），以及进行交互的API。NSURLSession 类对象（会话对象）就是用于管理这种交互过程。它是一个高度可配置的容器，经过使用其提供的API，可进行管理控制。markdown

简单使用，实现基本的网络请求。cookie

NSURL *url = [NSURL URLWithString:@"http://....."];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *task = [session dataTaskWithURL:url  completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
   // handle  response
}];
[task resume];
复制代码

全部的NSURLSession 网络请求基本遵循如下几个步骤：网络

获取NSURLSession对象，经过session对象建立 task 任务，执行 task（task 默认是挂起的，经过resume执行）session

NSURLSession工做模式

NSURLSession有3种工做模式，不一样的工做模式解决不一样的网络请求场景。

  • 默认会话模式（default）

当你须要保存会话相关的caches、证书、cookies等是就使用default

  • 瞬时会话模式（ephemeral）

全部和会话相关的caches、证书、cookies等都被缓存在RAM中，当会话销毁，缓存的数据会被自动清空。（可实现私密浏览）

  • 后台会话模式（background）

须要在后台进行上传下载就用background 。它会返回一个后台 session。可在应用程序挂起、退出或崩溃状况下，运行上传和下载任务。

上述工做模式由NSURLSessionConfiguration决定的。其三种建立方式以下：

+ (NSURLSessionConfiguration *)defaultSessionConfiguration;  
+ (NSURLSessionConfiguration *)ephemeralSessionConfiguration;  
+ (NSURLSessionConfiguration *)backgroundSessionConfiguration:(NSString *)identifier; 
复制代码

NSURLSessionConfiguration提供了不少属性，从 指定可用网络，到 cookie，安全性，缓存策略，再到使用自定义协议，启动事件的设置，以及用于移动设备优化的几个新属性，能够找到几乎任何你想要进行配置的选项。

关于缓存：

default模式，能够将缓存存储在磁盘上。路径是沙盒路径下Library/Caches/bundid/Cache.db。还有一个常见的设置就是cachePolicy（缓存策略），它决定要不要从缓存中获取，好比request.cachePolicy = NSURLRequestUseProtocolCachePolicy

typedef NS_ENUM(NSUInteger, NSURLRequestCachePolicy)
{
    //对特定的 URL 请求使用网络协议中实现的缓存逻辑。这是默认的策略。
    NSURLRequestUseProtocolCachePolicy = 0,

    //数据须要从原始地址加载。不使用现有缓存。
    NSURLRequestReloadIgnoringLocalCacheData = 1,

    // 不只忽略本地缓存，同时也忽略代理服务器或其余中间介质目前已有的、协议容许的缓存。
    NSURLRequestReloadIgnoringLocalAndRemoteCacheData = 4, 

    NSURLRequestReloadIgnoringCacheData = NSURLRequestReloadIgnoringLocalCacheData,

    //不管缓存是否过时，先使用本地缓存数据。若是缓存中没有请求所对应的数据，那么从原始地址加载数据。
    NSURLRequestReturnCacheDataElseLoad = 2,

    //不管缓存是否过时，先使用本地缓存数据。若是缓存中没有请求所对应的数据，那么放弃从原始地址加载数据，请求视为失败（即：“离线”模式）。
    NSURLRequestReturnCacheDataDontLoad = 3,

    //从原始地址确认缓存数据的合法性后，缓存数据就可使用，不然从原始地址加载。
    NSURLRequestReloadRevalidatingCacheData = 5, 
};
复制代码

NSURLSession建立

提供了3种建立方法：

一、使用共享的会话，该会话使用全局的Cache，Cookie和证书。

+ (NSURLSession *)sharedSession;  
复制代码

二、经过NSURLSessionConfiguration配置来建立会话对象。

+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration;  
复制代码

三、经过设置NSURLSessionConfiguration配置、代理、队列来建立会话对象。

+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration delegate:(id <NSURLSessionDelegate>)delegate delegateQueue:(NSOperationQueue *)queue; 
复制代码

NSURLSessionTask

使用NSURLSession的是为了完成网络请求任务。

任务由NSURLSessionTask 这个抽象类封装，其子类封装了程序三个最基本的网络任务：获取数据（如 JSON 或者 XML），上传文件，下载文件。

NSURLSessionDataTask能够用来处理通常的网络请求如 GET 等。NSURLSessionUploadTask用于处理上传请求。NSURLSessionDownloadTask主要用于处理下载请求。

下面详细介绍下三种任务：

1. NSURLSessionDataTask

任务建立，可经过一个NSURLRequest或NSURL建立。

//这两个方法须要设置代理来接收数据
- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request;
- (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url;

//这两个方法在completionHandler来接收数据
- (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;
复制代码

请求任务完成时，它会带有相关联的数据，可经过代理，或Block方式处理回调数据。

（1）代理方式

#import "ViewController.h"

@interface ViewController ()<NSURLSessionDelegate,NSURLSessionTaskDelegate>
@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    // Do any additional setup after loading the view, typically from a nib.
    [self sendRequest];
}
- (void)sendRequest{
    //建立请求
    NSURL *url = [NSURL URLWithString:@"http://httpbin.org/get"];
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
    //设置request的缓存策略（决定该request是否要从缓存中获取）
    request.cachePolicy = NSURLRequestReturnCacheDataElseLoad;
    
    //建立配置（决定要不要将数据和响应缓存在磁盘）
    NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
    //configuration.requestCachePolicy = NSURLRequestReturnCacheDataElseLoad;
    
    //建立会话
    NSURLSession *session = [NSURLSession sessionWithConfiguration:configuration delegate:self delegateQueue:nil];
    //生成任务
    NSURLSessionDataTask *task = [session dataTaskWithRequest:request];
    //建立的task是中止状态，须要咱们去启动
    [task resume];
}
//1.接收到服务器响应的时候调用
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask
didReceiveResponse:(NSURLResponse *)response
 completionHandler:(void (^)(NSURLSessionResponseDisposition disposition))completionHandler{
    NSLog(@"接收响应");
    //必须告诉系统是否接收服务器返回的数据
    //默认是completionHandler(NSURLSessionResponseAllow)
    //能够再这边经过响应的statusCode来判断否接收服务器返回的数据
    completionHandler(NSURLSessionResponseAllow);
}
//2.接受到服务器返回数据的时候调用,可能被调用屡次
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data{
    NSLog(@"接收到数据");
    //通常在这边进行数据的拼接，在方法3才将完整数据回调
//    NSDictionary *dic = [NSJSONSerialization JSONObjectWithData:data options:0 error:nil];
}
//3.请求完成或者是失败的时候调用
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task
didCompleteWithError:(nullable NSError *)error{
    NSLog(@"请求完成或者是失败");
    //在这边进行完整数据的解析，回调
}
//4.将要缓存响应的时候调用（必须是默认会话模式，GET请求才能够）
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask
 willCacheResponse:(NSCachedURLResponse *)proposedResponse
 completionHandler:(void (^)(NSCachedURLResponse * _Nullable cachedResponse))completionHandler{
    //能够在这边更改是否缓存，默认的话是completionHandler(proposedResponse)
    //不想缓存的话能够设置completionHandler(nil)
    completionHandler(proposedResponse);
}
@end
复制代码

（2）Block方式（便捷、经常使用）

NSURL *url = [NSURL URLWithString:@"http://www.connect.com/login"];
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
request.HTTPMethod = @"POST";
request.HTTPBody = [@"username=Tom&pwd=123" dataUsingEncoding:NSUTF8StringEncoding];

//使用全局的会话
NSURLSession *session = [NSURLSession sharedSession];
// 经过request初始化task
NSURLSessionTask *task = [session dataTaskWithRequest:request
                                   completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) { 
    NSLog(@"%@", [NSJSONSerialization JSONObjectWithData:data options:kNilOptions error:nil]);
 }];
// 启动
[task resume];
复制代码

2. NSURLSessionUploadTask

继承自NSURLSessionDataTask。UploadTask只不过在Http请求的时候，把数据放到Http Body中。 NSURLSessionUploadTask经过request建立，在上传时指定文件源或数据源。

/=========代理方式===========/
//经过文件url来上传
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL;  
//经过文件data来上传
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(NSData *)bodyData;  
//经过文件流来上传
- (NSURLSessionUploadTask *)uploadTaskWithStreamedRequest:(NSURLRequest *)request;

/=========Block方式===========/
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL completionHandler:(void (^)(NSData *data, NSURLResponse *response, NSError *error))completionHandler;  
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(NSData *)bodyData completionHandler:(void (^)(NSData *data, NSURLResponse *response, NSError *error))completionHandler;  
复制代码

3种建立的区别：

NSData：若是对象已经在内存里 File：若是对象在磁盘上，这样作有助于下降内存使用 Stream：经过流对象，能够不用一次性将全部的流数据加载到内存中 不过使用Stream必定要实现URLSession:task:needNewBodyStream:，由于Session没办法在从新尝试发送Stream的时候找到数据源。

基本上传任务的使用： Uploadtask 的建立须要使用一个 request，另外加上一个要上传的 NSData 对象 或者是一个本地文件的路径对应的 NSURL：

NSURL *URL = [NSURL URLWithString:@"http://example.com/upload"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];
NSData *data = ...;

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionUploadTask *uploadTask = [session uploadTaskWithRequest:request
                                                            fromData:data
                                                   completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
         // ...
     }];

[uploadTask resume];
复制代码

上传图片的例子

- (void)uploadRequest{
    //建立请求
    NSMutableURLRequest * request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://www.freeimagehosting.net/upload.php"]];
    //若是是上传文字就是@"application/json"
    [request addValue:@"image/jpeg" forHTTPHeaderField:@"Content-Type"];
    [request addValue:@"text/html" forHTTPHeaderField:@"Accept"];
    [request setHTTPMethod:@"POST"];
    [request setCachePolicy:NSURLRequestReloadIgnoringCacheData];
    [request setTimeoutInterval:20];
    NSData * imagedata = UIImageJPEGRepresentation([UIImage imageNamed:@"person"],1.0);
    
    //建立配置（决定要不要将数据和响应缓存在磁盘）
    NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
    //建立会话
    NSURLSession *session = [NSURLSession sessionWithConfiguration:configuration delegate:self delegateQueue:nil];
    
    NSURLSessionUploadTask * uploadtask = [session uploadTaskWithRequest:request fromData:imagedata completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
        //发送完成的回调
        
    }];
    [uploadtask resume];
}
//发送数据过程当中会执行(执行屡次)
-(void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didSendBodyData:(int64_t)bytesSent totalBytesSent:(int64_t)totalBytesSent totalBytesExpectedToSend:(int64_t)totalBytesExpectedToSend{
    NSLog(@"发送数据中");
    //在这边监听发送的进度
    //progress = totalBytesSent/(float)totalBytesExpectedToSend
}
复制代码

3. NSURLSessionDownloadTask

下载文件能够实现断点下载 内部已经实现了数据边接收、边写入沙盒的操做（直接下载到磁盘） 支持BackgroundSession（后台下载）

Download task 也须要一个 request或者Url，不一样之处在于 completionHandler 这个 block。它是将数据一点点地写入本地的临时文件。因此在 completionHandler 里，须要把文件从一个临时地址，移动到一个永久的地址保存起来。而Datatask 和 uploadtask 会在任务完成时一次性返回。

NSURL *URL = [NSURL URLWithString:@"http://example.com/file.zip"];
NSURLRequest *request = [NSURLRequest requestWithURL:URL];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithRequest:request
                                                         completionHandler: ^(NSURL *location, NSURLResponse *response, NSError *error) {
        NSString *documentsPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
        NSURL *documentsDirectoryURL = [NSURL fileURLWithPath:documentsPath];
        NSURL *newFileLocation = [documentsDirectoryURL URLByAppendingPathComponent:[[response URL] lastPathComponent]];
        [[NSFileManager defaultManager] copyItemAtURL:location toURL:newFileLocation error:nil];
    }];

[downloadTask resume];
复制代码

普通下载过程： （代理方式，需遵照NSURLSessionDelegate,NSURLSessionDownloadDelegate）

- (void)downloadRequest{
    //建立请求
    NSMutableURLRequest * request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://httpbin.org/image/jpeg"]];
    
    //建立配置（决定要不要将数据和响应缓存在磁盘）
    NSURLSessionConfiguration *configuration = [NSURLSessionConfiguration defaultSessionConfiguration];
    //建立会话
    NSURLSession *session = [NSURLSession sessionWithConfiguration:configuration delegate:self delegateQueue:nil];
    
    NSURLSessionDownloadTask * downloadtask = [session downloadTaskWithRequest:request];
    [downloadtask resume];
}

//  代理回调方法
//1. downloadTask下载过程当中会执行
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didWriteData:(int64_t)bytesWritten totalBytesWritten:(int64_t)totalBytesWritten totalBytesExpectedToWrite:(int64_t)totalBytesExpectedToWrite{
    NSLog(@"下载中...");
    NSLog(@"写入数据大小%lld，总写入数据大小%lld，总指望数据大小%lld",bytesWritten,totalBytesWritten,totalBytesExpectedToWrite);
    //监听下载的进度
}
//2.downloadTask下载完成的时候会执行
- (void)URLSession:(NSURLSession *)session downloadTask:(NSURLSessionDownloadTask *)downloadTask didFinishDownloadingToURL:(NSURL *)location{
    NSLog(@"下载完成");
       //该方法内部已经完成了边接收数据边写沙盒的操做，解决了内存飙升的问题
    //对数据进行使用，或者保存（默认存储到临时文件夹 tmp 中，须要剪切文件到 cache）
    
    //保存
    NSString *filePath = [[NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject] stringByAppendingPathComponent:downloadTask.response.suggestedFilename];
    [[NSFileManager defaultManager] moveItemAtURL:location toURL:[NSURL fileURLWithPath:filePath] error:nil];

    //使用
    NSData * data = [NSData dataWithContentsOfURL:location.filePathURL];
    UIImage * image = [UIImage imageWithData:data];
    UIImageWriteToSavedPhotosAlbum(image, nil,nil,nil);
}
//3.请求完成或者是失败的时候调用(Session层次的Task完成的事件)
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task
didCompleteWithError:(nullable NSError *)error{
    NSLog(@"请求完成或者是失败");
}
复制代码

接下来了解一下，下载的API。除了经过url或request下载外，还能够经过以前已经下载的数据来建立下载任务（也就是断点续传）。一样地能够经过completionHandler指定任务完成后的回调代码块。

// 使用这种方式取消下载能够获得未来用来恢复的数据,保存起来
[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];

复制代码

  • 断点续传的前提是，服务器也支持断点续传。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程