SDWebImage原理和緩存機制

這篇文章將主要介紹SDWebImage針對于獲取網(wǎng)絡圖片的原理和緩存機制,當然我只是用文字去介紹大體的一個流程,學無止境,需要更詳細東西的朋友自行百度深入了解。

先介紹一下兩個重要的功能

1. 獨立的異步圖像下載
- (id <SDWebImageOperation>)downloadImageWithURL:(NSURL *)url options:(SDWebImageOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageCompletionWithFinishedBlock)completedBlock;

上面函數(shù)用來建立一個SDWebImageDownLoader的實例。利用下載進度的回調和下載完成的回調,可以在回調完成進度條相關的操作和顯示圖片相關的操作。

2. 獨立的異步圖像緩存
(存、取、刪的詳細代碼介紹附在最后)
SDImageCache *imageCache = [SDImageCache sharedImageCache];

SDImageCache類提供一個管理緩存的單例類。查找和緩存圖片時簡單理解為以URL作為key。(先查找圖片緩存,如果緩存不存在該圖片,再查找沙盒;查找沙盒時,以URL組合成文件路徑進行的MD5值作為key).
查找圖片:

UIImage *cacheImage = [imageCache mageFromKey:myCacheKey];

緩存圖片:

[imageCache storeImage:myImage forKey:myCacheKey];

默認情況下,圖片是被存儲到內存緩存和磁盤緩存中的。如果僅僅是想緩存到內存中,可以用下面方法:

storeImage: forKey: toDisk: 

第三個參數(shù)傳NO即可。

主要用到的對象:

  1. UIImageView(WebCache)入口封裝,實現(xiàn)讀取圖片完成后的回調。

  2. SDWebImagemanager對圖片進行管理的中轉站,記錄那些圖片正在讀取。向下層讀取Cache(調用SDImageCache),或者向網(wǎng)絡讀取對象(調用SDWebImageDownloader)。實現(xiàn)SDImageCacheSDWebImageDownLoader的回調。

  3. SDImageCache,根據(jù)URL作為key,對圖片進行存儲和讀?。ù嬖趦却妫ㄒ訳RL作為key)和存在硬盤兩種(以URL組合成文件路徑進行的MD5值作為key))。實現(xiàn)圖片和內存清理工作。

SDWebImage加載圖片的流程

  1. 入口 setImageWithURL:placeholderImage:options:會先把 placeholderImage顯示,然后 SDWebImageManager根據(jù) URL 開始處理圖片。

  2. 進入SDWebImageManager 類中downloadWithURL:delegate:options:userInfo:,交給
    SDImageCache從緩存查找圖片是否已經下載
    queryDiskCacheForKey:delegate:userInfo:.

  3. 先從內存圖片緩存查找是否有圖片,如果內存中已經有圖片緩存,SDImageCacheDelegate回調 imageCache:didFindImage:forKey:userInfo:
    SDWebImageManager。

  4. SDWebImageManagerDelegate 回調
    webImageManager:didFinishWithImage:UIImageView+WebCache,等前端展示圖片。

  5. 如果內存緩存中沒有,生成 `NSURLSession `
    添加到隊列,開始從沙盒查找圖片是否已經緩存。

  6. 根據(jù) URL組合成的Key在沙河緩存目錄下嘗試讀取圖片文件。這一步是在 NSOperation 進行的操作,所以回主線程進行結果回調 notifyDelegate:。

  7. 如果上一操作從沙盒讀取到了圖片,將圖片添加到內存緩存中(如果空閑內存過小, 會先清空內存緩存)。SDImageCacheDelegate回調 imageCache:didFindImage:forKey:userInfo:。進而回調展示圖片。

  8. 如果從沙盒目錄讀取不到圖片,說明所有緩存都不存在該圖片,需要下載圖片, 回調 imageCache:didNotFindImageForKey:userInfo:

  9. 共享或重新生成一個下載器 SDWebImageDownloader開始下載圖片。

  10. 圖片下載由 NSURLConnection來做,實現(xiàn)相關 delegate
    來判斷圖片下載中、下載完成和下載失敗。

  11. connection:didReceiveData:中利用 ImageIO做了按圖片下載進度加載效果。

  12. connectionDidFinishLoading: 數(shù)據(jù)下載完成后交給 SDWebImageDecoder做圖片解碼處理。

  13. 圖片解碼處理在一個NSOperationQueue完成,不會拖慢主線程 UI.如果有需要 對下載的圖片進行二次處理,最好也在這里完成,效率會好很多。

  14. 在主線程notifyDelegateOnMainThreadWithInfo:
    宣告解碼完成imageDecoder:didFinishDecodingImage:userInfo:回調給SDWebImageDownloader。

15.imageDownloader:didFinishWithImage:回調給 SDWebImageManager告知圖片 下載完成。

  1. 通知所有的downloadDelegates下載完成,回調給需要的地方展示圖片。

  2. 將圖片保存到 SDImageCache中,內存緩存和沙盒緩存同時保存。寫文件到沙盒也在以單獨NSOperation完成,避免拖慢主線程。

18.SDImageCache在初始化的時候會注冊一些消息通知,
在內存警告或退到后臺的時 候清理內存圖片緩存,應用結束的時候清理過期圖片。


存:

-(void)storeImage:(UIImage *)image recalculateFromImage:(BOOL)recalculate imageData:(NSData *)imageData forKey:(NSString *)key toDisk:(BOOL)toDisk {
if (!image || !key) {
    return;
}
// if memory cache is enabled
if (self.shouldCacheImagesInMemory) {
    NSUInteger cost = SDCacheCostForImage(image);
    [self.memCache setObject:image forKey:key cost:cost];
}

if (toDisk) {
    dispatch_async(self.ioQueue, ^{
        NSData *data = imageData;
        // 如果image存在,但是需要重新計算(recalculate)或者data為空
        // 那就要根據(jù)image重新生成新的data
        // 不過要是連image也為空的話,那就別存了
        if (image && (recalculate || !data)) {
#if TARGET_OS_IPHONE
            // 我們需要判斷image是PNG還是JPEG
            // PNG的圖片很容易檢測出來,因為它們有一個特定的標示 (http://www.w3.org/TR/PNG-Structure.html)
            // PNG圖片的前8個字節(jié)不許符合下面這些值(十進制表示)
            // 137 80 78 71 13 10 26 10
            
            // 如果imageData為空l (舉個例子,比如image在下載后需要transform,那么就imageData就會為空)
            // 并且image有一個alpha通道, 我們將該image看做PNG以避免透明度(alpha)的丟失(因為JPEG沒有透明色)
            int alphaInfo = CGImageGetAlphaInfo(image.CGImage);// 獲取image中的透明信息
            // 該image中確實有透明信息,就認為image為PNG
            BOOL hasAlpha = !(alphaInfo == kCGImageAlphaNone ||
                              alphaInfo == kCGImageAlphaNoneSkipFirst ||
                              alphaInfo == kCGImageAlphaNoneSkipLast);
            BOOL imageIsPng = hasAlpha;

            // 但是如果我們已經有了imageData,我們就可以直接根據(jù)data中前幾個字節(jié)判斷是不是PNG
            if ([imageData length] >= [kPNGSignatureData length]) {
                // ImageDataHasPNGPreffix就是為了判斷imageData前8個字節(jié)是不是符合PNG標志
                imageIsPng = ImageDataHasPNGPreffix(imageData);
            }

            // 如果image是PNG格式,就是用UIImagePNGRepresentation將其轉化為NSData,否則按照JPEG格式轉化,并且壓縮質量為1,即無壓縮
            if (imageIsPng) {
                data = UIImagePNGRepresentation(image);
            }
            else {
                data = UIImageJPEGRepresentation(image, (CGFloat)1.0);
            }
#else
            // 當然,如果不是在iPhone平臺上,就使用下面這個方法。不過不在我們研究范圍之內
            data = [NSBitmapImageRep representationOfImageRepsInArray:image.representations usingType: NSJPEGFileType properties:nil];
#endif
        }

        // 獲取到需要存儲的data后,下面就要用fileManager進行存儲了
        if (data) {
            // 首先判斷disk cache的文件路徑是否存在,不存在的話就創(chuàng)建一個
            // disk cache的文件路徑是存儲在_diskCachePath中的
            if (![_fileManager fileExistsAtPath:_diskCachePath]) {
                [_fileManager createDirectoryAtPath:_diskCachePath withIntermediateDirectories:YES attributes:nil error:NULL];
            }

            // 根據(jù)image的key(一般情況下理解為image的url)組合成最終的文件路徑
            // 上面那個生成的文件路徑只是一個文件目錄,就跟/cache/images/img1.png和cache/images/的區(qū)別一樣
            NSString *cachePathForKey = [self defaultCachePathForKey:key];
            // 這個url可不是網(wǎng)絡端的url,而是file在系統(tǒng)路徑下的url
            // 比如/foo/bar/baz --------> file:///foo/bar/baz
            NSURL *fileURL = [NSURL fileURLWithPath:cachePathForKey];

            // 根據(jù)存儲的路徑(cachePathForKey)和存儲的數(shù)據(jù)(data)將其存放到iOS的文件系統(tǒng)
            [_fileManager createFileAtPath:cachePathForKey contents:data attributes:nil];

            // disable iCloud backup
            if (self.shouldDisableiCloud) {
                [fileURL setResourceValue:[NSNumber numberWithBool:YES] forKey:NSURLIsExcludedFromBackupKey error:nil];
            }
        }
    });
}
}

?。?/h4>

內存緩存使用NSCache的objectForKey取數(shù)據(jù):

- (UIImage *)imageFromMemoryCacheForKey:(NSString *)key {
    return [self.memCache objectForKey:key];
}

磁盤取數(shù)據(jù) 不斷用 dataWithContentsOfFile來試數(shù)據(jù)是否在key對應的路徑中

- (UIImage *)imageFromDiskCacheForKey:(NSString *)key {

// First check the in-memory cache...
UIImage *image = [self imageFromMemoryCacheForKey:key];
if (image) {
    return image;
}

// Second check the disk cache...
UIImage *diskImage = [self diskImageForKey:key];
if (diskImage && self.shouldCacheImagesInMemory) {
    NSUInteger cost = SDCacheCostForImage(diskImage);
    [self.memCache setObject:diskImage forKey:key cost:cost];
}

return diskImage;
}

刪:

  1. removeImageForKeyfromDisk:withCompletion: // 異步地將image從緩存(內存緩存以及可選的磁盤緩存)中移除
  2. clearMemory // 清楚內存緩存上的所有image
  3. clearDisk // 清除磁盤緩存上的所有image
  4. cleanDisk // 清除磁盤緩存上過期的image
    看其中最長的一個:
// 實現(xiàn)了一個簡單的緩存清除策略:清除修改時間最早的file
- (void)cleanDiskWithCompletionBlock:(SDWebImageNoParamsBlock)completionBlock {
dispatch_async(self.ioQueue, ^{
    // 這兩個變量主要是為了下面生成NSDirectoryEnumerator準備的
    // 一個是記錄遍歷的文件目錄,一個是記錄遍歷需要預先獲取文件的哪些屬性
    NSURL *diskCacheURL = [NSURL fileURLWithPath:self.diskCachePath isDirectory:YES];
    NSArray *resourceKeys = @[NSURLIsDirectoryKey, NSURLContentModificationDateKey, NSURLTotalFileAllocatedSizeKey];

    // 遞歸地遍歷diskCachePath這個文件夾中的所有目錄,此處不是直接使用diskCachePath,而是使用其生成的NSURL
    // 此處使用includingPropertiesForKeys:resourceKeys,這樣每個file的resourceKeys對應的屬性也會在遍歷時預先獲取到
    // NSDirectoryEnumerationSkipsHiddenFiles表示不遍歷隱藏文件
    NSDirectoryEnumerator *fileEnumerator = [_fileManager enumeratorAtURL:diskCacheURL
                                               includingPropertiesForKeys:resourceKeys
                                                                  options:NSDirectoryEnumerationSkipsHiddenFiles
                                                             errorHandler:NULL];
    // 獲取文件的過期時間,SDWebImage中默認是一個星期
    // 不過這里雖然稱*expirationDate為過期時間,但是實質上并不是這樣。
    // 其實是這樣的,比如在2015/12/12/00:00:00最后一次修改文件,對應的過期時間應該是
    // 2015/12/19/00:00:00,不過現(xiàn)在時間是2015/12/27/00:00:00,我先將當前時間減去1個星期,得到
    // 2015/12/20/00:00:00,這個時間才是我們函數(shù)中的expirationDate。
    // 用這個expirationDate和最后一次修改時間modificationDate比較看誰更晚就行。
    NSDate *expirationDate = [NSDate dateWithTimeIntervalSinceNow:-self.maxCacheAge];
    // 用來存儲對應文件的一些屬性,比如文件所需磁盤空間
    NSMutableDictionary *cacheFiles = [NSMutableDictionary dictionary];
    // 記錄當前已經使用的磁盤緩存大小
    NSUInteger currentCacheSize = 0;

    // 在緩存的目錄開始遍歷文件.  此次遍歷有兩個目的:
    //
    //  1. 移除過期的文件
    //  2. 同時存儲每個文件的屬性(比如該file是否是文件夾、該file所需磁盤大小,修改時間)
    NSMutableArray *urlsToDelete = [[NSMutableArray alloc] init];
    for (NSURL *fileURL in fileEnumerator) {
        NSDictionary *resourceValues = [fileURL resourceValuesForKeys:resourceKeys error:NULL];

        // 當前掃描的是目錄,就跳過
        if ([resourceValues[NSURLIsDirectoryKey] boolValue]) {
            continue;
        }

        // 移除過期文件
        // 這里判斷過期的方式:對比文件的最后一次修改日期和expirationDate誰更晚,如果expirationDate更晚,就認為該文件已經過期,具體解釋見上面
        NSDate *modificationDate = resourceValues[NSURLContentModificationDateKey];
        if ([[modificationDate laterDate:expirationDate] isEqualToDate:expirationDate]) {
            [urlsToDelete addObject:fileURL];
            continue;
        }

        // 計算當前已經使用的cache大小,
        // 并將對應file的屬性存到cacheFiles中
        NSNumber *totalAllocatedSize = resourceValues[NSURLTotalFileAllocatedSizeKey];
        currentCacheSize += [totalAllocatedSize unsignedIntegerValue];
        [cacheFiles setObject:resourceValues forKey:fileURL];
    }
    
    for (NSURL *fileURL in urlsToDelete) {
        // 根據(jù)需要移除文件的url來移除對應file
        [_fileManager removeItemAtURL:fileURL error:nil];
    }

    // 如果我們當前cache的大小已經超過了允許配置的緩存大小,那就刪除已經緩存的文件。
    // 刪除策略就是,首先刪除修改時間更早的緩存文件
    if (self.maxCacheSize > 0 && currentCacheSize > self.maxCacheSize) {
        // 直接將當前cache大小降到允許最大的cache大小的一般
        const NSUInteger desiredCacheSize = self.maxCacheSize / 2;

        // 根據(jù)文件修改時間來給所有緩存文件排序,按照修改時間越早越在前的規(guī)則排序
        NSArray *sortedFiles = [cacheFiles keysSortedByValueWithOptions:NSSortConcurrent
                                                        usingComparator:^NSComparisonResult(id obj1, id obj2) {
                                                            return [obj1[NSURLContentModificationDateKey] compare:obj2[NSURLContentModificationDateKey]];
                                                        }];

        // 每次刪除file后,就計算此時的cache的大小
        // 如果此時的cache大小已經降到期望的大小了,就停止刪除文件了
        for (NSURL *fileURL in sortedFiles) {
            if ([_fileManager removeItemAtURL:fileURL error:nil]) {
                // 獲取該文件對應的屬性
                NSDictionary *resourceValues = cacheFiles[fileURL];
    // 根據(jù)resourceValues獲取該文件所需磁盤空間大小
                NSNumber *totalAllocatedSize = resourceValues[NSURLTotalFileAllocatedSizeKey];
    // 計算當前cache大小
                currentCacheSize -= [totalAllocatedSize unsignedIntegerValue];

                if (currentCacheSize < desiredCacheSize) {
                    break;
                }
            }
        }
    }
    // 如果有completionBlock,就在主線程中調用
    if (completionBlock) {
        dispatch_async(dispatch_get_main_queue(), ^{
            completionBlock();
        });
    }
});
}

圖片儲存路徑:

// 簡單封裝了cachePathForKey:inPath
- (NSString *)defaultCachePathForKey:(NSString *)key {
    return [self cachePathForKey:key inPath:self.diskCachePath];
}

// cachePathForKey:inPath
- (NSString *)cachePathForKey:(NSString *)key inPath:(NSString *)path {
// 根據(jù)傳入的key創(chuàng)建最終要存儲時的文件名
NSString *filename = [self cachedFileNameForKey:key];
// 將存儲的文件路徑和文件名綁定在一起,作為最終的存儲路徑
return [path stringByAppendingPathComponent:filename];
}

// cachedFileNameForKey:
- (NSString *)cachedFileNameForKey:(NSString *)key {
const char *str = [key UTF8String];
if (str == NULL) {
    str = "";
}
// 使用了MD5進行加密處理
// 開辟一個16字節(jié)(128位:md5加密出來就是128bit)的空間
unsigned char r[CC_MD5_DIGEST_LENGTH];
// 官方封裝好的加密方法
// 把str字符串轉換成了32位的16進制數(shù)列(這個過程不可逆轉) 存儲到了r這個空間中
CC_MD5(str, (CC_LONG)strlen(str), r);
// 最終生成的文件名就是 "md5碼"+".文件類型"
NSString *filename = [NSString stringWithFormat:@"%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%02x%@",
                      r[0], r[1], r[2], r[3], r[4], r[5], r[6], r[7], r[8], r[9], r[10],
                      r[11], r[12], r[13], r[14], r[15], [[key pathExtension] isEqualToString:@""] ? @"" : [NSString stringWithFormat:@".%@", [key pathExtension]]];

return filename;
}
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內容

友情鏈接更多精彩內容