SDWebImage源码分析

SDWebImage库是一个支持缓存的异步图片下载库。为了方便使用,它提供了UIImageView, UIButton, MKAnnotationView等UI组件的分类。它的优点包含以下:

  • 异步图片下载器
  • 异步的内存+磁盘图片缓存,自动缓存过期处理
  • 后台图片解压
  • 同一个URL不会多次下载的保证机制
  • 错误的URL不会多次尝试的保证机制
  • 主线程不会被block的保证机制
  • 良好的性能
  • 使用GCD和ARC

下面以UIImageView为例,讲一下获取图片的流程。

  1. 首先UIImageView调用sd_setImageWithURL来获得图片。
  2. 这个接口的内部调用UIView+webCache分类的sd_internalSetImageWithURL。
  3. sd_internalSetImageWithURL这个方法内部调用SDWebImageManager的loadImageWithURL方法。
  4. SDWebImageManager是一个总的管理类。它首先通过SDWebImageCache的queryCacheOperationForKey去检查图片的缓存是否存在。
  5. 如果存在就直接返回图片给最外层。
  6. 如果不存在就会用SDWebImageDownloader中的downloadImageWithURL方法去下载图片。下载完成后首先通过SDWebImageCache来缓存图片,再返回图片给最外层。
sdwebimage.png
1. SDWebImageManager
- (nullable id <SDWebImageOperation>)loadImageWithURL:(nullable NSURL *)url
                                          options:(SDWebImageOptions)options
                                         progress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
                                        completed:(nullable SDInternalCompletionBlock)completedBlock;

SDWebImageManager是一个管理类,管理从缓存获取图片和downloader下载图片。

  • 它是一个单例。
  • 它维护了SDImageCache的单例,用来获取缓存
  • 它维护了SDWebImageDownloader的单例,用来下载图片。
  • 它维护了一个failedURLs黑名单,如果URL在黑名单中,则会取消操作。
  • 它维护了一个runingOperation的数组,可以取消和增加operation。
2. SDImageCache
- (nullable NSOperation *)queryCacheOperationForKey:(nullable NSString *)key done:(nullable SDCacheQueryCompletedBlock)doneBlock;

SDImageCache是一个缓存管理类,管理NSCache和disk中的缓存。它首先从NSCache中获取缓存,获取不到再从disk中获取。

  • NSCache是一个线程安全的类,在系统内存不足的情况下默认会自动释放部分内存。它的用法和NSMutableDictionary类似。

  • NSCache中找不到,就会另起一个线程去从disk中获取图片。文件名以url的16位md5后的字符串,然后每一位字符转换为16进制数命名,防止文件名冲突。

    - (nullable NSString *)cachedFileNameForKey:(nullable NSString *)key {
       const char *str = key.UTF8String;
       if (str == NULL) {
          str = "";
       }
       unsigned char r[CC_MD5_DIGEST_LENGTH];
       CC_MD5(str, (CC_LONG)strlen(str), r);
       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;
    }
    
  • 它可以对所有的缓存整体操作,清理内存缓存和磁盘缓存。而且通过NSNotification注册内存警告,关闭,后台事件,会自动清理过期缓存。事件默认是1周,大小默认没有限制。

      [[NSNotificationCenter defaultCenter] addObserver:self
                                               selector:@selector(clearMemory)
                                                   name:UIApplicationDidReceiveMemoryWarningNotification
                                                 object:nil];
    
      [[NSNotificationCenter defaultCenter] addObserver:self
                                               selector:@selector(deleteOldFiles)
                                                   name:UIApplicationWillTerminateNotification
                                                 object:nil];
    
      [[NSNotificationCenter defaultCenter] addObserver:self
                                               selector:@selector(backgroundDeleteOldFiles)
                                                   name:UIApplicationDidEnterBackgroundNotification
                                                 object:nil];
    
3. SDWebImageDownloader
- (nullable SDWebImageDownloadToken *)downloadImageWithURL:(nullable NSURL *)url
                                               options:(SDWebImageDownloaderOptions)options
                                              progress:(nullable SDWebImageDownloaderProgressBlock)progressBlock
                                             completed:(nullable SDWebImageDownloaderCompletedBlock)completedBlock;
  • 它是一个单例。
  • 它维护了一个downloadQueue(NSOperationQueue),最大并发数为6,默认先进先出。
- (nonnull instancetype)initWithSessionConfiguration:(nullable NSURLSessionConfiguration *)sessionConfiguration {
if ((self = [super init])) {
    _operationClass = [SDWebImageDownloaderOperation class];
    _shouldDecompressImages = YES;
    _executionOrder = SDWebImageDownloaderFIFOExecutionOrder;
    _downloadQueue = [NSOperationQueue new];
    _downloadQueue.maxConcurrentOperationCount = 6;
    _downloadQueue.name = @"com.hackemist.SDWebImageDownloader";
    _URLOperations = [NSMutableDictionary new];
#ifdef SD_WEBP
    _HTTPHeaders = [@{@"Accept": @"image/webp,image/*;q=0.8"} mutableCopy];
#else
    _HTTPHeaders = [@{@"Accept": @"image/*;q=0.8"} mutableCopy];
#endif
    _barrierQueue = dispatch_queue_create("com.hackemist.SDWebImageDownloaderBarrierQueue", DISPATCH_QUEUE_CONCURRENT);
    _downloadTimeout = 15.0;

    sessionConfiguration.timeoutIntervalForRequest = _downloadTimeout;

    /**
     *  Create the session for this task
     *  We send nil as delegate queue so that the session creates a serial operation queue for performing all delegate
     *  method calls and completion handler calls.
     */
    self.session = [NSURLSession sessionWithConfiguration:sessionConfiguration
                                                 delegate:self
                                            delegateQueue:nil];
     }
     return self;
}
  • 它维护了一个URLOperations字典,以URL为key,operation为value,从而确保同一个URL不会多次下载。同时通过dispatch_barrier_sync来同步执行下载操作。

    - (nullable SDWebImageDownloadToken *)addProgressCallback:(SDWebImageDownloaderProgressBlock)progressBlock
                                         completedBlock:(SDWebImageDownloaderCompletedBlock)completedBlock
                                                 forURL:(nullable NSURL *)url
                                         createCallback:(SDWebImageDownloaderOperation *(^)())createCallback {
    // The URL will be used as the key to the callbacks dictionary so it cannot be nil. If it is nil immediately call the completed block with no image or data.
    if (url == nil) {
      if (completedBlock != nil) {
          completedBlock(nil, nil, nil, NO);
      }
      return nil;
    }
    
    __block SDWebImageDownloadToken *token = nil;
    
    dispatch_barrier_sync(self.barrierQueue, ^{
      SDWebImageDownloaderOperation *operation = self.URLOperations[url];
      if (!operation) {
          operation = createCallback();
          self.URLOperations[url] = operation;
    
          __weak SDWebImageDownloaderOperation *woperation = operation;
          operation.completionBlock = ^{
            SDWebImageDownloaderOperation *soperation = woperation;
            if (!soperation) return;
            if (self.URLOperations[url] == soperation) {
                [self.URLOperations removeObjectForKey:url];
            };
          };
      }
      id downloadOperationCancelToken = [operation addHandlersForProgress:progressBlock completed:completedBlock];
    
      token = [SDWebImageDownloadToken new];
      token.url = url;
      token.downloadOperationCancelToken = downloadOperationCancelToken;
    });
    
    return token;
    }
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,271评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,275评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,151评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,550评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,553评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,559评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,924评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,580评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,826评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,363评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,940评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2 342

推荐阅读更多精彩内容