SDWebImage源碼學習，sdwebimage源碼

SDWebImage源碼學習，sdwebimage源碼
前言

　　簡單做個介紹，SDWebImage：以我個人的理解，就是幫我們非同步載入圖片，並且緩衝這些圖片到記憶體及disk的一款非常棒的開源架構。其實除此之外，還有很多強大的功能供我們使用，我們如果能夠熟練使用其API 就可以實現很多複雜的需求了。

　　github最新：https://github.com/rs/SDWebImage

　　下面，就開始學習下該架構。

本文

　　由於我下載的是最新版的，一切就按照該版本的來整理學習。

先看下一個方法:

[_imageView2 sd_setImageWithURL:url2 placeholderImage:image2 options:SDWebImageRetryFailed progress:^(NSInteger receivedSize, NSInteger expectedSize) {        NSLog(@"對下載進度做相關處理的事情");    } completed:^(UIImage *image, NSError *error, SDImageCacheType cacheType, NSURL *imageURL) {        NSLog(@"圖片載入完成後做的一些事情");    }];

　　這是最全的一個方法，看SDWebImage的源碼也可以看到很多縮小版的方法也都是直接調用了該方法。其他方法就不做記錄了

　　關於參數：1.sd_setImageWithURL: 圖片的url

　　　　　　　2.placeholderImage: 佔位圖片（圖片沒載入完成時顯示的圖片，也可以不選擇）

　　　　　　　3.options: 提供的一種載入機制選擇。預設值：SDWebImageRetryFailed 。詳細看下。　　　　　　　

　　　//失敗後重試     SDWebImageRetryFailed = 1 << 0,            //UI互動期間開始下載，導致延遲下載比如UIScrollView減速。     SDWebImageLowPriority = 1 << 1,           //只進行記憶體緩衝     SDWebImageCacheMemoryOnly = 1 << 2,           //這個標誌可以漸進式下載,顯示的映像是逐步在下載     SDWebImageProgressiveDownload = 1 << 3,           //重新整理緩衝     SDWebImageRefreshCached = 1 << 4,           //後台下載     SDWebImageContinueInBackground = 1 << 5,           //NSMutableURLRequest.HTTPShouldHandleCookies = YES;           SDWebImageHandleCookies = 1 << 6,           //允許使用無效的SSL認證     //SDWebImageAllowInvalidSSLCertificates = 1 << 7,           //優先下載     SDWebImageHighPriority = 1 << 8,           //延遲預留位置     SDWebImageDelayPlaceholder = 1 << 9,           //改變動畫形象     SDWebImageTransformAnimatedImage = 1 << 10,

　　　　　　4.progress: 看名字和參數應該可以瞭解該block的作用

　　　　　　5.completed: 圖片載入完成後的回調block，參數裡面說一下SDImageCacheType，也是個枚舉，通過該枚舉我們可以瞭解到載入的圖片是從哪裡載入（緩衝）來的，提供三種：SDImageCacheTypeNone 沒有緩衝類型，即網路下載來的

　　　　　　　　　　　　　SDImageCacheTypeDisk 由硬碟緩衝而來

　　　　　　　　　　　　　SDImageCacheTypeMemory 由記憶體緩衝而來

接下來我們來看下內部實現：

　一、在這步之前先學習個基於runtime機制的“關聯”，因為他裡面很多地方都用到了。

　　1.建立關聯：

　　　　方法：objc_setAssociatedObject(id object, const void *key, id value, objc_AssociationPolicy policy)

　　　　　　介紹下參數：object 來源物件

　　　　　　　　　　　　key 關鍵字 唯一靜態變數key 注意：該參數是一個指標

　　　　　　　　　　　　value 關聯的對象

　　　　　　　　　　　　policy 關聯策略 ：表明了相關的對象是通過賦值，保留引用還是複製的方式進行關聯的；還有這種關聯是原子的還是非原子的。

　　　　　　我個人的理解就是這個方法的作用就是：將value對象通過key關鍵字以及policy關聯策略和object關聯起來。（那麼此時value對象的生命週期就是依據關聯策略和object對象相掛鈎的。比如SDWebImage裡面用到的一個關聯策略OBJC_ASSOCIATION_RETAIN_NONATOMIC。其他不用關心，看到RETAIN，就應該知道此時就算我們release了value對象，如果object對象沒有被release的話，我們依然可以訪問的到value對象的。再進一步說，就是在object對象存在的時候，value對象一定存在。除非我們採用取消關聯的操作。）

　　2.擷取相關聯的對象

　　　　方法：objc_getAssociatedObject(id object, const void *key)

　　　　　　參數就不介紹，對應上面的關聯方法就可以知道了。但是說明一點，該方法是有傳回值的，傳回值為value類型的對象。

　　總結，先說下理論的東西。關聯對象的存在是解決拓展中無法添加屬性值而存在的，它以一個全域字典的形式存在，索引是你傳遞過來的key。以這種方式類比出符合物件導向的資料與操作綁定的現象。其實我個人認為，之所以在這裡用這個，是因為大多數的圖片請求都是批量進行的，反覆的調用要求方法，如果沒有一個類似全域的manager來管理這些請求，勢必會造成非常被動以及效能消耗的結果。所以作者在這裡採用了這種方式，會把manager管理的當前operation給cancel掉，減少不必要的負荷。來提高架構的效能。

　二、SDWebImage內部實現過程

　　1.入口：UIImageView+WebCache中先通過“關聯”取消當前正在隊列中的其他下載操作，然後顯示placeholder佔位圖片。方法：

- (void)sd_setImageWithURL:(NSURL *)url placeholderImage:(UIImage *)placeholder options:(SDWebImageOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageCompletionBlock)completedBlock 

 

　　2.SDWebImageManager通過傳進來的url等參數進行圖片請求操作。方法：

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

　　3.先對傳進來的url進行判斷，如果url為空白，或者是之前已經請求過失敗的url並且option是SDWebImageRetryFailed（失敗後重新請求）的話，就會直接回調失敗的completedBlock(nil, error, SDImageCacheTypeNone, YES, url); 並返回error資訊（NSURLErrorFileDoesNotExist）。代碼：

 1  　　BOOL isFailedUrl = NO; 2     @synchronized (self.failedURLs) { 3         isFailedUrl = [self.failedURLs containsObject:url]; 4     } 5      6     if (!url || (!(options & SDWebImageRetryFailed) && isFailedUrl)) { 7         dispatch_main_sync_safe(^{ 8             NSError *error = [NSError errorWithDomain:NSURLErrorDomain code:NSURLErrorFileDoesNotExist userInfo:nil]; 9             completedBlock(nil, error, SDImageCacheTypeNone, YES, url);10         });11         return operation;12     }

 

　　4.通過urlKey在SDImageCache中先找看緩衝裡面圖片是否已經下載。方法：

- (NSOperation *)queryDiskCacheForKey:(NSString *)key done:(SDWebImageQueryCompletedBlock)doneBlock

 

　　5.會先在記憶體配置圖片緩衝中找，找到後回調doneBlock(image, SDImageCacheTypeMemory)到SDWebImageManager，SDWebImageManager再回調completedBlock(image, nil, cacheType, YES, url)到UIImageView+WebCache前端展示圖片。代碼：

1 　　UIImage *image = [self imageFromMemoryCacheForKey:key];2 　　if (image) {3    　　doneBlock(image, SDImageCacheTypeMemory);4     　return nil;5 　　}

 

　　6.如果在記憶體配置圖片緩衝中沒有找到，產生NSOperation根據urlKey在硬碟中尋找看圖片是否已經緩衝。如果從硬碟中讀取到了圖片，將圖片添加到記憶體緩衝中（如果空閑記憶體過小，會先清空記憶體緩衝）。因為這一步是在 NSOperation 進行的操作，所以要回主線程進行結果回調doneBlock(diskImage, SDImageCacheTypeDisk)。然後SDWebImageManager再回調completedBlock(image, nil, cacheType, YES, url)到UIImageView+WebCache前端展示圖片。代碼：

 1     NSOperation *operation = [NSOperation new]; 2     dispatch_async(self.ioQueue, ^{ 3         if (operation.isCancelled) { 4             return; 5         } 6  7         @autoreleasepool { 8             UIImage *diskImage = [self diskImageForKey:key]; 9             if (diskImage) {10                 NSUInteger cost = SDCacheCostForImage(diskImage);11                 [self.memCache setObject:diskImage forKey:key cost:cost];12             }13 14             dispatch_async(dispatch_get_main_queue(), ^{15                 doneBlock(diskImage, SDImageCacheTypeDisk);16             });17         }18     });

　　7.如果記憶體和硬碟緩衝都沒有找到圖片的話，就需要下載圖片。調用SDWebImageDownloader的下載方法，到這一步才算是真正的下載。方法：

- (id <SDWebImageOperation>)downloadImageWithURL:(NSURL *)url options:(SDWebImageDownloaderOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageDownloaderCompletedBlock)completedBlock

 

　　8.關於下載，真的是蠻複雜的，以目前的能力好難看下去。以下內容摘自網路，以後能看明白了再補。

　　　　共用或重建一個下載器 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 可以預先下載圖片，方便後續使用。