SDWebImage 源码阅读（二）

最新推荐文章于 2023-05-21 21:33:39 发布
原创 最新推荐文章于 2023-05-21 21:33:39 发布 · 348 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#SDWebImage #源码阅读 #manager

本文详细解析了 SDWebImage 框架中的 SDWebImageManager 类如何处理图片的缓存与下载流程，包括从缓存获取图片、发起网络请求、图片处理及最终的回调过程。

我们在上一篇文章介绍了 SDWebImage 框架的 UIImageView+WebCache 扩展类，主要功能就是设计了严密的判断，保证运用该框架的其他开发者能够在各种环境下获取图片。这篇文章主要是介绍 SDWebImageManager 中从缓存获取图片或者从网络下载图片。

第一部分：获取图片对应的 key

- (id <SDWebImageOperation>)downloadImageWithURL:(NSURL *)url options:(SDWebImageOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageCompletionWithFinishedBlock)completedBlock {
    // Invoking this method without a completedBlock is pointless
    // 调用这个方法必须实现 completedblock
    NSAssert(completedBlock != nil, @"If you mean to prefetch the image, use -[SDWebImagePrefetcher prefetchURLs] instead");


    // 下面两段代码都是为了保护 url 逻辑性


    // Very common mistake is to send the URL using NSString object instead of NSURL. For some strange reason, XCode won't
    // throw any warning for this type mismatch. Here we failsafe this error by allowing URLs to be passed as NSString.
    if ([url isKindOfClass:NSString.class]) {
        url = [NSURL URLWithString:(NSString *)url];
    }

    // Prevents app crashing on argument type error like sending NSNull instead of NSURL
    if (![url isKindOfClass:NSURL.class]) {
        url = nil;
    }


    // 创建一个 operation 
    __block SDWebImageCombinedOperation *operation = [SDWebImageCombinedOperation new];
    __weak SDWebImageCombinedOperation *weakOperation = operation;

    // 判断当前的url，是否包含在下载失败的url集合中，在访问failedURLs集合时要加锁，防止其他线程对其进行操作
    BOOL isFailedUrl = NO;

    @synchronized (self.failedURLs) {
        isFailedUrl = [self.failedURLs containsObject:url];
    }

    // 如果url为空 || url存在于下载失败url集合中并且不是下载失败后重新下载，那么抛出错误
    if (url.absoluteString.length == 0 || (!(options & SDWebImageRetryFailed) && isFailedUrl)) {

        dispatch_main_sync_safe(^{
            NSError *error = [NSError errorWithDomain:NSURLErrorDomain code:NSURLErrorFileDoesNotExist userInfo:nil];
            completedBlock(nil, error, SDImageCacheTypeNone, YES, url);
        });
        return operation;
    }

    // 将 operation 加到运行中的url集合中
    @synchronized (self.runningOperations) {
        [self.runningOperations addObject:operation];
    }
    // 从缓存中根据url取出key（其实key就是url的string）
    NSString *key = [self cacheKeyForURL:url];

    // 根据key去查找对应的图片 ？？？
    operation.cacheOperation = [self.imageCache queryDiskCacheForKey:key done:^(UIImage *image, SDImageCacheType cacheType) {  
    ...  // 详情见 第二部分
}];
    return operation;
}

第二部分：根据 image 判断是否需要从网络获取

    operation.cacheOperation = [self.imageCache queryDiskCacheForKey:key done:^(UIImage *image, SDImageCacheType cacheType) {  
    ...          
}];

上面的代码调用了 SDImageCache 中的 queryDiskCacheForKey: done: 方法，我们后续章节再研究这个类中的东西，我们先看看对这个方法中的 block 的处理，也就是结果的处理方法：

// 判断该任务是否已经cancel了
if (operation.isCancelled) {
    @synchronized (self.runningOperations) {
        [self.runningOperations removeObject:operation];
    }

    return;
}


// 先看 && 的后半段
// 注意后面的 A || B，如果 A 为真，那就不用判断 B 了
// 也就是说，如果 imageManager:shouldDownloadImageForURL: 方法没有实现，直接返回 YES
// 目前我在源码中并没有看到函数的实现，所以就当 if 的后半段恒为 YES
// 我们主要看 && 前面的 || 表达式
// 如果缓存中没找到 image，或者需要刷新内存，就执行 if 语句
if ((!image || options & SDWebImageRefreshCached) && (![self.delegate respondsToSelector:@selector(imageManager:shouldDownloadImageForURL:)] || [self.delegate imageManager:self shouldDownloadImageForURL:url])) {
    ...  // 详情见第三部分
}

// 从缓存中找到 image
else if (image) {
    dispatch_main_sync_safe(^{
        __strong __typeof(weakOperation) strongOperation = weakOperation;
        if (strongOperation && !strongOperation.isCancelled) {
            completedBlock(image, nil, cacheType, YES, url);
        }
    });

    // 将该 operation 从数组中移除
    @synchronized (self.runningOperations) {
        [self.runningOperations removeObject:operation];
    }
}
else {
    // Image not in cache and download disallowed by delegate
    // 又没有从缓存中获取到图片，shouldDownloadImageForURL 又返回 NO，不允许下载，悲催！
    // 所以 image 和 error 均传入 nil
    dispatch_main_sync_safe(^{
        __strong __typeof(weakOperation) strongOperation = weakOperation;
        if (strongOperation && !weakOperation.isCancelled) {
            completedBlock(nil, nil, SDImageCacheTypeNone, YES, url);
        }
    });
    @synchronized (self.runningOperations) {
        [self.runningOperations removeObject:operation];
    }
}

第三部分：初始化下载图片

if ((!image || options & SDWebImageRefreshCached) && (![self.delegate respondsToSelector:@selector(imageManager:shouldDownloadImageForURL:)] || [self.delegate imageManager:self shouldDownloadImageForURL:url])) {
    ...  
}

上面判断 if 中实现的内容就是 image 需要网络获取部分，详情如下：

if (image && options & SDWebImageRefreshCached) {
   dispatch_main_sync_safe(^{
        // If image was found in the cache but SDWebImageRefreshCached is provided, notify about the cached image
        // AND try to re-download it in order to let a chance to NSURLCache to refresh it from server.
        // 如果图片在缓存中找到，但是options中有SDWebImageRefreshCached
        // 那么就尝试重新下载该图片，这样是NSURLCache有机会从服务器端刷新自身缓存
        completedBlock(image, nil, cacheType, YES, url);
    });
}

// download if no image or requested to refresh anyway, and download allowed by delegate

// 首先定义枚举值 downloaderOptions，并根据 options 来设置 downloaderOptions
// 基本上 options 和 downloaderOptions 是一一对应的，只需要注意最后一个选项 SDWebImageRefreshCached
SDWebImageDownloaderOptions downloaderOptions = 0;
if (options & SDWebImageLowPriority) downloaderOptions |= SDWebImageDownloaderLowPriority;
if (options & SDWebImageProgressiveDownload) downloaderOptions |= SDWebImageDownloaderProgressiveDownload;
if (options & SDWebImageRefreshCached) downloaderOptions |= SDWebImageDownloaderUseNSURLCache;
if (options & SDWebImageContinueInBackground) downloaderOptions |= SDWebImageDownloaderContinueInBackground;
if (options & SDWebImageHandleCookies) downloaderOptions |= SDWebImageDownloaderHandleCookies;
if (options & SDWebImageAllowInvalidSSLCertificates) downloaderOptions |= SDWebImageDownloaderAllowInvalidSSLCertificates;
if (options & SDWebImageHighPriority) downloaderOptions |= SDWebImageDownloaderHighPriority;
if (image && options & SDWebImageRefreshCached) {
    // force progressive off if image already cached but forced refreshing

   // 相当于downloaderOptions = downloaderOption & ~SDWebImageDownloaderProgressiveDownload);
    // ~ 位运算，取反
    downloaderOptions &= ~SDWebImageDownloaderProgressiveDownload;
    // ignore image read from NSURLCache if image if cached but force refreshing

    // 相当于 downloaderOptions = (downloaderOptions | SDWebImageDownloaderIgnoreCachedResponse);
    // 因为SDWebImage有两种缓存方式，一个是SDImageCache，一个就是NSURLCache
    // 所以已经从SDImageCache获取了image，就忽略NSURLCache了。
    downloaderOptions |= SDWebImageDownloaderIgnoreCachedResponse;
}

// 下载图片 （图片下载部分将在后续章节解读，这里先不介绍）
id <SDWebImageOperation> subOperation = [self.imageDownloader downloadImageWithURL:url options:downloaderOptions progress:progressBlock completed:^(UIImage *downloadedImage, NSData *data, NSError *error, BOOL finished) {
    ...  // 详情见 第四部分       
}];
operation.cancelBlock = ^{
    [subOperation cancel];

    @synchronized (self.runningOperations) {
        __strong __typeof(weakOperation) strongOperation = weakOperation;
        if (strongOperation) {
            [self.runningOperations removeObject:strongOperation];
        }
    }
};

第四部分：下载图片完成后 block 中的回调

图片下载部分将在后续章节讲解，这里先介绍一下图片下载完成后 block 中的内容：

__strong __typeof(weakOperation) strongOperation = weakOperation;
if (!strongOperation || strongOperation.isCancelled) {
    // Do nothing if the operation was cancelled
    // See #699 for more details
    // if we would call the completedBlock, there could be a race condition between this block and another completedBlock for the same object, so if this one is called second, we will overwrite the new data
}
else if (error) {
    dispatch_main_sync_safe(^{
        if (strongOperation && !strongOperation.isCancelled) {
            completedBlock(nil, error, SDImageCacheTypeNone, finished, url);
        }
    });

    if (   error.code != NSURLErrorNotConnectedToInternet
        && error.code != NSURLErrorCancelled
        && error.code != NSURLErrorTimedOut
        && error.code != NSURLErrorInternationalRoamingOff
        && error.code != NSURLErrorDataNotAllowed
        && error.code != NSURLErrorCannotFindHost
        && error.code != NSURLErrorCannotConnectToHost) {
        @synchronized (self.failedURLs) {
            [self.failedURLs addObject:url];
        }
    }
}
else {

    // 如果是失败重试，那么将 url 从 failedURLs 中移除
    if ((options & SDWebImageRetryFailed)) {
        @synchronized (self.failedURLs) {
            [self.failedURLs removeObject:url];
        }
    }

    // 是否只能从内存中取出
    BOOL cacheOnDisk = !(options & SDWebImageCacheMemoryOnly);

    // 如果需要刷新缓存，并且存在 image，并且没有新下载的 image
    if (options & SDWebImageRefreshCached && image && !downloadedImage) {
        // Image refresh hit the NSURLCache cache, do not call the completion block
    }

    // 如果有新下载的 image，并且需要对 image 进行处理，并且实现了图片处理的代理方法
    else if (downloadedImage && (!downloadedImage.images || (options & SDWebImageTransformAnimatedImage)) && [self.delegate respondsToSelector:@selector(imageManager:transformDownloadedImage:withURL:)]) {
        dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_HIGH, 0), ^{

            // 获取处理后的图片
            UIImage *transformedImage = [self.delegate imageManager:self transformDownloadedImage:downloadedImage withURL:url];

            if (transformedImage && finished) {

                BOOL imageWasTransformed = ![transformedImage isEqual:downloadedImage];

                // 将图片缓存到内存中（这里后续讲解）
                [self.imageCache storeImage:transformedImage recalculateFromImage:imageWasTransformed imageData:(imageWasTransformed ? nil : data) forKey:key toDisk:cacheOnDisk];
            }

            // 将图片传出
            dispatch_main_sync_safe(^{
                if (strongOperation && !strongOperation.isCancelled) {
                    completedBlock(transformedImage, nil, SDImageCacheTypeNone, finished, url);
                }
            });
        });
}
else {

    // 如果不需要处理，直接缓存到内存中
    if (downloadedImage && finished) {
        [self.imageCache storeImage:downloadedImage recalculateFromImage:NO imageData:data forKey:key toDisk:cacheOnDisk];
    }

    dispatch_main_sync_safe(^{
        if (strongOperation && !strongOperation.isCancelled) {
            completedBlock(downloadedImage, nil, SDImageCacheTypeNone, finished, url);
        }
    });
}
}

if (finished) {
    @synchronized (self.runningOperations) {
       if (strongOperation) {
            [self.runningOperations removeObject:strongOperation];
        }
    }
}

总结

SDWebImageManager 类中主要是对图片下载和缓存方式的管理，以及对下载完成的图片，url 等信息的回调，承上启下的作用，承接了 UIImageView+WebCache 类，下接了 SDImageCache 类和 SDWebImageDownloader 类。

SDWebImage 源码解析 github 地址：https://github.com/Mayan29/SDWebImageAnalysis

遗留问题：

  • 根据 key 去缓存中查找对应的图片

    • SDImageCache 类

    • - (NSOperation *)queryDiskCacheForKey:(NSString *)key done:(SDWebImageQueryCompletedBlock)doneBlock

  • 下载图片

    • SDWebImageDownloader 类

    • - (id <SDWebImageOperation>)downloadImageWithURL:(NSURL *)url options:(SDWebImageDownloaderOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageDownloaderCompletedBlock)completedBlock

  • 将图片存入缓存

    • SDImageCache 类

    • - (void)storeImage:(UIImage *)image recalculateFromImage:(BOOL)recalculate imageData:(NSData *)imageData forKey:(NSString *)key toDisk:(BOOL)toDisk

SDWebImage源码分析
m0_74217598的博客
05-02 806
SDWebImageManager同时管理着SDIMageCache和SDWebImageDownloader两个类，SDWebImageManager首先会通过SDImagerCache类来查询缓存，如果缓存中没有找到对应的图片就会通过SDWebImageloader来下载图片，下载下来的图片会存入缓存，然后显示。这个类的方法很多，这里具体讲一个和功能实现相关的方法，也是从url网络下载图片的方法，同上面的- (void)sd_setImageWithURL:(nullable NSURL *)url。
iOS——SDWebImage源码解析
chabuduoxs的博客
05-21 900
SDWebImage概述 SDWebImage是一个开源的第三方库，它提供了UIImageView的一个分类，以支持从远程服务器下载并缓存图片的功能。它具有以下功能： 1.一个异步的图片加载器。 2.一个异步的内存+磁盘图片缓存 3.支持GIF、WebP图片 4.后台图片解压缩处理 5.确保同一个URL的图片不被多次下载 6.确保非法的URL不会被反复加载 7.确保下载及缓存时，主线程不被阻塞。 这个框架的核心类是SDWebImageManger，在外部有UIImageView+WebCache 和 UIB
SDWebImage源码解读 二（下载图片）
sinat_35914591的博客
12-25 558
说道用sdWebImage下载图片，那就先简单介绍下SDWebImage中下载图片的几个工具类了。SDWebImageManager是SDWebImage的核心类，他有两个属性SDImageCache *imageCache（图片缓存）、SDWebImageDownloader *imageDownloader（图片下载）和一个代理id <SDWebImageManagerDelegate...
SDWebImage源码解析之SDWebImageManager的注解
tooooooooo的博客
11-02 373
/*  * This file is part of the SDWebImage package.  * (c) Olivier Poitrey  *  * For the full copyright and license information, please view the LICENSE  * file that was distributed with th
【原】SDWebImage源码阅读（二）
weixin_30553065的博客
12-26 106
【原】SDWebImage源码阅读（二） 本文转载请注明出处 —— polobymulberry-博客园 1. 解决上一篇遗留的坑 上一篇中对sd_setImageWithURL函数简单分析了一下，还留了一些坑。不过因为我们现在对这个函数有一个大概框架了，我们就按顺序一个个来解决。 首先是这一句代码： objc_setAssociatedObject(self, &am...
SDWebImage指定缓存图片大小
热门推荐
It's just a matter of time.
09-29 1万+
这几天在做iOS上的网络图片的异步加载和缓存。网上查了下，决定用SDWebImage实现。按照网络的教程，走了一遍，没什么问题。但是程序运行起来发现加载起来的图片都变得很模糊，本人有一点平面设计的经验。推测是因为图片太大的造成的细节都是，从而使图片变的模糊。进到程序的缓存文件目录，可以看到下载的图片果真和直接从网页上下载的一样大，即图片没有经过压缩就被缓存起来了。但是我的要求应该是图片应该在保存时
SDWebImage源码阅读记录
evol_f的博客
08-27 365
以前从来没有静下心来好好看看一些大神写的常用第三方库，现在看看，记录一下。。。 从使用看起 会经过UIImageView+WebCache类里的UIImageView+WebCache 然后统一调用到UIView+WebCache里的 下面逐行解释该方法实现   下面的三个方法 介绍了如何将Operation 绑定到自己 并执行了什么操作。。。 接...
【iOS】SDWebImage源码学习--未完
m0_63852285的博客
05-21 767
SDWebImage是一个流行的第三方库，用于在iOS和macOS应用程序中异步下载和缓存图像。
SDWebImage源码解析
jbr5740的专栏
04-10 442
SDWebImage已经在iOS开发中被广泛使用，提供了UIImageView和UIButton的分类，解决了需要从网络上加载图片的烦恼。SDWebImage的强大之处不仅在于提供图片的下载，还提供了图片的解码，超大图片的按比例解码，图片的缓存及内存占用超额的清理等功能！ 流程图 上面是SDWebImage主要对图片下载、处理、解压、存储等功能的主要类功能分布，接下来我们来依次解析每个步骤...
SDWebImage_Comment:SDWebImage源码解读下载，缓存，加载等机制详细讲解，附带注释代码-源码下载
03-24
在iOS项目常用的框架中， 是不可少的，相信大部分的iOS开发攻城狮都和SDWebImage打过交道，使用是使用了，但是您了解阅读过它的源码，了解它的实现原理吗？ 两次天闲下来，我有时间阅读了SDWebImage的SDWebImage ，...
SDWebImage的主流程
gcs的博客
02-15 1021
SDWebImage提供了UIImageView的分类来实现从网络端下载数据并缓存到内存和磁盘。非常的流行,现在就主流程分析下. 主要的学习链接 ：https://www.jianshu.com/p/6183c28df078 SDWebImage有如下特点： 提供了UIImageView和UIButton的分类。以支持加载网络图片并缓存。 一个异步的图片下载器 提供异步的内存和磁盘缓...
证书过期问题 —— 快速解决方法
轮子制造工厂
12-13 1万+
The certificate used to sign “XXX” has either expired or has been revoked 问题快速解决方法
加载 Bundle 中图片的三种方法
轮子制造工厂
12-14 1万+
其实实用性不是很强，主要就是 NSBundle 的运用
《iOS 开发进阶（唐巧）》读书笔记
轮子制造工厂
05-05 2837
前前后后大概半个月，利用零碎时间看完了这本书。这本书前年就有所耳闻，网上的评价也褒贬不一，唐巧写的相对来说，语言通俗易懂，感觉像是博客一样，没有什么限制，读起来很畅快。这本书适合初学者，虽然这本书大部分内容之前都已经熟悉掌握，但是看过一遍还是很有收获的，有些知识点的总结很到位，感觉没有浪费时间。遗留的问题是 CoreText 部分内容打算结合其他资料系统的研究一下，这里就先不仔细阅读了。
iOS进程类：NSProcessInfo
轮子制造工厂
11-24 2618
NSProcessInfo 在实际iOS开发中用处不大，globallyUniqueString 获取唯一标识也可以用获取时间后生成唯一标识代替，systemUptime 上次设备重启到现在的秒数这个在开发某些应用应该有些用处。以下仅仅列举部分属性或者方法，还有一些个人认为用不上的就不一一列举了。
《AV Foundation 开发秘籍》读书笔记（一）
轮子制造工厂
03-23 2125
《AV Foundation 开发秘籍》第一章 AV Foundation 简介
iOS 反编译入门
轮子制造工厂
11-29 1874
最近看了几篇关于 APP 安全方面的文章，其实网上关于 iOS 反编译相关内容的文章都大同小异，这篇博客也就是对这方面内容做一个整理
《AV Foundation 开发秘籍》读书笔记（四）
轮子制造工厂
01-02 1736
有很多知识点通过笔记是无法表达清楚的，具体实现还需看代码理解的透彻。根据 Learning-AV-Foundation Chapter 4 自行封装了一个视频播放、设置字幕、获取视频缩略图的框架，下载地址：https://github.com/Mayan29/MYAVFoundation
深入解析SDWebImage源码与工具使用教程
根据压缩包子文件的文件名称列表，我们仅看到了SDWebImage这一个文件名称，这意味着该压缩包可能只包含SDWebImage相关的源码。在实际开发中，开发者通常会通过CocoaPods、Carthage或手动方式将SDWebImage集成到项目...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值