[跟着面试学习]SDWebImage源码研究与学习

1月15日在有过一次面试，面试官问我有没有看过AFNetworking的源码，有没有看过SDWebImage的源码，我都非常尴尬的表示没有，非常受挫，所以决定着手看一下，证明自己其实看这个一点也不吃力，只是之前太忙没做而已。

一、先看各个类干什么的（一共有14个类）

首先看基础类

1、NSData+ImageContentType

只有1个方法，用来通过nsdata前几个字段来判断是gif、webp、png、jpg

2、SDWebImageCompact

一些关于队列的宏定义，以及一个处理图片scale的方法

学会一种编译技巧，可以在提示错误：

#if !__has_feature(objc_arc)
#error SDWebImage is ARC only. Either turn on ARC for the project or use -fobjc-arc flag
#endif

3、UIImage+Gif

SDWebImage能处理gif主要就靠这个类了，本质上是获取图片的data数据，查看抽取其中各帧图片和市场，组合成image animation来播放处理。

其中还包含对本地包内的gif的播放的方法，貌似没有处理3x的问题

还包括一个对所有图片进行裁剪和压缩的方法

4、UIImage+MultiFormat（处理oriental和scale）

此类只有一个方法，该方法在传入NSData是gif的情况下调用上面的gif类处理，否则会根据其中exif信息处理图片oriental和scale。（ps：真心见识了大量的图片方向）

5、UIImage+ForceDecode（转码）

只有1个方法，类如其名，就是对image数据进行重新强解码，减少CPU在显示图片时的消耗，如果是一个gif渲染的(images不为空)，则直接返回，否则会重新渲染image返回数据。

6、SDImageCache（iOS的本地缓存相关算法学习下这里就够了）

从此类开始，进入深水区。
此类主要进行Image的缓存管理，分为磁盘缓存和内存缓存，可以通过设置存储空间，设置只读缓存取等方法，设置缓存大小、数量以及清除缓存都在此类中进行管理。
该类内部持有一个系统的NSCache进行的内存缓存。该NSCache在收到memory的情况下会直接调用自己的removeAllObjects方法进行缓存释放。
该类还持有一个自定义的串行(serital)io的队列，用来进行io操作，所有与文件相关的操作，甚至new一个fileManager对象都会放在这里。
类中还持有一个识别PNG数据的方法。
默认情况下，会将缓存保存在应用沙盒的cache/com.hackemist.SDWebImageCache.default中

在新增cache时，磁盘存储名字会将key做md5，内存存储会计算image的宽高和scale的平方相乘计算其NSCache中的cost。如果需要存入磁盘，则根据传入参数看是否需要进行重新计算转码（变为png或者jpg）。所有磁盘操作都在上述定义的串行(serital)io队列中异步执行。
所有以image作为返回值的读操作都在当前线程处理，没有上述的队列。首先查看该key在内存中的状态，没有则查看在磁盘中的状态，以及只读磁盘中的状态。若有则会缓存在内存中，并返回。没有则返回空。在磁盘中读取的image，会根据当前scale和图片oriental进行处理（调用上面的MutilFormat），以及根据情况看是否需要重编码（上面Decode）。
相应的，如果没有以Image作为返回值的读操作和查询本地是否存在的操作，只要内存不存在，磁盘操作都在io队列异步执行，并将block在主线程回调。从磁盘读取的文件都会直接缓存在内存。返回值NSOperation仅为一个新建的Operation，用来处理cancel事件。

所有暴漏的内存缓存的相关参数其实都是NSCache的。（包括totalCost，count以及removeMemory等）

和读操作对应，清理单个缓存是先清理内存，再在io队列中异步删除磁盘，并在主线程回调block。

获取磁盘缓存个数和大小，都是在上述io队列在当前线程同步执行，读取计算总个数和大小。
获取磁盘大小还有异步操作，也是在io队列中async，并主线程block

该类中还包括clear操作，就是在iO队列中异步删除目录然后新建，之后再在主线程回调。

类中包含对磁盘缓存的clean操作，进行整理缓存，该方法会在应用进入后台以及关闭情况下执行。清理操作都在io队列中异步执行，先通过方法获取该目录所有磁盘文件的日期、是否是目录以及大小，将所有过期的文件删除。然后在剩余缓存总大小大于约定的磁盘缓存大小情况下，删除磁盘中最早缓存的那些，直到大小小于约定的最大值。所有操作完成后会在主线程block。（这里系统针对文件管理的一些api设计值得学习，通过传入resourceKeys的方式进行定制化数据读取。不过SDWebimage中磁盘过期缓存的清理方式略粗暴，最好能够进行简单的算法调整）

注，进入后台进行执行的代码值得学习：

__block UIBackgroundTaskIdentifier bgTask = [application beginBackgroundTaskWithExpirationHandler:^{
    // Clean up any unfinished task business by marking where you
    // stopped or ending the task outright.
    [application endBackgroundTask:bgTask];
    bgTask = UIBackgroundTaskInvalid;
}];
// Start the long-running task and return immediately.
[self cleanDiskWithCompletionBlock:^{
    [application endBackgroundTask:bgTask];
    bgTask = UIBackgroundTaskInvalid;
}];

9、SDWebImageManager

中枢管理者，会维持一个单例进行大多数图片下载显示的操作。类中持有一个SDImageCache（上述单例），负责缓存的处理和管理；持有一个SDWebImageDownloader（上述单例），负责网络的下载。
一个小技巧很有意思，不使用delegate，使用一个SDWebImageCacheKeyFilterBlock的block向外抛出对将要缓存的url的key的处理。
各种针对缓存的获取，新增都是针对SDImageCache的简单封装，上层并不需要直接管理SDImageCache。
该manager是下载类，需要进行成功block回调，以进行图片的显示处理，这里有一个不错的assert，因为这种需要回调的一般SDWebImageOptions的级别较高，不需要回调的其实是预加载，不推荐在本类中使用：NSAssert(completedBlock != nil, @"If you mean to prefetch the image, use -[SDWebImagePrefetcher prefetchURLs] instead");
类中持有一个SDWebImageCombinedOperation，进行正在下载队列NSOperation的二级封装和cancel、cancelBlock的处理。是manager中具体fetcher图片image的最小实例。
manager在下载过程中会有一个Set类型的failedURLs以及一个Array类型的runningOperations，用来持有已知的不能下载的图片以及正在下载的operation，所有针对这两个collection的增删改查操作都需要用@synchronized进行加锁，避免多线程同步问题。因已经是最小实体了，没必要使用serital queue进行封装处理，反而@synchronized更为简单方便。
针对具体的下载逻辑，首先查找磁盘和内存，CombinedOperation中的cacheOperation指向磁盘查找的operation进行cancel封装，通过该operation，可以随时cancel掉还未进行的磁盘查找任务。

10、SDWebImagePrefetcher（其实就是预加载管理类）

教科书式的网络预加载类，所有想做所谓离线功能的，或者wifi预加载功能的模块都有必要参考它，可以传入若干url进行预加载，可以选择通过block或者delegate的方式获取fetcher的进度以及完成情况。
里面会持有一个独立类型的SDWebImageManager（不是单例），将其manager的SDWebImageOptions设置为SDWebImageLowPriority，使其进行后台下载，默认并行下载个数为3个。prefetcher运行在主线程，在主线程队列进行整个预加载的调度。通过递归的方式进行下载完成后启动下载的管理（基本和自己采用的思路一致）。由于使用GCD进行线程同步管理，不需要考虑锁的问题，整体易读优雅。
每次下载成功都会先后进行delegate和block的progress的回调。除了block使用了copy关键字，其它进本都是strong和assgin、以及nonatomic。

11、UIView+WebCacheOperation

通过objc_associate方法给view绑定一个dictionary，用来存储相关的operation，管理缓存的cancel操作。因为各自操作都是各自的串行队列，针对未执行的到的可以进行cancel。

12、UIImageView+WebCache

上层。最常用的，直接进行缓存使用

13、UIImageView+HighlightedWebCache

上层。处理hl操作

14、UIButton+WebCache

上层。button相关的图片显示操作