简析SDWebImage

前言

SDWebImage是一个强大的第三方图片异步加载库,从事iOS开发的人或多或少用过它。今天我点开源码一看,里面一些实现细节确实令人玩味,同时也让我了解到缓存机制是如何实现。

简析

- (void)sd_setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder;

作者利用category为一些UIKit类拓展出相应的缓存功能,其中UIImageView和UIButton使用频率比较高,因为日常开发中,我们需要这两个控件加载图片。上面那个方法是UIImageView+WebCache最常用的方法,传一个url,UIImageView就会将网络图片加载出来,这个方法看起来简单,可是背后的实现没那么容易,不禁感慨大神之牛,巧妙的设计和背后复杂的实现竟然浓缩成这样的一个接口函数。

点进去看源码

[self sd_setImageWithURL:url placeholderImage:placeholder options:0 progress:nil completed:nil];

这个是原始接口

点进去这个原始接口

我可以看到这个函数体

- (void)sd_setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageCompletionBlock)completedBlock 

这个函数体就是就是sd_setImage的实现逻辑,利用block回调,有加载过程的回调和加载完成的回调

[self sd_cancelCurrentImageLoad];
objc_setAssociatedObject(self, &imageURLKey, url, OBJC_ASSOCIATION_RETAIN_NONATOMIC);

    if (!(options & SDWebImageDelayPlaceholder)) {
        dispatch_main_async_safe(^{
            self.image = placeholder;
        });
    }

首先,它先取消下载队列里正在进行的任务,将图片的url和UIImageView关联起来作为UIImageView的一部分;如果有placeholder,就先将它显示出来;

接着就是网络加载图片实现逻辑的主要部分

id <SDWebImageOperation> operation = [SDWebImageManager.sharedManager downloadImageWithURL:url options:options progress:progressBlock completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType, BOOL finished, NSURL *imageURL) {
if (!wself) return;
            dispatch_main_sync_safe(^{
                if (!wself) return;
                if (image && (options & SDWebImageAvoidAutoSetImage) && completedBlock)
                {
                    completedBlock(image, error, cacheType, url);
                    return;
                }
                else if (image) {
                    wself.image = image;
                    [wself setNeedsLayout];
                } else {
                    if ((options & SDWebImageDelayPlaceholder)) {
                        wself.image = placeholder;
                        [wself setNeedsLayout];
                    }
                }
                if (completedBlock && finished) {
                    completedBlock(image, error, cacheType, url);
                }
            });
}];

利用一个全局的SDWebImageManager来进行下载缓存操作的管理和调度。SDWebImageManager由两部分构成,由SDImageCache缓存器和SDWebImageDownloader下载器构成。同步上面加载过程的回调,在completed里除了同步加载完成的回调外,还将block回调的image加载在控件上面。

[self sd_setImageLoadOperation:operation forKey:@"UIImageViewImageLoad"];

这个函数是为了判断当前是否有重复的网络图片加载操作,如果有,就取消,key作为判断加载操作的标识。

点进去看downloadImageWithURL源码

__block SDWebImageCombinedOperation *operation = [SDWebImageCombinedOperation new];

首先,先new一个新的operation,operation是遵守SDWebImageOperation协议的一个对象,协议有个cancle方法,利用cancle可以取消当前操作

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

    if (!url || (!(options & SDWebImageRetryFailed) && isFailedUrl)) {
        dispatch_main_sync_safe(^{
            NSError *error = [NSError errorWithDomain:NSURLErrorDomain code:NSURLErrorFileDoesNotExist userInfo:nil];
            completedBlock(nil, error, SDImageCacheTypeNone, YES, url);
        });
        return operation;
    }
    @synchronized (self.runningOperations) {
        [self.runningOperations addObject:operation];
    }

接着我们可以看到一个实现的亮点,它用一个failedURLs集合来记录失败或者无效的url,如果传进来的url是failedURLs这个集合里的或者是为空,则完成操作并回调,否则将operation添加到运行的operation数组中。

 NSString *key = [self cacheKeyForURL:url];
    }

它将url缓存起来,给他一个key值

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

SDWebImageManager的缓存器根据缓存的url的key值来寻找是否有对应的缓存

点进去看queryDiskCacheForKey源码

if (!key) {
        doneBlock(nil, SDImageCacheTypeNone);
        return nil;
    }

如果相关的缓存记录则doneBlock回调,标识为SDImageCacheTypeNone


UIImage *image = [self imageFromMemoryCacheForKey:key];
if (image) {
        doneBlock(image, SDImageCacheTypeMemory);
        return nil;
    }

先在内存里寻找,SDImage用的内存缓存是用NSCache实现的,如果有就是doneBlock回调,标志为SDImageCacheTypeMemory

  UIImage *diskImage = [self diskImageForKey:key];
            if (diskImage && self.shouldCacheImagesInMemory) {
                NSUInteger cost = SDCacheCostForImage(diskImage);
                [self.memCache setObject:diskImage forKey:key cost:cost];
            }

            dispatch_async(dispatch_get_main_queue(), ^{
                doneBlock(diskImage, SDImageCacheTypeDisk);
            });

如果没有,就从磁盘缓存里找,如果找到了,就将他缓存到内存中,doneBlock回调,标志为SDImageCacheTypeDisk

返回上层函数查看done:^(UIImage *image, SDImageCacheType cacheType) {}这个block的主体

我们只看如果没有图片缓存该如何做

id <SDWebImageOperation> subOperation = [self.imageDownloader downloadImageWithURL:url options:downloaderOptions progress:progressBlock completed:^(UIImage *downloadedImage, NSData *data, NSError *error, BOOL finished) {};

SDWebImageManager的下载器开启下载operation来下载图片

点进去看downloadImageWithURL源码

下载的实现就不展开讲了,它利用的苹果提供的NSURLConnection来实现。

wself.lastAddedOperation = operation;

同时记录最后一个下载操作,最后block回调。
图片下载完成后,利用SDWebImageManager的缓冲器将图片缓存到内存和磁盘中,并将operation从运行的operation数组移除,如果失败则记录他是一个失败的url,成功则block回调。

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

推荐阅读更多精彩内容