2018-08-20 SDWebImage源码解析
image.png
二级缓存：内存缓存，硬盘缓存。
感觉仍然讲述得不大清晰，容我再重组。
源码解析的思路：
- 核心代码的主要功能：核心类的主要功能+核心变量的处理方式
- 设计思路
- 技术亮点
- 使用分析
SDWebImage
- 调用网络请求，下载图片
- 将图片缓存至内存和disk，并对内存和disk缓存进行管理
- 压缩解压，进行image至data之间的转换
- 每一个加载图片的progressBlock/completeBlock 与 每一个download task的对应管理。
技术范围：
- block/gcd/NSOperation/NSQueue，处理下载/回调的先后顺序
- 图片的encode/decode
- cache
- disk file
- session/task/delegate/background task
SDWebImageManager:NSObject
单例模式。处理二级缓存的读取，和启动下载。
主要成员变量
函数:loadImageWithURL
- (id <SDWebImageOperation>)loadImageWithURL:(nullable NSURL *)url
options:(SDWebImageOptions)options
progress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
completed:(nullable SDInternalCompletionBlock)completedBlock
- 查询二级缓存，是否有缓存数据
- 定义查询完毕的block，若有数据，调用callCompletionBlockForOperation；若不存在缓存数据，调用SDWebImageDownloader 的 downloadImageWithURL，定义并启动下载动作。
- 定义下载动作的completed block，主要是缓存数据，调用callCompletionBlockForOperation，返回downloadedImage和downloadedData
SDWebImageDownloader : NSObject
单例模式，负责队列创建与管理，operation创建与管理，session管理等。具体如下：
- 创建session，更新configuration并切换新session，session invalid
- 创建下载队列 download queue，暂停queue里的operation，取消queue里的operation，根据task遍历查找对应的operation。
- 创建download operation，添加operation至download queue，若定义为后进先出，则添加operation操作顺序。
- 创建token，SDWebImageDownloadToken实例，移除token对应的回调，若该url对应的operation，其持有的回调为空，则从download queue里移除该operation。token持有url，callback字典。
- 接收session代理，并根据task，找到operation，调起operation的相应动作。
主要成员变量
- downloadQueue: 下载queue，最大并发数为6
- URLOperations：字典类型，存储url-operation的键值对。一个url，对应一个downloadOperation，保存在此处。
主要函数:downloadImageWithURL
- (nullable SDWebImageDownloadToken *)downloadImageWithURL:(nullable NSURL *)url
options:(SDWebImageDownloaderOptions)options
progress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
completed:(nullable SDWebImageDownloaderCompletedBlock)completedBlock
入参：url，options，progressBlock，completedBlock
出参：SDWebImageDownloadToken实例
内容：创建createCallBack block，调用addProgressCallback函数
主要函数:addProgressCallback
- (nullable SDWebImageDownloadToken *)addProgressCallback:(SDWebImageDownloaderProgressBlock)progressBlock
completedBlock:(SDWebImageDownloaderCompletedBlock)completedBlock
forURL:(nullable NSURL *)url
createCallback:(SDWebImageDownloaderOperation *(^)(void))createCallback
入参：progressBlock，completedBlock，url，createCallback
出参：SDWebImageDownloadToken实例
内容：
判断self.URLOperations中是否已存在该url的download operation，如果没有则调用createCallback，创建download operation。
调用operation的addHandlersForProgress函数，将本次操作的block存进operation的callbackBlocks。
为这次下载动作创建SDWebImageDownloadToken，并返回。
主要函数:session delegates
每个delegate的功能都一样，根据task查找operation，调用operation实现的相应delegate。
疑问
既然queue支持遍历operation，那么在判断是否要创建operation的时候，可以通过遍历queue，这样就不需要URLOperations了。
SDWebImageDownloaderOperation : NSOperation
单例模式，负责每一个下载任务的启动，http层处理，过程回调，完毕回调，故障处理。
主要成员变量
- callbackBlocks：数组，item为字典，存储progress block / complete block。
- request，dataTask，response，imageData，cache data
主要函数：start
- (void)star
功能：
- 创建task，并执行
- 搭好后台运行的代码
- 若request 里 含有cachedResponse数据，则取出，存至self.cachedData
主要函数：didReceiveResponse
- (void)URLSession:(NSURLSession *)session
dataTask:(NSURLSessionDataTask *)dataTask
didReceiveResponse:(NSURLResponse *)response
completionHandler:(void (^)(NSURLSessionResponseDisposition disposition))completionHandler
功能：
接收到服务端响应，在接收数据之前，做相关工作。
- status Code 为空 or (status Code < 400 and status Code != 304)
读取期待数据大小，按长度分配imagedata NSMutableData实例，保存response - 其他
停止task，callCompletionBlocksWithError调用complete回调。
主要函数：didReceiveData
- (void)URLSession:(NSURLSession *)session
dataTask:(NSURLSessionDataTask *)dataTask
didReceiveData:(NSData *)data
功能：appendData，递增解压imgData，scaledImageForKey，decompressedImageWithImage，callCompletionBlocksWithImage，progressBlock
思考
- session，request在创建operation时创建，task则在operation start时创建，多个task共用一个request。目的在于，使用request的cache data。
结论：request 能持有 cache data。 - 在start函数内，有一段后台操作的代码。每个操作，都带一个后台操作taskidentifierid？
SDWebImageCompat:
inline UIImage *SDScaledImageForKey(NSString * _Nullable key, UIImage * _Nullable image)
image 转成 animation Image，@2x，@3x
SDImageCache
内存cache 和 disk cache的读与写。cache的管理。
- (nullable NSOperation *)queryCacheOperationForKey:(nullable NSString *)key done:(nullable SDCacheQueryCompletedBlock)doneBlock
- (void)storeImage:(nullable UIImage *)image
imageData:(nullable NSData *)imageData
forKey:(nullable NSString *)key
toDisk:(BOOL)toDisk
completion:(nullable SDWebImageNoParamsBlock)completionBlock
- 根据配置，将image保存至self.memCache
- 如果要保存至disk，默认按照png格式encode image，转成data，保存至disk。default/com.hackemist.SDWebImageCache.default/md5 filename
- (nullable NSString *)cachedFileNameForKey:(nullable NSString *)key
CC_MD5 根据key生成长度为16的md5串，格式化为filename
FOUNDATION_STATIC_INLINE NSUInteger SDCacheCostForImage(UIImage *image)
计算image在内存中占用的空间，ios计算方法 widthheightscale*scale
