您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 程式開發 >> iOS 開發基礎

SDWebImage 源碼解析:SDWebImageManager 逐段注解

編輯:iOS 開發基礎

SDWebImageManager 是整個 SDWebImage 的核心樞紐:UIImageView+WebCache 這個 category 背後真正做事的就是它。它把非同步下載器(SDWebImageDownloader)與圖片快取(SDImageCache)綁在一起。以下逐段拆解它的介面與實作。

Options:十個可組合的行為開關

類別開頭用 NS_OPTIONS 定義了 SDWebImageOptions,這是一組可以用按位或組合起來的旗標:

  • SDWebImageRetryFailed:預設情況下,一個 URL 下載失敗後會被加進黑名單,後續不再重試。開啟這個旗標會關掉黑名單機制,讓失敗的 URL 仍會被再次嘗試。

  • SDWebImageLowPriority:預設圖片會在 UI 互動時(例如滑動列表)就開始下載。開啟後會延後到 UIScrollView 減速時才下載——也就是手指離開螢幕、 scrollView 開始減速的那一刻。

  • SDWebImageCacheMemoryOnly:停用磁碟快取,只保留記憶體快取。

  • SDWebImageProgressiveDownload:邊下載邊顯示,像瀏覽器載圖那樣一截一截呈現;預設是下載完才顯示。

  • SDWebImageRefreshCached:即使已快取,仍尊重 HTTP 的回應快取控制,必要時從遠端刷新。此時磁碟快取會交由 NSURLCache 處理而非 SDWebImage,效能略有下降。這個選項主要用來處理「同一個 URL 背後圖片會變動」的情況,例如 Facebook Graph API 的頭像。若快取圖被刷新,completion block 會被呼叫兩次:先給快取版本,再給最終版本。只有在你無法把 URL 改成帶 cache busting 參數時才該用它。

  • SDWebImageContinueInBackground:iOS 4 以上,App 進入背景時仍繼續下載,做法是向系統索取額外的背景執行時間;若背景任務逾時,該 operation 會被取消。

  • SDWebImageHandleCookies:把 NSHTTPCookieStore 裡的 cookie 帶上,做法是設 NSMutableURLRequest.HTTPShouldHandleCookies = YES。

  • SDWebImageAllowInvalidSSLCertificates:允許不受信任的 SSL 憑證。測試用很方便,正式環境請謹慎使用。

  • SDWebImageHighPriority:預設圖片依進佇列的順序載入(先進先出)。開啟後會把它們移到佇列前端並立即載入,不必等前面的一批處理完。

  • SDWebImageDelayPlaceholder:預設占位圖會在圖片下載期間顯示。開啟後會延後占位圖的載入時機。

  • SDWebImageTransformAnimatedImage:一般不會對動態圖(GIF 等)呼叫 transformDownloadedImage,因為多數轉換程式碼會把它們弄壞。這個旗標用來強制轉換。

順帶一提,iOS 大量照片方向需要校正,是因為 iPhone 的感光元件並非正置,而是向左偏了 90 度——不處理就會看到圖片躺著。

Delegate:兩個可選的介入點

- (BOOL)imageManager:(SDWebImageManager *)imageManager shouldDownloadImageForURL:(NSURL *)imageURL;

- (UIImage *)imageManager:(SDWebImageManager *)imageManager
    transformDownloadedImage:(UIImage *)image withURL:(NSURL *)imageURL;

第一個方法決定「快取裡找不到這張圖時,要不要下載」。預設是 YES,實作它並回傳 NO,就能在 cache miss 時阻止下載。

第二個方法讓你在圖片下載完成、寫入磁碟與記憶體快取之前先做一次轉換。注意它是跑在全域佇列上的,目的是不阻塞主線程——對一張 2MB 的圖做方向校正相當耗時,用 Instruments 測一下就知道。

快取 key 的產生

@property (nonatomic, copy) SDWebImageCacheKeyFilterBlock cacheKeyFilter;

SDWebImage 的快取可以想成一個字典:value 是圖片,key 則由 cacheKeyFilter 依規則對圖片 URL 做處理後產生。官方範例展示了如何把 query string 去掉再當 key:

[[SDWebImageManager sharedManager] setCacheKeyFilter:^(NSURL *url) {
    url = [[NSURL alloc] initWithScheme:url.scheme host:url.host path:url.path];
    return [url absoluteString];
}];

實作裡的邏輯很單純:有 filter 就用 filter,沒有就直接回傳 [url absoluteString]。

核心方法:downloadImageWithURL:

- (id)downloadImageWithURL:(NSURL *)url
                    options:(SDWebImageOptions)options
                   progress:(SDWebImageDownloaderProgressBlock)progressBlock
                  completed:(SDWebImageCompletionWithFinishedBlock)completedBlock;

四個參數:URL(必填)、options 旗標、下載進度的回呼,以及完成後的回呼。完成回呼裡帶了圖片、錯誤、快取來源型別、是否完成、以及對應的 URL;若使用 SDWebImageProgressiveDownload,finished 會是 NO,這個 block 會被反覆呼叫並帶入部分圖像,直到下載完成後最後一次以完整圖與 YES 收尾。

回傳值是一個符合 SDWebImageOperation 協議的物件(實際上是 SDWebImageDownloaderOperation),這個協議只定義了取消能力。

實作開頭有兩段防禦性程式碼值得注意:一是用 NSAssert 擋掉「不傳 completedBlock」的誤用(真要預取請用 SDWebImagePrefetcher);二是把誤傳成 NSString 的 URL 主動轉成 NSURL——這是很常見的錯誤,而 Xcode 對這種型別不匹配居然不會給警告。若傳進來的既不是 NSURL 也不是 NSString,就設為 nil。

接著用 @synchronized 保護 failedURLs 的讀取,判斷這個 URL 是否曾經失敗;再依「有沒有帶 retry 旗標」決定是直接回錯誤,還是繼續往下走。

然後進入快取查詢:呼叫 queryDiskCacheForKey:done:,回呼裡先檢查 operation 是否已被取消(取消則從 runningOperations 移除並 return),接著判斷是否需要下載:

if ((!image || options & SDWebImageRefreshCached)
    && ([self.delegate respondsToSelector:@selector(imageManager:shouldDownloadImageForURL:)]
        || [self.delegate imageManager:self shouldDownloadImageForURL:url])) {

需要下載時,它會把 SDWebImage 的 options 一一對應轉譯成 downloader 的 options(SDWebImageLowPriority → SDWebImageDownloaderLowPriority,以此類推),然後交給 imageDownloader 下載。

下載回呼裡分三條路:

  1. operation 已取消:什麼都不做。這裡刻意不呼叫 completedBlock,否則同一個物件的兩個回呼之間可能出現 race condition,導致新的資料被舊資料覆蓋。

  2. 發生錯誤:回呼錯誤,並把 URL 加進 failedURLs——但會排除「無網路連線」、「已取消」、「逾時」這三種情況,因為這些重試是有意義的。

  3. 成功:先判斷是否需要做 transform。若 delegate 實作了 transformDownloadedImage:withURL:,且圖片不是動態圖(或明確開了 SDWebImageTransformAnimatedImage),就在高優先級全域佇列裡做轉換,再把結果寫入快取並回呼。

整個流程中,凡是要更新 UI 的地方都用 dispatch_main_sync_safe 切回主線程。

其他方法

  • saveImageToCache:forURL::手動把圖片寫入快取,類似 setValue:forKey:。

  • cancelAll:取消所有正在執行的 operation。

  • isRunning:判斷是否還有下載在跑。

  • cachedImageExistsForURL: / diskImageExistsForURL::同步檢查記憶體或磁碟快取。帶 completion 的版本則是 asynchronously 檢查,且回呼保證在主線程執行,可以直接在裡面更新 UI。

  • cacheKeyForURL::回傳該 URL 對應的快取 key。至於為什麼不直接拿 URL 當 key,作者自己也說不太確定,推測是為了避免碰撞。

內部實作細節

SDWebImageManager 用 dispatch_once 實作單例,初始化時做四件事:建立 SDImageCache 單例、取得 SDWebImageDownloader 單例、建立 failedURLs(用 NSMutableSet)、建立 runningOperations(用 NSMutableArray)。

為什麼失敗 URL 用 Set 而不是 Array?因為 NSSet 本質上是雜湊表,查找只需透過 key 定位,而 Array 至少要遍歷。SDWebImage 對失敗 URL 的需求正好是「同一個 URL 只存一次」,Set 自然更合適。

取消機制由內部類 SDWebImageCombinedOperation 負責,它同時持有 cacheOperation 與一個 cancelBlock。setCancelBlock: 裡有個細節:如果 operation 已經被取消了,就直接執行傳進來的 block 並把 _cancelBlock 設為 nil——否則會 crash。而 cancel 方法裡刻意用 ivar 而非 setter 來清空(並留了 TODO 說明這是 #809 的暫時修法)。

最後,檔案尾端的 Deprecated 區塊保留了舊的 downloadWithURL:,內部只是包一層 adapter 轉呼叫新方法,並把缺少 finished 參數的舊 block 型別補上。

附錄:NS_ENUM 與 NS_OPTIONS 的差別

兩者本質上都是列舉,但用途不同。

typedef NS_ENUM(NSInteger, UIViewAnimationTransition) {
    UIViewAnimationTransitionNone,
    UIViewAnimationTransitionFlipFromLeft,
    UIViewAnimationTransitionFlipFromRight,
    UIViewAnimationTransitionCurlUp,
    UIViewAnimationTransitionCurlDown,
};
typedef NS_OPTIONS(NSUInteger, UIViewAutoresizing) {
    UIViewAutoresizingNone                     = 0,
    UIViewAutoresizingFlexibleLeftMargin       = 1 << 0,
    UIViewAutoresizingFlexibleWidth            = 1 << 1,
    UIViewAutoresizingFlexibleRightMargin      = 1 << 2,
    UIViewAutoresizingFlexibleTopMargin        = 1 << 3,
    UIViewAutoresizingFlexibleHeight           = 1 << 4,
    UIViewAutoresizingFlexibleBottomMargin     = 1 << 5
};

應該能看出苗頭:NS_ENUM 通常是單選,NS_OPTIONS 通常是多選。

UIViewAnimationTransition 用起來只能選一種效果——你要麼從左翻到右,要麼從右翻到左,不可能同一時刻又左翻又右翻。

而 UIViewAutoresizing 不一樣:要讓子 view 的寬高跟著父 view,就會寫成 UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleHeight,兩個選項都得選。

那如果要判斷某個 view 目前設了哪些 autoresizing 呢?用按位與:

autoResizings = UIViewAutoresizingFlexibleLeftMargin | UIViewAutoresizingFlexibleWidth | UIViewAutoresizingFlexibleRightMargin;

if (autoResizings & UIViewAutoresizingFlexibleLeftMargin) { /* 含有這個選項 */ }

用二進位來看(這裡不用管 NSUInteger 究竟幾位,只表達概念):

UIViewAutoresizingFlexibleLeftMargin  = 00000001
UIViewAutoresizingFlexibleWidth       = 00000010
UIViewAutoresizingFlexibleRightMargin = 00000100

所以 autoResizings = 00000111,執行按位與:

  00000111
& 00000001
-----------
  00000001   → true,表示含有這個選項
  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved