SDWebImage源码解读 (一)

SDWebImage (v4.4.1)

特点:

  • Categories for UIImageView, UIButton, MKAnnotationView adding web image and cache management
  • An asynchronous image downloader - 异步下载
  • An asynchronous memory + disk image caching with automatic cache expiration handling - 缓存自动到期,memory和disk缓存
  • A background image decompression - 后台解压
  • A guarantee that the same URL won't be downloaded several times - URL不会被多次下载
  • A guarantee that bogus URLs won't be retried again and again - 虚假的URL不会被持续重试
  • A guarantee that main thread will never be blocked
    Performances! - 主线程安全
  • Use GCD and ARC

目录

  • 主要方法
  • SDWebImageOperation
  • SDWebImageCompat
  • Decoder
  • SDWebImageCodersManager
  • SDWebImageCoder
  • SDWebImageFrame
  • SDWebImageGIFCoder
  • SDWebImageWebPCoder
  • SDWebImageImageIOCoder
  • SDAnimatedImageRep
  • SDWebImageCoderHelper
  • Utils
  • SDWebImageManager
  • SDWebImagePrefetcher
  • SDWebImageTransition
  • Downloader
  • SDWebImageDownloader
  • SDWebImageDownloaderOperation
  • Cache
  • SDImageCache
  • SDImageCacheConfig
  • WebCacheCategories
  • NSImage+WebCache
  • NSButton+WebCache
  • MKAnnotationView+WebCache
  • UIView+WebCache
  • UIButton+WebCache
  • UIImageView+WebCache
  • UIImageView+HighlightedWebCache
  • Categories
  • NSData+ImageContentType
  • UIImage+WebP
  • UIView+WebCacheOperation
  • UIImage+ForceDecode
  • UIImage+GIF
  • UIImage+MultiFormat
  • FLAnimatedImage
  • FLAnimatedImageView+WebCache

主要类名及其作用

类名 功能
SDWebImageOperation 宏定义、常量、常用方法
SDWebImageCompat 统一cancel方法
SDWebImageCodersManager 总体入口
SDWebImageCoder 需要实现的接口
SDWebImageImageIOCoder PNG/JPEG的Coder操作
SDWebImageGIFCoder GIF的Coder操作
SDWebImageWebPCoder WebP的Coder操作
SDWebImageManager 管理cache和download入口
SDWebImagePrefetcher 预处理获取Image
SDWebImageTransition 过渡动画
SDWebImageDownloader 提供下载管理入口
SDWebImageDownloaderOperation 下载的Operation操作
SDImageCache 处理缓存逻辑
SDImageCacheConfig 配置缓存参数
NSData+ImageContentType 提供类型判断和ImageIO类型转换
UIImage+GIF Data转UIImage(GIF)扩展
UIImage+ForceDecode 解压操作
UIView+WebCacheOperation 提供顶层关于取消和下载记录的扩展

主要方法

SDWebImageOperation

这里代码不多,只实现了一个SDWebImageOperation协议。

@protocol SDWebImageOperation 
- (void)cancel;

这里是为了安全和简洁。调用这个cancel方法,会使得它持有的两个operation(SDWebImageCombinedOperation和SDWebImageManager)都被cancel

SDWebImageCompat

这里在最开始先是使用OBJC_GC宏来告知使用者,SDWebimage是不支持垃圾回收机制的。
接着,作者在这里吐槽了一下Apple的平台判断宏。

 Apple's defines from TargetConditionals.h are a bit weird.
 Apple的从TargetConditionals.h引用的宏有点诡异。
 Seems like TARGET_OS_MAC is always defined (on all platforms).
 好像TARGET_OS_MAC 是在所有的平台上被默认(都是1)
 To determine if we are running on OSX, we can only rely on TARGET_OS_IPHONE=0 and all the other platforms
为了确定我们是否正在运行OSX,我们只能靠target_os_iphone = 0 和 其他所有的平台

这里我标注一下这个宏的槽点

 +------------------------------------------------+
 |                TARGET_OS_MAC                   |
 | +---+  +-------------------------------------+ |
 | |   |  |          TARGET_OS_IPHONE           | |
 | |OSX|  | +-----+ +----+ +-------+ +--------+ | |
 | |   |  | | IOS | | TV | | WATCH | | BRIDGE | | |
 | |   |  | +-----+ +----+ +-------+ +--------+ | |
 | +---+  +-------------------------------------+ |
 +------------------------------------------------+
 

接着就是一段冗长而又必要的平台判断。

枚举宏的细节

这里有一个很有意思的点是,作者把NS_ENUM和NS_OPTIONS的宏重写了一遍,改成了一样的位运算的样子。

#ifndef NS_ENUM
#define NS_ENUM(_type, _name) enum _name : _type _name; enum _name : _type
#endif

#ifndef NS_OPTIONS
#define NS_OPTIONS(_type, _name) enum _name : _type _name; enum _name : _type
#endif

之所以这么写的原因是因为,普通的NS_ENUM只能使用在Objective-C下,在C++/Objective-C++下使用会出现问题。

主线程判断

dispatch_main_sync_safe宏是一个保证block在主线程执行的方法。
在之前的版本中,主线程判断使用的是NSThread来判断

#define dispatch_main_sync_safe(block)\
    if ([NSThread isMainThread]) {\
        block();\
    } else {\
        dispatch_sync(dispatch_get_main_queue(), block);\
    }

但是这个方法有个问题,它只能判断线程是否是主线程,但是无法判断队列是否是当前队列
现在更新了一个新的方法。

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

#ifndef dispatch_main_async_safe
#define dispatch_main_async_safe(block) dispatch_queue_async_safe(dispatch_get_main_queue(), block)
#endif

strcmp()是c语言的字符串比较函数. strcmp(s1,s2) 判断两个字符串s1和s2是否相同,相同== 0; 如果当前线程已经是主线程了,那么在调用dispatch_async(dispatch_get_main_queue(), block)有可能会出现crash;如果当前线程不是主线程,调用dispatch_async(dispatch_get_main_queue(), block)
通过这样的判断,可以保证是主线程当前队列。
这么做的原因是可以查看这个。以及张星宇的这篇文章。

修改图片尺寸

有时候,后台传给我们的图片是有多张的,需要去适配屏幕大小。
我们需要判断标识的比例来进行调整。

inline UIImage *SDScaledImageForKey(NSString * _Nullable key, UIImage * _Nullable image) {
    if (!image)
    {
        return nil;
    }
    
#if SD_MAC
    return image;
#elif SD_UIKIT || SD_WATCH
    //如果是动态图片,比如GIF图片,则迭代处理
    if ((image.images).count > 0)
    {
        NSMutableArray *scaledImages = [NSMutableArray array];

        for (UIImage *tempImage in image.images) {
            [scaledImages addObject:SDScaledImageForKey(key, tempImage)];
        }
        
        UIImage *animatedImage = [UIImage animatedImageWithImages:scaledImages duration:image.duration];
        if (animatedImage) {
            animatedImage.sd_imageLoopCount = image.sd_imageLoopCount;
        }
        //把处理结束的图片再合成一张动态图片
        return animatedImage;
    }
    else
    {
#if SD_WATCH
        //判断screenScale方法是否存在
        if ([[WKInterfaceDevice currentDevice] respondsToSelector:@selector(screenScale)]) {
#elif SD_UIKIT
        //判断scale方法是否存在
        if ([[UIScreen mainScreen] respondsToSelector:@selector(scale)])
        {
#endif
            CGFloat scale = 1;
            // “@2x.png”的长度为7,所以此处添加了这个判断,很巧妙
            if (key.length >= 8)
            {
                NSRange range = [key rangeOfString:@"@2x."];
                if (range.location != NSNotFound) {
                    scale = 2.0;
                }
                //这里需要判断图片的大小
                range = [key rangeOfString:@"@3x."];
                if (range.location != NSNotFound) {
                    scale = 3.0;
                }
            }
            // 使用initWithCGImage来根据Core Graphics的图片构建UIImage。
            UIImage *scaledImage = [[UIImage alloc] initWithCGImage:image.CGImage scale:scale orientation:image.imageOrientation];
            image = scaledImage;
        }
        return image;
    }
#endif
}

图片加载的顺序

从磁盘里获取图片

1.磁盘区拷贝数据到内核缓冲区;
2.内核缓冲区复制数据到用户控件;
3.生成UIImageView并赋值;
4.如果图像是未解码的PNG/JPEG,就解码为位图数据;
5.CATransation捕获到UIImageView layer树变化;
6.主线程提交CATranstion开始渲染;
7.若没有字节对齐,先进行字节对齐;
8.GPU处理位图数据,开始渲染。

你可能感兴趣的:(SDWebImage源码解读 (一))