
本文授權轉載,作者:hosea_zhou(簡書)
SDWebImage 是目前最受歡迎的圖片加載第三方框架,用的人很多。但「用過」和「用對」是兩件事。本文通過一個具體場景,聊聊怎樣才算合理使用它。
場景設定:自定義的 UITableViewCell 上有一張圖,要求 WiFi 下載高清原圖,蜂窩移動網絡下載縮略圖。

由於需要監聽網絡狀態,這裡推薦用 AFNetworking:
1)通過 GitHub 或 CocoaPods 把 AFNetworking 導入項目。
2)在 AppDelegate.m 的 application:didFinishLaunchingWithOptions: 中啟動監聽。
// AppDelegate.m
- (BOOL)application:(UIApplication *)application
didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// 監控網絡狀態
[[AFNetworkReachabilityManager sharedManager] startMonitoring];
return YES;
}
// 以下代碼在需要監聽網絡狀態的方法中使用
AFNetworkReachabilityManager *mgr = [AFNetworkReachabilityManager sharedManager];
if (mgr.isReachableViaWiFi) {
// 在使用 Wifi, 下載原圖
} else {
// 其他,下載小圖
}這時很多學習者會說:這不簡單?於是很快寫出這樣的代碼。
// 利用 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)很多應用都提供「移動網絡下仍顯示高清圖」的開關,這個配置通常記錄在沙盒中(本地數據存取的具體做法可參考作者另一篇文章)。
3)用戶離線時,業務需要有合理降級。
於是可以先寫偽代碼把邏輯理順:
- setItem:(CustomItem *)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:(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];
} else if (mgr.isReachableViaWWAN) {
// 在使用手機自帶網絡
// 用戶配置項假設利用 NSUserDefaults 存儲到了沙盒中
// [[NSUserDefaults standardUserDefaults] setBool:NO forKey:@"alwaysDownloadOriginalImage"];
#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 的重用機制。
假設屏幕上同時顯示三個 cell,每個 cell 有一個 imageView 子控件,並各自綁定一個模型屬性來決定圖片內容。此時沒有 cell 被移出屏幕,緩存池為空。

當某個 cell 滑出屏幕,系統會把它放進重用緩存池。注意:這個 cell 對應的圖片數據模型並沒有被清空,仍指向上一輪使用的內容。

當新的 cell 進入屏幕,tableView 會按註冊標識從緩存池裡取出複用,並在 tableView:cellForRowAtIndexPath: 中重新賦值模型。這就是重用機制的基本流程。

那麼坑在哪裡?描述一個場景:用戶所在環境 WiFi 速度不夠快(不能立刻下載完畢),而按上面的邏輯,WiFi 下走的是高清大圖,需要一段時間。就在此期間,用戶不想等,往下滑去看上次打開 App 時已經緩存在本地的那些圖片。注意,此時上方那個 cell 的下載並沒有暫停,仍在下載中。
而下方的 cell 若是從緩存池裡取出的,它身上還掛著上一輪的模型。等上方 cell 的高清圖下載完成,SDWebImage 的默認行為是立刻把圖設置給它持有的 imageView——於是下方 cell 上出現了上方的圖片,數據錯亂。這是相當嚴重的 bug。
思路很清晰:如果能在 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) {
__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 上一次的下載操作。
所以結論很簡單:我們不需要自己直接訪問緩存來設置圖片,而是把「查緩存」與「顯示」兩件事都交給 SDWebImage 統一處理,讓它去取消舊任務。
- (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];
} else if (mgr.isReachableViaWWAN) {
// 在使用手機自帶網絡
#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];
}
}
}
}關鍵差別只在於:無論走哪條分支,最終都通過 sd_setImageWithURL: 下發,而不是直接賦值 image。這樣每次複用都會先取消上一次未完成的請求,錯亂自然消失。
本文就聊到這裡,若有疑問或錯誤,歡迎指出。