SDWebImage源码解读(一)

SDWebImage是我们常用的图片缓存加载库,我们有必要对源码进行仔细阅读与学习,以便了解更多SD支持的功能与实现原理,并且在遇到问题时能及时的进行调试解决。我们再阅读之前先自己想想一下,如果我们自己来实现这个图片缓存与加载库,要怎么实现呢?感觉很简单就是下载图片,对UIImage进行赋值,同时对图片进行缓存方便下次更快的加载。SD作为更优秀的框架,有大量的使用者,所以对外提供了很多接口和拓展功能。看下图的作者给出的UML图,可以清晰的看出相互的调用关系。

SDWebImage图片加载的时序图

SDWebImageSequenceDiagram.png

第一步:调用对象调用对外暴露的sd_setImageWithURL(),设置图片信息下载的URL和辅助信息

第二步:调用UIView的sd_internalSetImageWithURL()方法,这一步会首先拿到当前view是否有正在进行的下载opration,如果有进行取消。设置进度回调block,拿到SDWebImageManager设置下载后对应的opration并保存。

第三步:调用SDWebImageManager的loadImageWithURL方法,此方法首先创建SDWebImageCombinedOperation并进行配置,首先通过imageCache调用queryDiskCacheForKey()查询url对应的缓存信息。如果没有缓存数据,调用SDWebImageDownloader的downloadImage方法去下载图标。待下载完成图片进行回调,在回调后Manager使用imageCache进行图片的缓存。

第四步:通过回调在获取到图片后,SDWebImageManager经过一步步的回调,将图片返回给调用者。

SDWebImage的基本架构

SDWebImageStruct.png
SDWebImage4.3.2.png

见如基本架构图:
左侧为主要实现类,包括:Utils、Downloader、Cache、Decoder这几个核心模块
右侧为辅助类,包括:WebCacheCategories、Categories、FLAnimatedImage。这些辅助类主要是辅助对UI的拓展,方便我们使用,比如拓展常用的UIImageView。

重点说一下左侧核心模块:

Utils

SDWebImageManager:实现图片下载和缓存的管理,对外提供接口

SDWebImagePrefetcher:实现预加载,可以预先加载一组URL地址对应的图片

SDWebImageTransition:实现图片加载完毕后的展示动画,默认提供了7种,支持拓展

下载模块:

SDWebImageDownloader:下载中心,管理下载队列

SDWebImageDownloaderOperation:下载的具体队列

缓存图片:

SDImageCacheConfig:缓存的配置信息

SDImageCache:缓存的设置

解码中心:

SDWebImageCodersManager:图片编码中心,支持拓展

SDWebImageCoder:图片编码协议集,自行拓展的分类必须支持此协议

SDWebImageImageIOCoder:PNG、JPEG、TIFF图片的解码

SDWebImageGIFCoder:GIF的解码

SDWebImageWebPCoder:Webp的解码

SDWebImageFrame:动图设置相关类组合

SDWebImageCoderHelper:图片解码相关帮助方法

SDAnimatedImageRep:NSBitmapImageRep的子类,加快NSBitmapImageRep的渲染

UIView(WebCache)的入口模块

- (void)sd_internalSetImageWithURL:(nullable NSURL *)url
                  placeholderImage:(nullable UIImage *)placeholder
                           options:(SDWebImageOptions)options
                      operationKey:(nullable NSString *)operationKey
                     setImageBlock:(nullable SDSetImageBlock)setImageBlock
                          progress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
                         completed:(nullable SDExternalCompletionBlock)completedBlock
                           context:(nullable NSDictionary<NSString *, id> *)context;

具体执行顺序:

1.判断当前view是否已经有SDWebImageOperation,如果有就将此操作取消并移除。

2.组建下载回调SDWebImageDownloaderProgressBlock

3.调用SD获取图片

- (id <SDWebImageOperation>)loadImageWithURL:(nullable NSURL *)url
                                     options:(SDWebImageOptions)options
                                    progress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
                                   completed:(nullable SDInternalCompletionBlock)completedBlock 

4.主线程更新UI对应的图片,存储当前的SDWebImageOperation

SDWebImage的管理模块

SDWebImageManager是一个管理中心类,本身是一个单例,管理缓存、下载的行为。属性见下面代码,持有一个缓存管理对象imageCache、一个下载管理对象imageDownloader、一个下载失败url的集合failedURLs、一个保存正在进行的Operation的集合runningOperations。

@property (strong, nonatomic, readwrite, nonnull) SDImageCache *imageCache;
@property (strong, nonatomic, readwrite, nonnull) SDWebImageDownloader *imageDownloader;
@property (strong, nonatomic, nonnull) NSMutableSet<NSURL *> *failedURLs;
@property (strong, nonatomic, nonnull) NSMutableArray<SDWebImageCombinedOperation *> *runningOperations;

其包含一个内部类-SDWebImageCombinedOperation类,主要用于保存当前任务的所有模块状态,以便在需要取消所有操作的时候进行取消。持有四个属性,分别为是否取消cancelled,下载的管理模块返回的downloadToken,缓存的任务cacheOperation,当前控制器manager。

@property (assign, nonatomic, getter = isCancelled) BOOL cancelled;
@property (strong, nonatomic, nullable) SDWebImageDownloadToken *downloadToken;
@property (strong, nonatomic, nullable) NSOperation *cacheOperation;
@property (weak, nonatomic, nullable) SDWebImageManager *manager;

SDWebImageManager核心方法
- (nullable id <SDWebImageOperation>)loadImageWithURL:(nullable NSURL *)url
                                              options:(SDWebImageOptions)options
                                             progress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
                                            completed:(nullable SDInternalCompletionBlock)completedBlock;

具体执行顺序:

1.创建一个SDWebImageCombinedOperation类operation,用于保存当前任务的所有信息。并用runningOperations保存此operation。

2.缓存中心,查询url对一个的缓存信息是否存在。查询时,先直接查询内存缓存是否存在,有就返回。没有的话异步查询硬盘缓存,同时将查询缓存的operation返回,让SDWebImageCombinedOperation进行保存。

- (nullable NSOperation *)queryCacheOperationForKey:(nullable NSString *)key options:(SDImageCacheOptions)options done:(nullable SDCacheQueryCompletedBlock)doneBlock;

3.根据缓存情况和用户配置,调用imageDownloader的下载方法进行下载,同时将下载的模块的返回token,
让SDWebImageCombinedOperation进行保存。

- (nullable SDWebImageDownloadToken *)downloadImageWithURL:(nullable NSURL *)url
                                                   options:(SDWebImageDownloaderOptions)options
                                                  progress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
                                                 completed:(nullable SDWebImageDownloaderCompletedBlock)completedBlock;

4.图片下载完成后,根据用户的配置做后续操作,如保存图片信息到缓存模块,完成后的回调,runningOperations删除当前进行的任务。

总结:

本文对SD的所有模块进行整体的拆分,并对类别入口模块和中心管理模块SDWebImageManager核心方法进行解析。

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

推荐阅读更多精彩内容