SDWebImage使用进阶

使用场景：自定义的UITableViewCell上有图片需要显示，要求网络网络状态为WiFi时，显示图片高清图；网络状态为蜂窝移动网络时，显示图片缩略图。

由于要监听网络状态，在这里笔者推荐使用AFNetWorking。

（1）在GitHub或者利用cocoaPod给项目导入第三方框架AFNetWorking。

（2）在AppDelegate.m文件中的  application:didFinishLaunchingWithOptions:  方法中监听网络状态。

但是，需要注意的细节：

（1）SDWebImage会自动帮助开发者缓存图片（包括内存缓存，沙盒缓存），所以我们需要设置用户在WiFi环境下下载的高清图，下次在蜂窝网络状态下打开应用也应显示高清图，而不是去下载缩略图。

（2）许多应用设置模块带有一个功能：移动网络环境下仍然显示高清图。这个功能其实是将设置记录在沙盒中。

（3）当用户处于离线状态时候，无法合理处理业务。

为了便于理解，先写段伪代码

- setItem:(Item *)item
{
    _item = item;
    if  (缓存中有原图)
    {
        self.imageView.image = 原图;
    }  else
    {
        if  (Wifi环境)
        {
            下载显示原图
        }  else  if  (手机自带网络)
        {
            if  (3G\4G环境下仍然下载原图)
            {
                下载显示原图
            }  else
            {
                下载显示小图
            }
        }  else
        {
            if  (缓存中有小图)
            {
                self.imageView.image = 小图;
            }  else   // 处理离线状态
            {
                self.imageView.image = 占位图片;
            }
        }
    }
}

这部分是真正的代码：

- setItem:(Item *)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];
        }  else  if  (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;
            }
        }
    }
}

这样做固然可行，但如果放到tablecell中去的话，还有需要解决的麻烦

在表述上述代码的麻烦之前，我们先来分析一下UITableViewCell的缓存机制

• 有一个tableView正在同时显示三个UITableViewCell，每个tableViewCell包含一个imageView的子控件，而且每个cell都有一个对应的模型属性用来设置imageView的图片内容。

• 由于没有cell被推出屏幕，此时缓存池为空。 当有一个cell被推到屏幕之外时，系统会自动将这个cell放入自动缓存池。注意:cell对应的UIImage图片数据模型并没有清空！还是指向上一个使用的cell。当下一个cell进入屏幕，系统会根据tableView注册的标识找到对应的cell，拿来应用。上述进入缓存池的cell被重新添加进tableView，在tableView的Data Source方法tableView: cellForRowAtIndexPath:中设置改cell对应的模型数据。

• 
  
• 麻烦就在这时出现了：当用户所处环境WiFi网速不够快(不能立即将图片下载完毕)，而在上述代码，在WiFi环境下又是下载高清大图。所以需要一定的时间来完成下载。而就在此时，用户不愿等，想看看上次打开App时显示的图片，此时用户会滑到处于下面的cell来查看。注意：此时，上面的cell下载图片操作并没有暂停，还在处于下载图片状态中。当用户在查看上次打开App的显示图片时（上次打开App下载完成的图片，SDWebImage会帮我们缓存，不用下载），而正好需要显示上次打开App时的图片的cell是利用tableView重用机制而从缓存池中拿出来的cell，等到处于上面的cell的高清大图已经下载好了的时候，SDWebImage默认做法是，立马把下载好的图片设置给ImageView，所以我们这时候会在底下的显示的cell显示上面的图片，造成数据错乱，这是非常严重的BUG。
• 
  

• 解决办法：如果我们能在cell被从缓存池中拿出来使用的时候，将这个cell放入缓存池之前的下载操作移除，那么就不会出现数据错乱了。

• 这时我们回过头来看sdwebImage的加载图片的方法：

• • - (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 ;
                    }
                    else  if  (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当前的下载操作！
    
  • 
    

  • 完整的代码写法如下:

  • - setItem:(Item *)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];
            }  else  if  (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];
                }
            }
        }
    }