SDWebImage托管在github上。https://github.com/rs/SDWebImage
这个类库提供一个UIImageView类别以支持加载来自网络的远程图片。具有缓存管理、异步下载、同一个URL下载次数控制和优化等特征。
SDWebImage作为目前最受欢迎的图片下载第三方框架，使用率很高。但是你真的会用吗？本文接下来将通过例子分析如何合理使用SDWebImage。
使用场景：自定义的UITableViewCell上有图片需要显示，要求网络网络状态为WiFi时，显示图片高清图；网络状态为蜂窝移动网络时，显示图片缩略图。如下图样例：
图中显示的图片符合根据网络状态下载要求
由于要监听网络状态，在这里笔者推荐使用AFNetWorking。
1）在GitHub或者利用cocoaPod给项目导入第三方框架AFNetWorking。
2）在AppDelegate.m文件中的application:didFinishLaunchingWithOptions:方法中监听网络状态。
1
2
3
4
5
6
7
8
9
10
11
12// AppDelegate.m 文件中
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
{
// 监控网络状态
[[AFNetworkReachabilityManager sharedManager] startMonitoring];
}
// 以下代码在需要监听网络状态的方法中使用
AFNetworkReachabilityManager *mgr = [AFNetworkReachabilityManager sharedManager];
if(mgr.isReachableViaWiFi) {// 在使用Wifi, 下载原图
}else{// 其他，下载小图
}
}
这时就会有iOS学习者开始抱怨：这不是很简单吗？于是三下五除二写完了以下代码。
1
2
3
4
5
6
7
8
9
10
11
12// 利用MVC，在设置cell的模型属性时候，下载图片
- setItem:(CustomItem *)item
{
_item = item;
UIImage *placeholder = [UIImage imageNamed:@"placeholderImage"];
AFNetworkReachabilityManager *mgr = [AFNetworkReachabilityManager sharedManager];
if(mgr.isReachableViaWiFi) {// 在使用Wifi, 下载原图
[self.imageView sd_setImageWithURL:[NSURL URLWithString:item.originalImage] placeholderImage:placeholder];
}else{// 其他，下载小图
[self.imageView sd_setImageWithURL:[NSURL URLWithString:item.thumbnailImage] placeholderImage:placeholder];
}
}
此时，确实能完成基本的按照当前网络状态下载对应的图片，但是真实开发中，这样其实是不合理的。以下是需要注意的细节：
1）SDWebImage会自动帮助开发者缓存图片（包括内存缓存，沙盒缓存），所以我们需要设置用户在WiFi环境下下载的高清图，下次在蜂窝网络状态下打开应用也应显示高清图，而不是去下载缩略图。
2）许多应用设置模块带有一个功能：移动网络环境下仍然显示高清图。这个功能其实是将设置记录在沙盒中，关于数据保存到本地，可以查看本人另一篇简书首页文章：iOS本地数据存取，看这里就够了。
3）当用户处于离线状态时候，无法合理处理业务。
于是，开始加以改进。为了让读者你更容易理解，我先贴出伪代码：
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32- setItem:(CustomItem *)item
{
_item = item;
if(缓存中有原图)
{
self.imageView.image = 原图;
}else
{
if(Wifi环境)
{
下载显示原图
}elseif(手机自带网络)
{
if(3G\4G环境下仍然下载原图)
{
下载显示原图
}else
{
下载显示小图
}
}else
{
if(缓存中有小图)
{
self.imageView.image = 小图;
}else// 处理离线状态
{
self.imageView.image = 占位图片;
}
}
}
}
实现上面的伪代码：读者可以一一对应上面的伪代码。练习的时候推荐先写伪代码，再写真实代码
多多注意“注释”解释。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34- setItem:(CustomItem *)item
{
_item = item;
// 占位图片
UIImage *placeholder = [UIImage imageNamed:@"placeholderImage"];
// 从内存\沙盒缓存中获得原图，
UIImage *originalImage = [[SDImageCache sharedImageCache] imageFromDiskCacheForKey:item.originalImage];
if(originalImage) {// 如果内存\沙盒缓存有原图，那么就直接显示原图（不管现在是什么网络状态）
self.imageView.image = originalImage;
}else{// 内存\沙盒缓存没有原图
AFNetworkReachabilityManager *mgr = [AFNetworkReachabilityManager sharedManager];
if(mgr.isReachableViaWiFi) {// 在使用Wifi, 下载原图
[self.imageView sd_setImageWithURL:[NSURL URLWithString:item.originalImage] placeholderImage:placeholder];
}elseif(mgr.isReachableViaWWAN) {// 在使用手机自带网络
// 用户的配置项假设利用NSUserDefaults存储到了沙盒中
// [[NSUserDefaults standardUserDefaults] setBool:NO forKey:@"alwaysDownloadOriginalImage"];
// [[NSUserDefaults standardUserDefaults] synchronize];
#warning 从沙盒中读取用户的配置项：在3G\4G环境是否仍然下载原图
BOOL alwaysDownloadOriginalImage = [[NSUserDefaults standardUserDefaults] boolForKey:@"alwaysDownloadOriginalImage"];
if(alwaysDownloadOriginalImage) {// 下载原图
[self.imageView sd_setImageWithURL:[NSURL URLWithString:item.originalImage] placeholderImage:placeholder];
}else{// 下载小图
[self.imageView sd_setImageWithURL:[NSURL URLWithString:item.thumbnailImage] placeholderImage:placeholder];
}
}else{// 没有网络
UIImage *thumbnailImage = [[SDImageCache sharedImageCache] imageFromDiskCacheForKey:item.thumbnailImage];
if(thumbnailImage) {// 内存\沙盒缓存中有小图
self.imageView.image = thumbnailImage;
}else{// 处理离线状态，而且有没有缓存时的情况
self.imageView.image = placeholder;
}
}
}
}
解决了吗？真正的坑才刚刚开始。
在表述上述代码的坑之前，我们先来分析一下UITableViewCell的缓存机制。
请看下图：有一个tableView正在同时显示三个UITableViewCell，每个tableViewCell包含一个imageView的子控件，而且每个cell都有一个对应的模型属性用来设置imageView的图片内容。
注意：由于没有cell被推出屏幕，此时缓存池为空。
cell还没有被推入缓存池
当有一个cell被推到屏幕之外时，系统会自动将这个cell放入自动缓存池。注意:cell对应的UIImage图片数据模型并没有清空！还是指向上一个使用的cell。
cell被放入缓存池
当下一个cell进入屏幕，系统会根据tableView注册的标识找到对应的cell，拿来应用。上述进入缓存池的cell被重新添加进tableView，在tableView的Data Source方法tableView: cellForRowAtIndexPath:中设置改cell对应的模型数据，此时cell对应的如图：
cell被放入缓存池
以上就是tableView重用机制的简单介绍。
重新回来，那么上面所说的真正的坑在哪呢？
用一个场景来描述一下吧：当用户所处环境WiFi网速不够快(不能立即将图片下载完毕)，而在上述代码，在WiFi环境下又是下载高清大图。所以需要一定的时间来完成下载。而就在此时，用户不愿等，想看看上次打开App时显示的图片，此时用户会滑到处于下面的cell来查看。注意：此时，上面的cell下载图片操作并没有暂停，还在处于下载图片状态中。当用户在查看上次打开App的显示图片时（上次打开App下载完成的图片，SDWebImage会帮我们缓存，不用下载），而正好需要显示上次打开App时的图片的cell是利用tableView重用机制而从缓存池中拿出来的cell，等到处于上面的cell的高清大图已经下载好了的时候，SDWebImage默认做法是，立马把下载好的图片设置给ImageView，所以我们这时候会在底下的显示的cell显示上面的图片，造成数据错乱，这是非常严重的BUG。
那么该如何解决这个棘手的问题呢？
如果我们能在cell被从缓存池中拿出来使用的时候，将这个cell放入缓存池之前的下载操作移除，那么就不会出现数据错乱了。
这时候你可能会问我：怎么移除下载操作？下载操作不是SDWebImage帮我们做的吗？
说的没错，确实是SDWebImage帮我们下载图片的，我们来扒一扒SDWebImage源码，看看他是怎么完成的。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50- (void)sd_setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageCompletionBlock)completedBlock {
// 关闭当前图片的下载操作
[self sd_cancelCurrentImageLoad];
objc_setAssociatedObject(self, &imageURLKey, url, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
if(!(options & SDWebImageDelayPlaceholder)) {
dispatch_main_async_safe(^{
self.image = placeholder;
});
}
if(url) {
// check if activityView is enabled or not
if([self showActivityIndicatorView]) {
[self addActivityIndicator];
}
__weak __typeof(self)wself = self;
id operation = [SDWebImageManager.sharedManager downloadImageWithURL:url options:options progress:progressBlock completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType, BOOL finished, NSURL *imageURL) {
[wself removeActivityIndicator];
if(!wself)return;
dispatch_main_sync_safe(^{
if(!wself)return;
if(image && (options & SDWebImageAvoidAutoSetImage) && completedBlock)
{
completedBlock(image, error, cacheType, url);
return;
}
elseif(image) {
wself.image = image;
[wself setNeedsLayout];
}else{
if((options & SDWebImageDelayPlaceholder)) {
wself.image = placeholder;
[wself setNeedsLayout];
}
}
if(completedBlock && finished) {
completedBlock(image, error, cacheType, url);
}
});
}];
[self sd_setImageLoadOperation:operation forKey:@"UIImageViewImageLoad"];
}else{
dispatch_main_async_safe(^{
[self removeActivityIndicator];
if(completedBlock) {
NSError *error = [NSError errorWithDomain:SDWebImageErrorDomain code:-1 userInfo:@{NSLocalizedDescriptionKey : @"Trying to load a nil url"}];
completedBlock(nil, error, SDImageCacheTypeNone, url);
}
});
}
}
我们惊奇的发现，原来SDWebImage在下载图片时，第一件事就是关闭imageView当前的下载操作！
是不是开始感叹SDWebImage多么神奇了？没错，我们只需要把我们写的那段代码所有的直接访问本地缓存代码利用SDWebImage进行设置就OK了！
下面就是完成版代码。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34- setItem:(CustomItem *)item
{
_item = item;
// 占位图片
UIImage *placeholder = [UIImage imageNamed:@"placeholderImage"];
// 从内存\沙盒缓存中获得原图
UIImage *originalImage = [[SDImageCache sharedImageCache] imageFromDiskCacheForKey:item.originalImage];
if(originalImage) {// 如果内存\沙盒缓存有原图，那么就直接显示原图（不管现在是什么网络状态）
[self.imageView sd_setImageWithURL:[NSURL URLWithString:item.originalImage] placeholderImage:placeholder];
}else{// 内存\沙盒缓存没有原图
AFNetworkReachabilityManager *mgr = [AFNetworkReachabilityManager sharedManager];
if(mgr.isReachableViaWiFi) {// 在使用Wifi, 下载原图
[self.imageView sd_setImageWithURL:[NSURL URLWithString:item.originalImage] placeholderImage:placeholder];
}elseif(mgr.isReachableViaWWAN) {// 在使用手机自带网络
// 用户的配置项假设利用NSUserDefaults存储到了沙盒中
// [[NSUserDefaults standardUserDefaults] setBool:NO forKey:@"alwaysDownloadOriginalImage"];
// [[NSUserDefaults standardUserDefaults] synchronize];
#warning 从沙盒中读取用户的配置项：在3G\4G环境是否仍然下载原图
BOOL alwaysDownloadOriginalImage = [[NSUserDefaults standardUserDefaults] boolForKey:@"alwaysDownloadOriginalImage"];
if(alwaysDownloadOriginalImage) {// 下载原图
[self.imageView sd_setImageWithURL:[NSURL URLWithString:item.originalImage] placeholderImage:placeholder];
}else{// 下载小图
[self.imageView sd_setImageWithURL:[NSURL URLWithString:item.thumbnailImage] placeholderImage:placeholder];
}
}else{// 没有网络
UIImage *thumbnailImage = [[SDImageCache sharedImageCache] imageFromDiskCacheForKey:item.thumbnailImage];
if(thumbnailImage) {// 内存\沙盒缓存中有小图
[self.imageView sd_setImageWithURL:[NSURL URLWithString:item.thumbnailImage] placeholderImage:placeholder];
}else{
[self.imageView sd_setImageWithURL:nil placeholderImage:placeholder];
}
}
}
}
本文就介绍到这里，如有疑问或错误，欢迎指出。
使用示范的代码：
UITableView使用UIImageView+WebCache类（基本应用，UIImageView的一个category）
前提#import导入UIImageView+WebCache.h文件，然后在tableview的cellForRowAtIndexPath：方法下：
- (UITableViewCell *)tableView:(UITableView *)tableViewcellForRowAtIndexPath:(NSIndexPath *)indexPath {
staticNSString *MyIdentifier =@"MyIdentifier";
UITableViewCell *cell = [tableViewdequeueReusableCellWithIdentifier:MyIdentifier];
if(cell == nil) {
cell = [[[UITableViewCell alloc] initWithStyle:UITableViewCellStyleDefault reuseIdentifier:MyIdentifier] autorelease];
}
// Here we use the new provided setImageWithURL: method to load the web image
[cell.imageViewsetImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/to/image.jpg"] placeholderImage:[UIImage imageNamed:@"placeholder.png"]];
cell.textLabel.text =@"My Text";
returncell;
}
基本代码：[imageView setImageWithURL:[NSURL URLWithString:@"http://www.domain.com/path/image.jpg"]];
使用SDWebImageManager类：可以进行一些异步加载的工作。
SDWebImageManager *manager = [SDWebImageManager sharedManager];
UIImage *cachedImage = [manager imageWithURL:url];// 将需要缓存的图片加载进来
if(cachedImage) {
// 如果Cache命中，则直接利用缓存的图片进行有关操作
// Use the cached image immediatly
}else{
// 如果Cache没有命中，则去下载指定网络位置的图片，并且给出一个委托方法
// Start an async download
[manager downloadWithURL:urldelegate:self];
}
当然你的类要实现SDWebImageManagerDelegate协议，并且要实现协议的webImageManager:didFinishWithImage:方法。
// 当下载完成后，调用回调方法，使下载的图片显示
- (void)webImageManager:(SDWebImageManager *)imageManager didFinishWithImage:(UIImage *)image {
// Do something with the downloaded image
}
独立的异步图像下载
可能会单独用到异步图片下载，则一定要用downloaderWithURL:delegate:来建立一个SDWebImageDownloader实例。
downloader = [SDWebImageDownloader downloaderWithURL:urldelegate:self];
这样SDWebImageDownloaderDelegate协议的方法imageDownloader:didFinishWithImage:被调用时下载会立即开始并完成。
独立的异步图像缓存
SDImageCache类提供一个创建空缓存的实例，并用方法imageForKey:来寻找当前缓存。
UIImage *myCachedImage = [[SDImageCache sharedImageCache] imageFromKey:myCacheKey];
存储一个图像到缓存是使用方法storeImage: forKey:
[[SDImageCache sharedImageCache] storeImage:myImage forKey:myCacheKey];
默认情况下，图像将被存储在内存缓存和磁盘缓存中。如果仅仅是想内存缓存中，要使用storeImage:forKey:toDisk:方法的第三个参数带一负值
来替代。
SDWebImage支持异步的图片下载+缓存，提供了UIImageView+WebCacha的 category，方便使用。纪录一下 SDWebImage 加载图片的流程。
入口setImageWithURL:placeholderImage:options:会先把 placeholderImage 显示，然后 SDWebImageManager 根据 URL 开始处理图片。
进入 SDWebImageManager-downloadWithURL:delegate:options:userInfo:，交给SDImageCache从缓存查找图片是否已经下载queryDiskCacheForKey:delegate:userInfo:.
先从内存图片缓存查找是否有图片，如果内存中已经有图片缓存，SDImageCacheDelegate 回调imageCache:didFindImage:forKey:userInfo:到 SDWebImageManager。
SDWebImageManagerDelegate 回调webImageManager:didFinishWithImage:到 UIImageView+WebCache 等前端展示图片。
如果内存缓存中没有，生成 NSInvocationOperation 添加到队列开始从硬盘查找图片是否已经缓存。
根据 URLKey 在硬盘缓存目录下尝试读取图片文件。这一步是在 NSOperation 进行的操作，所以回主线程进行结果回调notifyDelegate:。
如果上一操作从硬盘读取到了图片，将图片添加到内存缓存中（如果空闲内存过小，会先清空内存缓存）。SDImageCacheDelegate 回调imageCache:didFindImage:forKey:userInfo:。进而回调展示图片。
如果从硬盘缓存目录读取不到图片，说明所有缓存都不存在该图片，需要下载图片，回调imageCache:didNotFindImageForKey:userInfo:。
共享或重新生成一个下载器SDWebImageDownloader开始下载图片。
图片下载由 NSURLConnection 来做，实现相关 delegate 来判断图片下载中、下载完成和下载失败。
connection:didReceiveData:中利用 ImageIO 做了按图片下载进度加载效果。
connectionDidFinishLoading:数据下载完成后交给SDWebImageDecoder做图片解码处理。
图片解码处理在一个 NSOperationQueue 完成，不会拖慢主线程 UI。如果有需要对下载的图片进行二次处理，最好也在这里完成，效率会好很多。
在主线程notifyDelegateOnMainThreadWithInfo:宣告解码完成，imageDecoder:didFinishDecodingImage:userInfo:回调给 SDWebImageDownloader。
imageDownloader:didFinishWithImage:回调给 SDWebImageManager 告知图片下载完成。
通知所有的 downloadDelegates 下载完成，回调给需要的地方展示图片。
将图片保存到 SDImageCache 中，内存缓存和硬盘缓存同时保存。写文件到硬盘也在以单独 NSInvocationOperation 完成，避免拖慢主线程。
SDImageCache 在初始化的时候会注册一些消息通知，在内存警告或退到后台的时候清理内存图片缓存，应用结束的时候清理过期图片。
SDWI 也提供了UIButton+WebCache和MKAnnotationView+WebCache，方便使用。
SDWebImagePrefetcher可以预先下载图片，方便后续使用。
SDWebImage库的作用：
通过对UIImageView的类别扩展来实现异步加载替换图片的工作。
主要用到的对象：
1、UIImageView (WebCache)类别，入口封装，实现读取图片完成后的回调
2、SDWebImageManager，对图片进行管理的中转站，记录那些图片正在读取。
向下层读取Cache（调用SDImageCache），或者向网络读取对象（调用SDWebImageDownloader） 。
实现SDImageCache和SDWebImageDownloader的回调。
3、SDImageCache，根据URL的MD5摘要对图片进行存储和读取（实现存在内存中或者存在硬盘上两种实现）
实现图片和内存清理工作。
4、SDWebImageDownloader，根据URL向网络读取数据（实现部分读取和全部读取后再通知回调两种方式）
其他类：
SDWebImageDecoder，异步对图像进行了一次解压⋯⋯
目前不明白为什么要做这么道工序。（现在清楚了，功能解释见下文）
有趣的点：
1、SDImageCache是怎么做数据管理的?
SDImageCache分两个部分，一个是内存层面的，一个是硬盘层面的。
内存层面的相当是个缓存器，以Key-Value的形式存储图片。当内存不够的时候会清除所有缓存图片。
用搜索文件系统的方式做管理，文件替换方式是以时间为单位，剔除时间大于一周的图片文件。
当SDWebImageManager向SDImageCache要资源时，先搜索内存层面的数据，如果有直接返回，没有的话去访问磁盘，将图片从磁盘读取出来，然后做Decoder，将图片对象放到内存层面做备份，再返回调用层。
2、为啥必须做Decoder?
通过这个博客：http://www.cocoanetics.com/2011/10/avoiding-image-decompression-sickness/
现在明白了，由于UIImage的imageWithData函数是每次画图的时候才将Data解压成ARGB的图像，
所以在每次画图的时候，会有一个解压操作，这样效率很低，但是只有瞬时的内存需求。
为了提高效率通过SDWebImageDecoder将包装在Data下的资源解压，然后画在另外一张图片上，这样这张新图片就不再需要重复解压了。
这种做法是典型的空间换时间的做法。
网友评论