让源码阅读更简单（二、SDWebImage）

作者: nucky_lee | 来源:发表于2019-02-16 15:20 被阅读55次

原理（核心逻辑）：

UIImageView或者UIButton调用

[xxx sd_setImageWithURL:url placeholderImage:placeholderImage];

经过层层调用后都会跳转到UIView (WebCache)分类中执行


- (void)sd_internalSetImageWithURL:(nullable  NSURL *)url
                  placeholderImage:(nullable  UIImage *)placeholder
                           options:(SDWebImageOptions)options
                      operationKey:(nullable  NSString *)operationKey
                     setImageBlock:(nullable  SDSetImageBlock)setImageBlock
                          progress:(nullable  SDWebImageDownloaderProgressBlock)progressBlock
                         completed:(nullable  SDExternalCompletionBlock)completedBlock
                           context:(nullable  NSDictionary<NSString *, id> *)context;

该方法中，主要做了以下几件事：

取消当前正在进行的加载任务 operation
设置 placeholder
如果 URL 不为 nil，就通过 SDWebImageManager 单例开启图片加载任务 operation

SDWebImageManager 的图片加载方法：

会先拿图片缓存的 key （这个 key 默认是图片 URL）去 SDImageCache单例中读取内存缓存，如果有，就返回给 SDWebImageManager；如果内存缓存没有，就开启异步线程，拿经过 MD5 处理的 key 去读取磁盘缓存，如果找到磁盘缓存了，就同步到内存缓存中去，然后再返回给 SDWebImageManager。

如果内存缓存和磁盘缓存中都没有，SDWebImageManager就会调用 SDWebImageDownloader单例的 -downloadImageWithURL: options: progress: completed:方法去下载。图片下载请求完成后，会回调给SDWebImageManager，SDWebImageManager中再将图片分别缓存到内存和磁盘上（可选），并回调给 UIImageView或UIButton回到主线程设置 image属性。

实现细节

1、SDWebImage 如何保证UI操作放在主线程中执行？

在SDWebImage的SDWebImageCompat.h中有这样一个宏定义，用来保证主线程操作


#ifndef dispatch_main_async_safe
#define dispatch_main_async_safe(block)\
  if (strcmp(dispatch_queue_get_label(DISPATCH_CURRENT_QUEUE_LABEL), dispatch_queue_get_label(dispatch_get_main_queue())) == 0) {\
     block();\
  } else {\
     dispatch_async(dispatch_get_main_queue(), block);\
  }
#endif

增加 #ifndef 是为了提高代码的严谨，防止重复定义（#ifndef 如果没有宏定义）

strcmp函数

strcmp()函数是根据ACSII码的值来比较两个字符串的；strcmp()函数首先将s1字符串的第一个字符值减去s2第一个字符，若差值为零则继续比较下去；若差值不为零，则返回差值。

若s1、s2字符串相等，则返回零；若s1大于s2，则返回大于零的数；否则，则返回小于零的数。

为什么不用[NSThread isMainThread]？

如果在主线程执行非主队列调度的API，而这个API需要检查是否由主队列上调度，那么将会出现问题。

2、图片下载SDWebImageDownloader

+initialize 方法（ + initialize 方法：苹果官方对这个方法有这样的一段描述：这个方法会在第一次初始化这个类之前被调用，我们用它来初始化静态变量。）

这个方法中主要是通过注册通知让SDNetworkActivityIndicator监听下载事件，来显示和隐藏状态栏上的 network activity indicator。为了让 SDNetworkActivityIndicator文件可以不用导入项目中来（如果不要的话），这里使用了 runtime 的方式来实现动态创建类以及调用方法。


+ (void)initialize {
  if (NSClassFromString(@"SDNetworkActivityIndicator")) {
    id activityIndicator = [NSClassFromString(@"SDNetworkActivityIndicator") performSelector:NSSelectorFromString(@"sharedActivityIndicator")];
    # 先移除通知观察者 SDNetworkActivityIndicator
    # 再添加通知观察者 SDNetworkActivityIndicator
  }
}

+sharedDownloader方法中调用了 -init方法来创建一个单例，-init方法中做了一些初始化设置和默认值设置，包括设置最大并发数（6）、下载超时时长（15s）等。


- (id)init { 
 #设置下载 operation 的默认执行顺序（先进先出还是先进后出）
 #初始化 _downloadQueue（下载队列）
 #设置 _downloadQueue 的队列最大并发数默认值为 6 
 #设置 _HTTPHeaders 默认值 
 #设置默认下载超时时长 15s 
 ... 
}

SDWebImageDownloader类中最核心的方法就是 - downloadImageWithURL: options: progress: completed:方法，这个方法中首先通过调用 -addProgressCallback: andCompletedBlock: forURL: createCallback:方法来保存每个 url 对应的回调 block，-addProgressCallback: ...方法先进行错误检查，判断 URL 是否为空，然后再将 URL 对应的 progressBlock和 completedBlock保存到 URLCallbacks属性中去。

如果这个 URL 是第一次被下载，就要回调 createCallback，createCallback 主要做的就是创建并开启下载任务，下面是 createCallback 的具体实现逻辑：


- (nullable  SDWebImageDownloadToken *)downloadImageWithURL:(nullable  NSURL *)url

                                                   options:(SDWebImageDownloaderOptions)options

                                                  progress:(nullable  SDWebImageDownloaderProgressBlock)progressBlock

                                                 completed:(nullable  SDWebImageDownloaderCompletedBlock)completedBlock {

  #1\. 调用 - [SDWebImageDownloader addProgressCallback: andCompletedBlock: forURL: createCallback: ] 方法，直接把入参 url、progressBlock 和 completedBlock 传进该方法，并在第一次下载该 URL 时回调 createCallback
## createCallback 的回调处理：{

    1.1 创建下载 request ，设置 request 的 cachePolicy、HTTPShouldHandleCookies、HTTPShouldUsePipelining，以及 allHTTPHeaderFields（这个属性交由外面处理，设计的比较巧妙）

    1.2 创建 SDWebImageDownloaderOperation（继承自 NSOperation）

    SDWebImageDownloaderOperation *operation = [[sself.operationClass  alloc] initWithRequest:request inSession:sself.session  options:options];

  ### 1.2.1 SDWebImageDownloaderOperation 通过NSURLSession创建图片请求dataTask，并实现NSURLSessionTaskDelegate, NSURLSessionDataDelegate代理协议

    1.3 设置下载完成后是否需要解压缩

    1.4 如果设置了 username 和 password，就给 operation 的下载请求设置一个 NSURLCredential

    1.5 设置 operation 的队列优先级

    1.6 将 operation 加入到队列 downloadQueue 中，队列（NSOperationQueue）会自动管理 operation 的执行

    1.7 如果 operation 执行顺序是先进后出，就设置 operation 依赖关系（先加入的依赖于后加入的），并记录最后一个 operation（lastAddedOperation）

  }

  #2\. 返回 createCallback 中创建的 operation（SDWebImageDownloaderOperation）
}

3、SDWebImage 的Memory内存缓存和Disk磁盘缓存是怎样实现的？

首先我们想一想，为什么需要缓存？

以空间换时间，提升用户体验：加载同一张图片，读取缓存是肯定比远程下载的速度要快得多的
减少不必要的网络请求，提升性能，节省流量：一般来讲，同一张图片的 URL 是不会经常变化的，所以没有必要重复下载。另外，现在的手机存储空间都比较大，相对于流量来，缓存占的那点空间算不了什么

SDImageCache

实现缓存功能的类->SDImageCache，继承自NSObject。它提供了内存缓存和磁盘缓存两种缓存方式

枚举


typedef NS_ENUM(NSInteger, SDImageCacheType) { SDImageCacheTypeNone, // 没有读取到图片缓存，需要从网上下载 SDImageCacheTypeDisk, // 磁盘中的缓存 SDImageCacheTypeMemory // 内存中的缓存 };

.h 文件中的属性：


@property (assign, nonatomic) BOOL shouldDecompressImages; // 读取磁盘缓存后，是否需要对图片进行解压缩 @property (assign, nonatomic) NSUInteger maxMemoryCost; // 其实就是 NSCache 的 totalCostLimit，内存缓存总消耗的最大限制，cost 是根据内存中的图片的像素大小来计算的 @property (assign, nonatomic) NSUInteger maxMemoryCountLimit; // 其实就是 NSCache 的 countLimit，内存缓存的最大数目 @property (assign, nonatomic) NSInteger maxCacheAge; // 磁盘缓存的最大时长，也就是说缓存存多久后需要删掉 @property (assign, nonatomic) NSUInteger maxCacheSize; // 磁盘缓存文件总体积最大限制，以 bytes 来计算

Memory缓存实现

SDWebImage 专门实现了一个叫做 SDMemoryCache的类继承自 NSCache ，相比于普通的 NSCache，它提供了一个在内存紧张时候释放缓存的能力。
NSCache在系统内存很低时，会自动释放一些对象（而且是没有顺序的，所以SDWebImage中还使用了NSMapTable作为缓存的备份，当在NSCache找不到时，再去NSMapTable中查找）。

NSCache是线程安全的，所以SDWebImage中NSCache做增删操作没有加锁。

NSMapTable与NSMutableDictionary对象不同，缓存不会复制放入其中的键对象。


[[NSNotificationCenter  defaultCenter] addObserver:self

 selector:@selector(didReceiveMemoryWarning:)

 name:UIApplicationDidReceiveMemoryWarningNotification

 object:nil];

- (void)didReceiveMemoryWarning:(NSNotification *)notification {
 // Only remove cache, but keep weak cache
    [super  removeAllObjects];
}

写入缓存调用了NSCache的setObject:forKey:cost:方法


/** 在缓存中设置指定键名对应的值，并且指定该键值对的成本。当出现内存警告时，或者超出缓存的总成本上限时，缓存会开启一个回收过程，删除部分元素 @param cost 成本 (cost) 用于计算记录在缓冲中的所有对象的总成本 */ - (void)setObject:(ObjectType)obj forKey:(KeyType)key cost:(NSUInteger)g;


#define LOCK(lock) dispatch_semaphore_wait(lock, DISPATCH_TIME_FOREVER);

#define UNLOCK(lock) dispatch_semaphore_signal(lock);


// `setObject:forKey:` just call this with 0 cost. Override this is enough

- (void)setObject:(id)obj forKey:(id)key cost:(NSUInteger)g {
    [super  setObject:obj forKey:key cost:g];
    if (key && obj) {
       // Store weak cache
       LOCK(self.weakCacheLock);
       [self.weakCache  setObject:obj forKey:key];
       UNLOCK(self.weakCacheLock);
    }
}

NSMapTable 映射表

//使用强-弱映射表存储辅助缓存

self.weakCache = [[NSMapTable alloc] initWithKeyOptions:NSPointerFunctionsStrongMemory valueOptions:NSPointerFunctionsWeakMemory capacity:0];

NSDictionary 复制 key，并对它的 object 引用计数 +1。

NSMapTable 对key进行retain release操作，对value弱引用，不增加引用计数。

Disk磁盘缓存

创建了一个名为 IO的串行队列，所有Disk操作都在此队列中，逐个执行！！（不只是读取磁盘内容。包括删除、写入等所有磁盘内容都是在这个IO线程进行、以保证线程安全。）


// Create IO serial queue

 _ioQueue = dispatch_queue_create("com.hackemist.SDWebImageCache", DISPATCH_QUEUE_SERIAL);

判断当前是否是IOQueue(原理：七、SDWebImage 如何保证UI操作放在主线程中执行？)


- (void)checkIfQueueIsIOQueue { const char *currentQueueLabel = dispatch_queue_get_label(DISPATCH_CURRENT_QUEUE_LABEL); const char *ioQueueLabel = dispatch_queue_get_label(self.ioQueue); if (strcmp(currentQueueLabel, ioQueueLabel) != 0) { NSLog(@"This method should be called from the ioQueue"); } }

创建磁盘缓存路径


- (nullable  NSString *)makeDiskCachePath:(nonnull  NSString*)fullNamespace {
    NSArray<NSString *> *paths = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
    return [paths[0] stringByAppendingPathComponent:fullNamespace];
}

在主要存储函数中，dispatch_async(self.ioQueue, ^{})


// SDImageCache.m

- (void)storeImage:(nullable UIImage *)image
  imageData:(nullable NSData *)imageData
  forKey:(nullable NSString *)key
  toDisk:(BOOL)toDisk
  completion:(nullable SDWebImageNoParamsBlock)completionBlock {

    // .........

    if (toDisk) {
      dispatch_async(self.ioQueue, ^{
        @autoreleasepool {
          NSData *data = imageData;
          if (!data && image) {
          // If we do not have any data to detect image format, check whether it contains alpha channel to use PNG or JPEG format
             SDImageFormat format;
             if (SDCGImageRefContainsAlpha(image.CGImage)) {
               format = SDImageFormatPNG;
             } else {
               format = SDImageFormatJPEG;
             }
            data = [[SDWebImageCodersManager  sharedInstance] encodedDataWithImage:image format:format];
          }
          [self  _storeImageDataToDisk:data forKey:key];
      }
      if (completionBlock) {
        dispatch_async(dispatch_get_main_queue(), ^{
          completionBlock();
        });
      }
    });
  }

  // .........

}

4、SDWebImage Disk缓存时长？ Disk清理操作时间点？ Disk清理原则？

1、缓存时长默认为一周


// SDImageCacheConfig.m

static const NSInteger kDefaultCacheMaxCacheAge = 60 * 60 * 24 * 7; // 1 week

2、Disk清理操作时间点


// SDImageCache.m

[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(deleteOldFiles) name:UIApplicationWillTerminateNotification object:nil]; [[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(backgroundDeleteOldFiles) name:UIApplicationDidEnterBackgroundNotification object:nil];

分别在『应用被杀死时』和『应用进入后台时』进行清理操作

清理磁盘的方法


- (void)deleteOldFilesWithCompletionBlock:(nullable SDWebImageNoParamsBlock)completionBlock;

当应用进入后台时，会涉及到『Long-Running Task』

正常程序在进入后台后、虽然可以继续执行任务。但是在时间很短内就会被挂起待机。

Long-Running可以让系统为app再多分配一些时间来处理一些耗时任务。


- (void)backgroundDeleteOldFiles {

   Class UIApplicationClass = NSClassFromString(@"UIApplication");

   if(!UIApplicationClass || ![UIApplicationClass respondsToSelector:@selector(sharedApplication)]) {

     return;

    }

   UIApplication *application = [UIApplication  performSelector:@selector(sharedApplication)];

   __block  UIBackgroundTaskIdentifier bgTask = [application beginBackgroundTaskWithExpirationHandler:^{

     // Clean up any unfinished task business by marking where you

     // stopped or ending the task outright.

    [application endBackgroundTask:bgTask];

    bgTask = UIBackgroundTaskInvalid;

  }];

   // Start the long-running task and return immediately.

    [self  deleteOldFilesWithCompletionBlock:^{

      [application endBackgroundTask:bgTask];

      bgTask = UIBackgroundTaskInvalid;

    }];

}

磁盘清理原则

清理缓存的规则分两步进行。第一步先清除掉过期的缓存文件。如果清除掉过期的缓存之后，空间还不够。那么就继续按文件时间从早到晚排序，先清除最早的缓存文件，直到剩余空间达到要求。

具体点，SDWebImage 是怎么控制哪些缓存过期，以及剩余空间多少才够呢？通过两个属性：


@interface SDImageCacheConfig : NSObject /** * The maximum length of time to keep an image in the cache, in seconds */ @property (assign, nonatomic) NSInteger maxCacheAge; /** * The maximum size of the cache, in bytes. */ @property (assign, nonatomic) NSUInteger maxCacheSize;

maxCacheAge 和 maxCacheSize 有默认值吗？

maxCacheAge在上述已经说过了，是有默认值的 1week，单位秒。
maxCacheSize翻了一遍 SDWebImage 的代码，并没有对 maxCacheSize 设置默认值。这就意味着 SDWebImage 在默认情况下不会对缓存空间设限制。可以这样设置：

[SDImageCache sharedImageCache].maxCacheSize = 1024 * 1024 * 50; // 50M

maxCacheSize 是以字节来表示的，我们上面的计算代表 50M 的最大缓存空间。把这行代码写在你的 APP 启动的时候，这样 SDWebImage 在清理缓存的时候，就会清理多余的缓存文件了。

5、 NSData+ImageContentType根据图片数据获取图片的类型，比如GIF、PNG等


/**

根据图片NSData获取图片的类型

@param data NSData数据

@return 图片数据类型

*/

+ (SDImageFormat)sd_imageFormatForImageData:(nullable NSData *)data {
  if (!data) {
    return SDImageFormatUndefined;
  }

  uint8_t c;

  //获取图片数据的第一个字节数据
  [data getBytes:&c length:1];

  //根据字母的ASC码比较
  switch (c) {
    case 0xFF:
        return SDImageFormatJPEG;
    case 0x89:
        return SDImageFormatPNG;
    case 0x47:
        return SDImageFormatGIF;
    case 0x49:
    case 0x4D:
        return SDImageFormatTIFF;
    case 0x52:
        // R as RIFF for WEBP
      if (data.length < 12) {
        return SDImageFormatUndefined;
      }
      NSString *testString = [[NSString alloc] initWithData:[data subdataWithRange:NSMakeRange(0, 12)] encoding:NSASCIIStringEncoding];
      if ([testString hasPrefix:@"RIFF"] && [testString hasSuffix:@"WEBP"]) {
         return SDImageFormatWebP;
       }
     }
     return SDImageFormatUndefined;
}

参考链接：

SDWebImage4.0源码探究（一）面试题 https://www.jianshu.com/p/b8517dc833c7

让源码阅读更简单（二、SDWebImage）

原理（核心逻辑）：

实现细节

1、SDWebImage 如何保证UI操作放在主线程中执行？

2、图片下载SDWebImageDownloader

3、SDWebImage 的Memory内存缓存和Disk磁盘缓存是怎样实现的？

Memory缓存实现

NSMapTable 映射表

Disk磁盘缓存

4、SDWebImage Disk缓存时长？ Disk清理操作时间点？ Disk清理原则？

1、缓存时长默认为一周

2、Disk清理操作时间点

磁盘清理原则

maxCacheAge 和 maxCacheSize 有默认值吗？

5、 NSData+ImageContentType根据图片数据获取图片的类型，比如GIF、PNG等

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

iOS

iOS面试总结

第三方库解读