版本记录

前言

我们做APP，文字和图片是绝对不可缺少的元素，特别是图片一般存储在图床里面，一般公司可以委托第三方保存，NB的公司也可以自己存储图片，ios有很多图片加载的第三方框架，其中最优秀的莫过于SDWebImage，它几乎可以满足你所有的需求，用了好几年这个框架，今天想总结一下。感兴趣的可以看其他几篇。
1. SDWebImage探究（一）
2. SDWebImage探究（二）
3. SDWebImage探究（三）
4. SDWebImage探究（四）
5. SDWebImage探究（五）
6. SDWebImage探究（六） —— 图片类型判断深入研究
7. SDWebImage探究（七） —— 深入研究图片下载流程（一）之有关option的位移枚举的说明
8. SDWebImage探究（八） —— 深入研究图片下载流程（二）之开始下载并返回下载结果的总的方法
9. SDWebImage探究（九） —— 深入研究图片下载流程（三）之下载之前的缓存查询操作
10. SDWebImage探究（十） —— 深入研究图片下载流程（四）之查询缓存后的block回调处理
11. SDWebImage探究（十一） —— 深入研究图片下载流程（五）之SDWebImageDownloadToken和操作对象的生成和返回
12. SDWebImage探究（十二） —— 深入研究图片下载流程（六）之下载器到具体下载操作的代理分发实现
13. SDWebImage探究（十三） —— 深入研究图片下载流程（七）之NSURLSession中几个代理的基本用法和关系
14. SDWebImage探究（十四） —— 深入研究图片下载流程（八）之下载完成代理方法的调用
15. SDWebImage探究（十五） —— 深入研究图片下载流程（九）之身份验证质询代理方法调用
16. SDWebImage探究（十六） —— 深入研究图片下载流程（十）之缓存相关代理方法调用

SDWebImageDownloaderOperation中收到响应代理方法

主要就是针对下边这段代码

- (void)URLSession:(NSURLSession *)session
          dataTask:(NSURLSessionDataTask *)dataTask
didReceiveResponse:(NSURLResponse *)response
 completionHandler:(void (^)(NSURLSessionResponseDisposition disposition))completionHandler {
    
    //'304 Not Modified' is an exceptional one
    if (![response respondsToSelector:@selector(statusCode)] || (((NSHTTPURLResponse *)response).statusCode < 400 && ((NSHTTPURLResponse *)response).statusCode != 304)) {
        NSInteger expected = (NSInteger)response.expectedContentLength;
        expected = expected > 0 ? expected : 0;
        self.expectedSize = expected;
        for (SDWebImageDownloaderProgressBlock progressBlock in [self callbacksForKey:kProgressCallbackKey]) {
            progressBlock(0, expected, self.request.URL);
        }
        
        self.imageData = [[NSMutableData alloc] initWithCapacity:expected];
        self.response = response;
        __weak typeof(self) weakSelf = self;
        dispatch_async(dispatch_get_main_queue(), ^{
            [[NSNotificationCenter defaultCenter] postNotificationName:SDWebImageDownloadReceiveResponseNotification object:weakSelf];
        });
    } else {
        NSUInteger code = ((NSHTTPURLResponse *)response).statusCode;
        
        //This is the case when server returns '304 Not Modified'. It means that remote image is not changed.
        //In case of 304 we need just cancel the operation and return cached image from the cache.
        if (code == 304) {
            [self cancelInternal];
        } else {
            [self.dataTask cancel];
        }
        __weak typeof(self) weakSelf = self;
        dispatch_async(dispatch_get_main_queue(), ^{
            [[NSNotificationCenter defaultCenter] postNotificationName:SDWebImageDownloadStopNotification object:weakSelf];
        });
        
        [self callCompletionBlocksWithError:[NSError errorWithDomain:NSURLErrorDomain code:((NSHTTPURLResponse *)response).statusCode userInfo:nil]];

        [self done];
    }
    
    if (completionHandler) {
        completionHandler(NSURLSessionResponseAllow);
    }
}

这段代码主要做下面这些工作：

• 收到响应数据response的状态码statusCode判断
  • 如果statusCode无法响应方法，或者小于400或者不等于304，那么进行处理，获取期望的图像数据大小，实例化imageData的NSData数据，并在主线程发出通知。
  • 如果statusCode不是上面的那几种情况就另外进行处理，针对code是否是304进行了区别的处理，并在主线程发出通知。调用callCompletionBlocksWithError:抛出错误异常，并调用done自定义方法初始化一些参数。
• 进行completionHandler回调。

下面我们就详细的看一下该代理中的功能实现。

response的状态码statusCode判断

1. if判断

首先判断response不能响应statusCode，或者statusCode小于400并且不等于304的情况。

(a) 获取期望的数据大小

这里首先获取期望的数据大小。

NSInteger expected = (NSInteger)response.expectedContentLength;
expected = expected > 0 ? expected : 0;
self.expectedSize = expected;
for (SDWebImageDownloaderProgressBlock progressBlock in [self callbacksForKey:kProgressCallbackKey]) {
    progressBlock(0, expected, self.request.URL);
}

直接利用response.expectedContentLength获取响应数据的大小。并且进行进度回调progressBlock(0, expected, self.request.URL);。

typedef void(^SDWebImageDownloaderProgressBlock)(NSInteger receivedSize, NSInteger expectedSize, NSURL * _Nullable targetURL);

(b) 实例化图像数据imageData

self.imageData = [[NSMutableData alloc] initWithCapacity:expected];

(c) 发送通知

接下来就是在主线程发送通知。

NSString *const SDWebImageDownloadReceiveResponseNotification = @"SDWebImageDownloadReceiveResponseNotification";

dispatch_async(dispatch_get_main_queue(), ^{
    [[NSNotificationCenter defaultCenter] postNotificationName:SDWebImageDownloadReceiveResponseNotification object:weakSelf];
});

2. else判断

(a) 获取状态码

NSUInteger code = ((NSHTTPURLResponse *)response).statusCode;

(b) 是否是304的逻辑处理

当服务器返回304 Not Modified时就是这种情况。 这意味着远程图像不会改变。在304的情况下，我们只需要取消操作并从缓存中返回缓存的图像。

if (code == 304) {
    [self cancelInternal];
} 
else {
    [self.dataTask cancel];
}

这里就是如果是304就取消操作。

- (void)cancelInternal {
    if (self.isFinished) return;
    [super cancel];

    if (self.dataTask) {
        [self.dataTask cancel];
        __weak typeof(self) weakSelf = self;
        dispatch_async(dispatch_get_main_queue(), ^{
            [[NSNotificationCenter defaultCenter] postNotificationName:SDWebImageDownloadStopNotification object:weakSelf];
        });

        // As we cancelled the connection, its callback won't be called and thus won't
        // maintain the isFinished and isExecuting flags.
        if (self.isExecuting) self.executing = NO;
        if (!self.isFinished) self.finished = YES;
    }

    [self reset];
}

- (void)reset {
    dispatch_barrier_async(self.barrierQueue, ^{
        [self.callbackBlocks removeAllObjects];
    });
    self.dataTask = nil;
    self.imageData = nil;
    if (self.ownedSession) {
        [self.ownedSession invalidateAndCancel];
        self.ownedSession = nil;
    }
}

如果不是304，那就是下载的其他问题，直接取消任务[self.dataTask cancel];。

(c) 发送通知

下面进行发送通知

__weak typeof(self) weakSelf = self;
dispatch_async(dispatch_get_main_queue(), ^{
    [[NSNotificationCenter defaultCenter] postNotificationName:SDWebImageDownloadStopNotification object:weakSelf];
});

(d) 回调出异常信息

还是调用那个callCompletionBlocksWithError:抛出异常。

(e) 调用自定义方法done初始化参数

这个done方法前面有介绍过，主要就是初始化一些参数，这里就不多说了。

进行completionHandler回调

这里回调有一个输入参数，是一个枚举值类型为NSURLSessionResponseDisposition。

typedef NS_ENUM(NSInteger, NSURLSessionResponseDisposition) {
    NSURLSessionResponseCancel = 0,                                      
    /* Cancel the load, this is the same as -[task cancel] */
    取消下载，这个和-[task cancel]方法是一样的
    
    NSURLSessionResponseAllow = 1,                                       
    /* Allow the load to continue */
    允许继续加载
    
    NSURLSessionResponseBecomeDownload = 2,                              
    /* Turn this request into a download */
    将请求转化为下载
    
    NSURLSessionResponseBecomeStream API_AVAILABLE(macos(10.11), ios(9.0), watchos(2.0), tvos(9.0)) = 3,  
    /* Turn this task into a stream task */
    将任务转化为流任务
} NS_ENUM_AVAILABLE(NSURLSESSION_AVAILABLE, 7_0);

这里给出回调

if (completionHandler) {
    completionHandler(NSURLSessionResponseAllow);
}

后记

本篇主要解析了接收到response的处理逻辑，根据状态码的不同进行了不同的处理，最后进行了completionHandler回调。