SDWebImage学习笔记之NSURLSession

NSURLSession概述

NSURLSession是从iOS7开始使用,用于替代NSURLConnection进行网络数据传输的类。著名的AFNetworking库的2.0版本采用的NSURLConnection,但是从3.0版本开始,已经用NSURLSession替换了NSURLConnection。

NSURLSession可以与delegate(代理)绑定,在一个会话的生命周期内,delegate会被某些事件调用,例如服务端认证或者确定加载的资源是否应该转化为下载。

NSURLSession实例是线程安全的,它会创建NSURLSessionTask对象来执行数据的加载。被创建的NSURLSessionTask对象初始化状态是suspend(挂起),需要调用resume(恢复)方法来执行。


NSURLSessionTask

NSURLSessionTask有四个子类:NSURLSessionDataTask、NSURLSessionUploadTask和NSURLSessionDownloadTask,NSURLSessionStreamTask。

  1. NSURLSessionDataTask用于执行普通的任务,例如请求或上传数据。
  2. NSURLSessionUploadTask继承自NSURLSessionUploadTask用于上传文件或数据到服务器。
  3. NSURLSessionDownloadTask会直接将响应数据写入临时文件,默认下载到沙盒的temp目录下。下载完成后,delegate会接收到URLSession:downloadTask:didFinishDownloadingToURL: 消息。
  4. NSURLSessionStreamTask用于建立一个 TCP/IP 连接,自iOS9以后开始使用。

NSURLSessionConfiguration

NSURLSessionConfiguration是NSURLSession的配置类,用于生成NSURLSession对象。
NSURLSessionConfiguration有三种初始化方式:

  1. defaultSessionConfiguration。返回的全局会话使用磁盘来缓存credential, cache and cookie。
  2. ephemeralSessionConfiguration。返回的临时会话使用内存而不使用磁盘来缓存credential, cache and cookie,app一旦退出,数据会被清空。
  3. backgroundSessionConfiguration。返回的后台
    会话可以在app被挂起时执行网络操作,但必须要传入一个NSString类型的identifier。

NSURLSession使用

NSURLSession提供了两种方法来创建会话:

+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration;
+ (NSURLSession *)sessionWithConfiguration:(NSURLSessionConfiguration *)configuration delegate:(nullable id <NSURLSessionDelegate>)delegate delegateQueue:(nullable NSOperationQueue *)queue;

第二个方法可以传入delegate来监听会话事件,delegate需要遵循NSURLSessionDelegate协议且会被强引用,还可以传入NSOperationQueue对象来指定delegate在哪个队列被调用,传入值为nil时,session会默认创建一个串行队列来执行delegate的方法。

创建完会话之后,需要创建一个任务来执行具体的网络传输操作。

// NSURLSessionDataTask
- (NSURLSessionDataTask *)dataTaskWithRequest:(NSURLRequest *)request;
- (NSURLSessionDataTask *)dataTaskWithURL:(NSURL *)url;

// NSURLSessionUploadTask
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromFile:(NSURL *)fileURL;
- (NSURLSessionUploadTask *)uploadTaskWithRequest:(NSURLRequest *)request fromData:(NSData *)bodyData;
- (NSURLSessionUploadTask *)uploadTaskWithStreamedRequest:(NSURLRequest *)request;

// NSURLSessionDownloadTask
- (NSURLSessionDownloadTask *)downloadTaskWithRequest:(NSURLRequest *)request;
- (NSURLSessionDownloadTask *)downloadTaskWithURL:(NSURL *)url;
- (NSURLSessionDownloadTask *)downloadTaskWithResumeData:(NSData *)resumeData;

// NSURLSessionStreamTask
- (NSURLSessionStreamTask *)streamTaskWithHostName:(NSString *)hostname port:(NSInteger)port API_AVAILABLE(macos(10.11), ios(9.0), tvos(9.0)) __WATCHOS_PROHIBITED;
- (NSURLSessionStreamTask *)streamTaskWithNetService:(NSNetService *)service API_AVAILABLE(macos(10.11), ios(9.0), tvos(9.0)) __WATCHOS_PROHIBITED;
普通任务获取资讯列表:
// 配置URL
NSURL *url = [NSURL URLWithString:@"http://toutiao-ali.juheapi.com/toutiao/index"];
// 配置URLRequest
NSMutableURLRequest *urlRequest = [NSMutableURLRequest requestWithURL:url];
[urlRequest setValue:@"APPCODE fd4e0a674e274e46ad3e26ab508ff21c" forHTTPHeaderField:@"Authorization"];
// 配置全局会话
NSURLSessionConfiguration *sessionConfiguration = [NSURLSessionConfiguration defaultSessionConfiguration];
NSURLSession *session = [NSURLSession sessionWithConfiguration:sessionConfiguration];
// 返回挂起的普通任务
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:urlRequest completionHandler:^(NSData * _Nullable data, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    // 解析数据
    NSString *string = [[NSString alloc]initWithData:data encoding:NSUTF8StringEncoding];
    NSLog(@"%@", string);
}];
// 恢复普通任务
[dataTask resume];

执行resume方法后任务才会开始加载数据,并在回调中返回响应,不然task永远是挂起状态。

下载任务下载图片资源:
// 配置URL
NSURL *url = [NSURL URLWithString:@"https://image.baidu.com/search/down?tn=download&word=download&ie=utf8&fr=detail&url=https%3A%2F%2Ftimgsa.baidu.com%2Ftimg%3Fimage%26quality%3D80%26size%3Db9999_10000%26sec%3D1530781485542%26di%3Dde29981bb7d210737be1a7da40acd236%26imgtype%3D0%26src%3Dhttp%253A%252F%252Fimg.sccnn.com%252Fbimg%252F338%252F27244.jpg&thumburl=https%3A%2F%2Fss1.bdstatic.com%2F70cFuXSh_Q1YnxGkpoWK1HF6hhy%2Fit%2Fu%3D4194403647%2C3630027324%26fm%3D27%26gp%3D0.jpg"];
// 配置全局会话
NSURLSessionConfiguration *sessionConfiguration = [NSURLSessionConfiguration defaultSessionConfiguration];
NSURLSession *session = [NSURLSession sessionWithConfiguration:sessionConfiguration delegate:self delegateQueue:nil];
// 返回挂起的下载任务
NSURLSessionDownloadTask *downloadTask = [session downloadTaskWithURL:url completionHandler:^(NSURL * _Nullable location, NSURLResponse * _Nullable response, NSError * _Nullable error) {
    // 返回沙盒tmp目录的临时文件
    NSLog(@"%@", location);
}];
// 恢复下载任务
[downloadTask resume];
通过代理方法实现数据加载
// 配置URL
NSURL *url = [NSURL URLWithString:@"https://image.baidu.com/search/down?tn=download&word=download&ie=utf8&fr=detail&url=https%3A%2F%2Ftimgsa.baidu.com%2Ftimg%3Fimage%26quality%3D80%26size%3Db9999_10000%26sec%3D1530781485542%26di%3Dde29981bb7d210737be1a7da40acd236%26imgtype%3D0%26src%3Dhttp%253A%252F%252Fimg.sccnn.com%252Fbimg%252F338%252F27244.jpg&thumburl=https%3A%2F%2Fss1.bdstatic.com%2F70cFuXSh_Q1YnxGkpoWK1HF6hhy%2Fit%2Fu%3D4194403647%2C3630027324%26fm%3D27%26gp%3D0.jpg"];
// 配置全局会话
NSURLSessionConfiguration *sessionConfiguration = [NSURLSessionConfiguration defaultSessionConfiguration];
// 传入代理对象
NSURLSession *session = [NSURLSession sessionWithConfiguration:sessionConfiguration delegate:self delegateQueue:nil];
// 返回挂起的普通任务,不用completionHandler返回数据
NSURLSessionDataTask *dataTask = [session dataTaskWithURL:url];
// 恢复下载任务
[dataTask resume];

会话初始化时将self作为代理对象传入,代理对象需要遵循NSURLSessionDataDelegate协议和NSURLSessionTaskDelegate协议,任务在执行过程中通知代理对象具体的执行步骤。

#pragma mark NSURLSessionDataDelegate

/**
 任务收到服务器的初始响应

 @param session 用户创建的会话
 @param dataTask 用户创建的数据任务
 @param response 服务器响应
 @param completionHandler 回调,告知系统是否继续传输
 */
- (void)URLSession:(NSURLSession *)session
          dataTask:(NSURLSessionDataTask *)dataTask
didReceiveResponse:(NSURLResponse *)response
 completionHandler:(void (^)(NSURLSessionResponseDisposition disposition))completionHandler
{
    // 是否允许继续传输数据
    NSURLSessionResponseDisposition disposition = NSURLSessionResponseAllow;
    // 响应内容的预期长度,若预期长度未知,返回-1
    NSInteger expected = (NSInteger)response.expectedContentLength;
    expected = expected > 0 ? expected : 0;
    // 不执行此行代码,默认取消传输
    completionHandler(disposition);
}

/**
 任务收到服务器返回的数据(可能多次调用)

 @param session 用户创建的会话
 @param dataTask 用户创建的数据任务
 @param data 当次返回的数据
 */
- (void)URLSession:(NSURLSession *)session dataTask:(NSURLSessionDataTask *)dataTask didReceiveData:(NSData *)data
{
    if (!self.jjData) {
        self.jjData = [[NSMutableData alloc] init];
    }
    // 拼接当次返回的数据
    [self.jjData appendData:data];
    // 计算当前总数据长度
    const NSInteger totalSize = self.jjData.length;
    NSLog(@"当前数据大小:%ld", totalSize);
}

#pragma mark NSURLSessionTaskDelegate

/**
 任务完成数据传输

 @param session 用户创建的会话
 @param task 用户创建的任务
 @param error 错误信息
 */
- (void)URLSession:(NSURLSession *)session task:(NSURLSessionTask *)task didCompleteWithError:(NSError *)error
{
    if (nil == error) {
        NSLog(@"总数据大小:%ld", self.jjData.length);
    }
}

假如需要实时显示加载进度,在
URLSession:dataTask:didReceiveResponse:responsecompletionHandler:方法中获取响应内容的预期大小,在URLSession:dataTask:didReceiveData:方法的中获取当前数据的大小,最后在URLSession:task:didCompleteWithError:方法中关闭加载进度。

除了resmue方法,URLSessionTask还提供了暂停和取消的方法。

// 暂停任务
- (void)suspend;
// 取消任务
- (void)cancel;


总结

学习NSURLSession的目的是为了之后学习SDWebImage的Downloader模块,Downloader是SDWebimage的核心模块,包含了两大类SDWebImageDownloader和SDWebImageDownloaderOperation。在学习SDWebImageDownloaderOperation时,会对NSURLSession的应用做进一步的阐述。

AFNetworking库也是基于NSURLSession封装的,等学习完SDWebImage的源码,笔者会研究AFNetworking的源码,希望今天的学习能起到一些帮助作用。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 200,392评论 5 470
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,258评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 147,417评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,992评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,930评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,199评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,652评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,327评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,463评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,382评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,432评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,118评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,704评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,787评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,999评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,476评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,057评论 2 341

推荐阅读更多精彩内容