SDWebImage
一个为UIImageView提供一个分类来支持远程服务器图片加载的库。
功能简介：
1、一个添加了web图片加载和缓存管理的UIImageView分类
2、一个异步图片下载器
3、一个异步的内存加磁盘综合存储图片并且自动处理过期图片
4、支持动态gif图
5、支持webP格式的图片
6、后台图片解压处理
7、确保同样的图片url不会下载多次
8、确保伪造的图片url不会重复尝试下载
9、确保主线程不会阻塞
工作流程
1、入口 setImageWithURL:placeholderImage:options: 会先把 placeholderImage 显示，然后 SDWebImageManager 根据 URL 开始处理图片。
2、进入 SDWebImageManager-downloadWithURL:delegate:options:userInfo:，交给 SDImageCache 从缓存查找图片是否已经下载 queryDiskCacheForKey:delegate:userInfo:.
3、先从内存图片缓存查找是否有图片，如果内存中已经有图片缓存，SDImageCacheDelegate 回调 imageCache:didFindImage:forKey:userInfo: 到 SDWebImageManager。
4、SDWebImageManagerDelegate 回调 webImageManager:didFinishWithImage: 到 UIImageView+WebCache 等前端展示图片。
5、如果内存缓存中没有，生成 NSInvocationOperation 添加到队列开始从硬盘查找图片是否已经缓存。
6、根据 URLKey 在硬盘缓存目录下尝试读取图片文件。这一步是在 NSOperation 进行的操作，所以回主线程进行结果回调 notifyDelegate:。
7、如果上一操作从硬盘读取到了图片，将图片添加到内存缓存中（如果空闲内存过小，会先清空内存缓存）。SDImageCacheDelegate 回调 imageCache:didFindImage:forKey:userInfo:。进而回调展示图片。
8、如果从硬盘缓存目录读取不到图片，说明所有缓存都不存在该图片，需要下载图片，回调 imageCache:didNotFindImageForKey:userInfo:。
9、共享或重新生成一个下载器 SDWebImageDownloader 开始下载图片。
10、图片下载由 NSURLConnection 来做，实现相关 delegate 来判断图片下载中、下载完成和下载失败。
11、connection:didReceiveData: 中利用 ImageIO 做了按图片下载进度加载效果。connectionDidFinishLoading: 数据下载完成后交给 SDWebImageDecoder 做图片解码处理。
12、图片解码处理在一个 NSOperationQueue 完成，不会拖慢主线程 UI。如果有需要对下载的图片进行二次处理，最好也在这里完成，效率会好很多。
13、在主线程 notifyDelegateOnMainThreadWithInfo: 宣告解码完成，imageDecoder:didFinishDecodingImage:userInfo: 回调给 SDWebImageDownloader。imageDownloader:didFinishWithImage: 回调给 SDWebImageManager 告知图片下载完成。
14、通知所有的 downloadDelegates 下载完成，回调给需要的地方展示图片。将图片保存到 SDImageCache 中，内存缓存和硬盘缓存同时保存。写文件到硬盘也在以单独 NSInvocationOperation 完成，避免拖慢主线程。
15、SDImageCache 在初始化的时候会注册一些消息通知，在内存警告或退到后台的时候清理内存图片缓存，应用结束的时候清理过期图片。
16、SDWI 也提供了 UIButton+WebCache 和 MKAnnotationView+WebCache，方便使用。
17、SDWebImagePrefetcher 可以预先下载图片，方便后续使用。
1]如何防止一个url对应的图片重复下载
"cell下载图片思路 –有沙盒缓存"
2] SDWebImage的默认缓存时长是多少？
- 1个星期
3] SDWebImage底层是怎么实现的？
"cell下载图片思路 –有沙盒缓存"
3>内存处理：当app接收到内存警告时，SDWebImage做了什么？ 在SDWebImageCache.m中可以找到
SDWebImage会监听系统的UIApplicationDidReceiveMemoryWarningNotification通知，一旦收到通知，就会清理内存
应用程序将要终止的通知,UIApplicationWillTerminateNotification,清理磁盘
应用程序进入后台的通知，UIApplicationDidEnterBackgroundNotification，也会清理磁盘
SDWebImage播放GIF
//
// ViewController.m
// SDWebImage播放GIF
//
// Created by apple on 15/10/25.
// Copyright (c) 2015年 LiuXun. All rights reserved.
//
#import "ViewController.h"
#import "UIImageView+WebCache.h"
#import "UIImage+GIF.h"
@interface ViewController ()
@property(nonatomic, strong) UIImageView *imageVIew;
@end
@implementation ViewController
-(void)viewDidLoad
{
self.imageVIew = [[UIImageView alloc] initWithFrame:self.view.bounds ];
[self.view addSubview:self.imageVIew];
}
-(void)touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event
{
[self.imageVIew sd_setImageWithURL:[[NSBundle mainBundle] URLForResource:@"bd698b0fjw1e0ph8unyg6g.gif" withExtension:nil]];
}
/**
PNG: 无损压缩！ 压缩程度没有JPG高。PNG图片一般比JPG大，比较清晰，解压速度比较快, GPU解压消耗比较小，苹果推荐使用。
JPG：有损压缩！压缩比非常高！照相机使用 GPU压缩的消耗比较大
GIF: 可动画的图片
BMP: 位图 没有任何压缩，无论如何放大都不会失真。开发中一般不使用。
*/
@end
SDWebImage的缓存策略
SDWebImage 的图片缓存默认情况采用的是 Memory 和 Disk 双重缓存机制。
下载之前先去Memory中查找图片数据，找到直接返回使用；
找不到再到Disk中查找图片数据，找到后放入Memory中再返回使用；
如果Disk中也找不到再去下载图片；
下载到图片后显示图片并将图片数据存到Memory和Disk中
SDWebImage的Memory缓存的存取和删除机制
SDWebImage 的Memory缓存使用NSCache。SDImageCache类中有一个memCache属性。用这个属性来进行Memory缓存。
@property (strong, nonatomic) NSCache *memCache;
下面代码用来将图片数据存到Memory中，其中的key是图片的url路径。
[self.memCache setObject:image forKey:key cost:cost];
下面代码用来获取Memory中的图片数据，其中的key是图片的url路径
- (UIImage *)imageFromMemoryCacheForKey:(NSString *)key {
return [self.memCache objectForKey:key];
}
SDImageCache类还监听了UIApplicationDidReceiveMemoryWarningNotification通知，当收到内存警告时候清除Memory缓存
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(clearMemory)
name:UIApplicationDidReceiveMemoryWarningNotification
object:nil];
- (void)clearMemory {
[self.memCache removeAllObjects];
}
SDWebImage的Disk缓存的存取和删除机制
SDWebImage的Disk缓存图片在/Library/Caches/default/com.hackemist.SDWebImageCache.default文件夹下。且每个图片的存的文件名进行了处理：图片的文件名是图片url路径MD5后的字符串。存取都按照这个新的文件名去操作文件。
- (NSString *)cachedFileNameForKey:(NSString *)key {
const char *str = [key UTF8String];
if (str == NULL) {
str = "";
}
unsigned char r[CC_MD5_DIGEST_LENGTH];
CC_MD5(str, (CC_LONG)strlen(str), r);
NSString *filename = [NSString stringWithFormat:@"%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%@",
r[0], r[1], r[2], r[3], r[4], r[5], r[6], r[7], r[8], r[9], r[10],
r[11], r[12], r[13], r[14], r[15], [[key pathExtension] isEqualToString:@""] ? @"" : [NSString stringWithFormat:@".%@", [key pathExtension]]];
return filename;
}
Disk缓存有时间限制，默认是一周。
static const NSInteger kDefaultCacheMaxCacheAge = 60 * 60 * 24 * 7; // 1 week
SDImageCache类监听了通知来删除Disk中过期的图片缓存。
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(cleanDisk)
name:UIApplicationWillTerminateNotification
object:nil];
[[NSNotificationCenter defaultCenter] addObserver:self
selector:@selector(backgroundCleanDisk)
name:UIApplicationDidEnterBackgroundNotification
object:nil];
收到通知后，都会进入- (void)cleanDiskWithCompletionBlock:(SDWebImageNoParamsBlock)completionBlock方法。在这个方法中将过期的Disk缓存清除。
SDWebImage防止一个无效的url多次加载
SDWebImageManager有个集合属性，这里包含着加载失败的url。
@property (strong, nonatomic) NSMutableSet *failedURLs;
这个集合中保存着加载失败的url，下载之前先判断这个集合是否包含图片的下载url。如果在且下载的策略不是SDWebImageRetryFailed，那个直接返回下载错误，不再进行下载操作。 下载错误后判断，加入不是一些网络错误，就将这个图片url添加进failedURLs
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];
}
}
SDWebImage防止同一个url多次加载
前面已经说过，SDWebImage有缓存策略，再次下载是回去缓存中取图片数据，这不就可以避免同一个url多次下载了吗？
当然不可以了。缓存机制只是可以防止已经下载好的图片再次被下载
假如我同时(几乎同时)去下载同一个url的图片，这是肯定还没有缓存。
[imageView sd_setImageWithURL:[NSURL URLWithString:@"http://www.baidu.comimage/pic/item/1.jpg"]];
[imageView2 sd_setImageWithURL:[NSURL URLWithString:@"http://www.baidu.comimage/pic/item/1.jpg"]];
SDWebImage又是如何处理的？ SDWebImageDownloader中有一个可变字典属性。
@property (strong, nonatomic) NSMutableDictionary *URLCallbacks;
通过下面的代码我们可以看出来字典中key是图片的url，value是一个可变数组，数组里面是一个一个的字典，每个字典中保存了下载过程回调和完成回调。每个字典相当于一次下载请求，但是只有第一次的下载请求才会真正去执行下载操作。这样就防止同一个url多次加载。
- (void)addProgressCallback:(SDWebImageDownloaderProgressBlock)progressBlock completedBlock:(SDWebImageDownloaderCompletedBlock)completedBlock forURL:(NSURL *)url createCallback:(SDWebImageNoParamsBlock)createCallback {
// The URL will be used as the key to the callbacks dictionary so it cannot be nil. If it is nil immediately call the completed block with no image or data.
if (url == nil) {
if (completedBlock != nil) {
completedBlock(nil, nil, nil, NO);
}
return;
}
dispatch_barrier_sync(self.barrierQueue, ^{
BOOL first = NO;
if (!self.URLCallbacks[url]) {
self.URLCallbacks[url] = [NSMutableArray new];
first = YES;
}
// Handle single download of simultaneous download request for the same URL
NSMutableArray *callbacksForURL = self.URLCallbacks[url];
NSMutableDictionary *callbacks = [NSMutableDictionary new];
if (progressBlock) callbacks[kProgressCallbackKey] = [progressBlock copy];
if (completedBlock) callbacks[kCompletedCallbackKey] = [completedBlock copy];
[callbacksForURL addObject:callbacks];
self.URLCallbacks[url] = callbacksForURL;
//执行下载操作
if (first) {
createCallback();
}
});
}
在图片下载完成或者取消下载，根据url将URLCallbacks中的数组移除。
源码分析
主要用到的对象
一、图片下载
1.SDWebImageDownloader
1.单例，图片下载器，负责图片异步下载，并对图片加载做了优化处理
2.图片的下载操作放在一个NSOperationQueue并发操作队列中，队列默认最大并发数是6
3.每个图片对应一些回调（下载进度，完成回调等），回调信息会存在downloader的URLCallbacks（一个字典，key是url地址，value是图片下载回调数组）中，URLCallbacks可能被多个线程访问，所以downloader把下载任务放在一个barrierQueue中，并设置屏障保证同一时间只有一个线程访问URLCallbacks。，在创建回调URLCallbacks的block中创建了一个NSOperation并添加到NSOperationQueue中。
4.每个图片下载都是一个operation类，创建后添加到一个队列中，SDWebimage定义了一个协议 SDWebImageOperation作为图片下载操作的基础协议，声明了一个cancel方法，用于取消操作。
@protocol SDWebImageOperation <NSObject>
-(void)cancel;
@end
5.对于图片的下载，SDWebImageDownloaderOperation完全依赖于NSURLConnection类，继承和实现了NSURLConnectionDataDelegate协议的方法
connection:didReceiveResponse:
connection:didReceiveData:
connectionDidFinishLoading:
connection:didFailWithError:
connection:willCacheResponse:
connectionShouldUseCredentialStorage:
-connection:willSendRequestForAuthenticationChalleng
-connection:didReceiveData:方法，接受数据，创建一个CGImageSourceRef对象，在首次获取数据时（图片width，height），图片下载完成之前，使用CGImageSourceRef对象创建一个图片对象，经过缩放、解压操作生成一个UIImage对象供回调使用，同时还有下载进度处理。
注：缩放：SDWebImageCompat中SDScaledImageForKey函数
解压：SDWebImageDecoder文件中decodedImageWithImage
2.SDWebImageDownloaderOption
1.继承自NSOperation类，没有简单实现main方法，而是采用更加灵活的start方法，以便自己管理下载的状态
2.start方法中创建了下载使用的NSURLConnections对象，开启了图片的下载，并抛出一个下载开始的通知，
3.小结：下载的核心是利用NSURLSession加载数据，每个图片的下载都有一个operation操作来完成，并将这些操作放到一个操作队列中，这样可以实现图片的并发下载。
SDWebImageDecoder（异步对图片进行解码）
二、缓存
减少网络流量，下载完图片后存储到本地，下载再获取同一张图片时，直接从本地获取，提升用户体验，能快速从本地获取呈现给用户。
SDWebImage提供了对图片进行了缓存，主要由SDImageCache完成。该类负责处理内存缓存以及一个可选的磁盘缓存，其中磁盘缓存的写操作是异步的，不会对UI造成影响。
1、内存缓存及磁盘缓存
1.内存缓存的处理由NSCache对象实现，NSCache类似一个集合的容器，它存储key-value对，类似于nsdictionary类，我们通常使用缓存来临时存储短时间使用但创建昂贵的对象，重用这些对象可以优化新能，同时这些对象对于程序来说不是紧要的，如果内存紧张就会自动释放。
2.磁盘缓存的处理使用NSFileManager对象实现，图片存储的位置位于cache文件夹，另外SDImageCache还定义了一个串行队列来异步存储图片。
3.SDImageCache提供了大量方法来缓存、获取、移除及清空图片。对于图片的索引，我们通过一个key来索引，在内存中，我们将其作为NSCache的key值，而在磁盘中，我们用这个key值作为图片的文件名，对于一个远程下载的图片其url实作为这个key的最佳选择。
2、存储图片
先在内存中放置一份缓存，如果需要缓存到磁盘，将磁盘缓存操作作为一个task放到串行队列中处理，会先检查图片格式是jpeg还是png，将其转换为响应的图片数据，最后吧数据写入磁盘中（文件名是对key值做MD5后的串）。
3、查询图片
内存和磁盘查询图片API：
- (UIImage *)imageFromMemoryCacheForKey:(NSString *)key;
- (UIImage *)imageFromDiskCacheForKey:(NSString *)key;
查看本地是否存在key指定的图片，使用一下API：
- (NSOperation *)queryDiskCacheForKey:(NSString *)key done:(SDWebImageQueryCompletedBlock)doneBlock;
4、移除图片
移除图片API：
- (void)removeImageForKey:(NSString *)key;
- (void)removeImageForKey:(NSString *)key withCompletion:(SDWebImageNoParamsBlock)completion;
- (void)removeImageForKey:(NSString *)key fromDisk:(BOOL)fromDisk;
- (void)removeImageForKey:(NSString *)key fromDisk:(BOOL)fromDisk withCompletion:(SDWebImageNoParamsBlock)completion;
5、清理图片（磁盘）
清空磁盘图片可以选择完全清空和部分清空，完全清空就是吧缓存文件夹删除。
- (void)clearDisk;
- (void)clearDiskOnCompletion:(SDWebImageNoParamsBlock)completion;
部分清理 会根据设置的一些参数移除部分文件，主要有两个指标：文件的缓存有效期（maxCacheAge：默认是1周）和最大缓存空间大小（maxCacheSize：如果所有文件大小大于最大值，会按照文件最后修改时间的逆序，以每次一半的递归来移除哪些过早的文件，知道缓存文件总大小小于最大值），具体代码参考- (void)cleanDiskWithCompletionBlock；
6、小结
SDImageCache处理提供以上API，还提供了获取缓存大小，缓存中图片数量等API，
常用的接口和属性：
（1）-getSize ：获得硬盘缓存的大小
（2）-getDiskCount ： 获得硬盘缓存的图片数量
（3）-clearMemory ： 清理所有内存图片
（4）- removeImageForKey:(NSString *)key 系列的方法 ： 从内存、硬盘按要求指定清除图片
（5）maxMemoryCost ： 保存在存储器中像素的总和
（6）maxCacheSize ： 最大缓存大小 以字节为单位。默认没有设置，也就是为0，而清理磁盘缓存的先决条件为self.maxCacheSize > 0，所以0表示无限制。
（7）maxCacheAge ： 在内存缓存保留的最长时间以秒为单位计算，默认是一周
三、SDWebImageManager
实际使用中并不直接使用SDWebImageDownloader和SDImageCache类对图片进行下载和存储，而是使用SDWebImageManager来管理。包括平常使用UIImageView+WebCache等控件的分类，都是使用SDWebImageManager来处理，该对象内部定义了一个图片下载器（SDWebImageDownloader）和图片缓存（SDImageCache）。
@interface SDWebImageManager : NSObject
@property (weak, nonatomic) id <SDWebImageManagerDelegate> delegate;
@property (strong, nonatomic, readonly) SDImageCache *imageCache;
@property (strong, nonatomic, readonly) SDWebImageDownloader *imageDownloader;
...
@end
SDWebImageManager声明了一个delegate属性，其实是一个id<SDWebImageManagerDelegate>对象，代理声明了两个方法
// 控制当图片在缓存中没有找到时，应该下载哪个图片
- (BOOL)imageManager:(SDWebImageManager *)imageManager shouldDownloadImageForURL:(NSURL *)imageURL;
// 允许在图片已经被下载完成且被缓存到磁盘或内存前立即转换
- (UIImage *)imageManager:(SDWebImageManager *)imageManager transformDownloadedImage:(UIImage *)image withURL:(NSURL *)imageURL;
这两个方法会在SDWebImageManager的-downloadImageWithURL:options:progress:completed:方法中调用，而这个方法是SDWebImageManager类的核心所在（具体看源码）
SDWebImageManager的几个API：
(1）- (void)cancelAll ： 取消runningOperations中所有的操作，并全部删除
（2）- (BOOL)isRunning ：检查是否有操作在运行，这里的操作指的是下载和缓存组成的组合操作
（3） - downloadImageWithURL:options:progress:completed: 核心方法
（4）- (BOOL)diskImageExistsForURL:(NSURL *)url ：指定url的图片是否进行了磁盘缓存
四、视图扩展
在使用SDWebImage的时候，使用最多的是UIImageView+WebCache中的针对UIImageView的扩展，核心方法是sd_setImageWithURL:placeholderImage:options:progress:completed:， 其使用SDWebImageManager单例对象下载并缓存图片。
除了扩展UIImageView外，SDWebImage还扩展了UIView，UIButton，MKAnnotationView等视图类，具体可以参考源码，除了可以使用扩展的方法下载图片，同时也可以使用SDWebImageManager下载图片。
UIView+WebCacheOperation分类：
把当前view对应的图片操作对象存储起来（通过运行时设置属性），在基类中完成
存储的结构：一个loadOperationKey属性，value是一个字典（字典结构： key：UIImageViewAnimationImages或者UIImageViewImageLoad，value是 operation数组（动态图片）或者对象）
UIButton+WebCache分类
会根据不同的按钮状态，下载的图片根据不同的状态进行设置
imageURLStorageKey:{state:url}
五、技术点
- 1.dispatch_barrier_sync函数，用于对操作设置顺序，确保在执行完任务后再确保后续操作。常用于确保线程安全性操作
- 2.NSMutableURLRequest：用于创建一个网络请求对象，可以根据需要来配置请求报头等信息
- 3.NSOperation及NSOperationQueue：操作队列是OC中一种告诫的并发处理方法，基于GCD实现，相对于GCD来说，操作队列的优点是可以取消在任务处理队列中的任务，另外在管理操作间的依赖关系方面容易一些，对SDWebImage中我们看到如何使用依赖将下载顺序设置成后进先出的顺序
- 4.NSURLSession：用于网络请求及相应处理
- 5.开启后台任务
- 6.NSCache类：一个类似于集合的容器，存储key-value对，这一点类似于nsdictionary类，我们通常用使用缓存来临时存储短时间使用但创建昂贵的对象。重用这些对象可以优化性能，因为它们的值不需要重新计算。另外一方面，这些对象对于程序来说不是紧要的，在内存紧张时会被丢弃
- 7.清理缓存图片的策略：特别是最大缓存空间大小的设置。如果所有缓存文件的总大小超过这一大小，则会按照文件最后修改时间的逆序，以每次一半的递归来移除那些过早的文件，直到缓存的实际大小小于我们设置的最大使用空间。
- 8.图片解压操作：这一操作可以查看SDWebImageDecoder.m中+decodedImageWithImage方法的实现。
- 9.对GIF图片的处理
- 10.对WebP图片的处理。
