源码阅读:SDWebImage

2019-11-14 18:22:19

字体：大中小

来源：转载

供稿：网友

前言

SDWebImage是一个开源的iOS第三方库，主要用于下载并缓存网络图片，在我的博文iOS网络资源缓存ZCLURLCache·上篇提到过SDWebImage。它提供了UIImageView、MKAnnotationView、UIButton的categories（分类），支持网络图片的加载与缓存，其中UIImageView应该是使用最广泛的。

源码：https://github.com/rs/SDWebImage
目前版本：3.7

本文从源码的角度讨论SDWebImage的下载和缓存的实现。

流程

在SDWebImage的使用例子中，给UIImageView设置图片的代码是：

[cell.imageView sd_setImageWithURL:[NSURL URLWithString:[_objects objectAtIndex:indexPath.row]]                      placeholderImage:[UIImage imageNamed:@"placeholder"] options:indexPath.row == 0 ? SDWebImageRefreshCached : 0];

可以看出，SDWebImage的使用非常简单，只用这一行代码，就可实现网络图片的加载与缓存。在这行代码的背后，会执行下列操作：

UIImageView+WebCachecategories会从管理类SDWebImageManager找图片，并刷新UIImageView。
SDWebImageManager向从缓存类SDImageCache找URL对应的图片缓存，如果没找到，起用SDWebImageDownloader下载图片。
缓存类SDImageCache会先在内存NSCache中找图片，如果内存中没有，就在磁盘上找，在磁盘上找到了，把图片放入内存。
SDWebImageDownloader会创建一个SDWebImageDownloaderOperation操作队列下载图片，下载完后缓存在内存和磁盘上（可选）。
SDWebImageDownloaderOperation操作队列使用NSURLConnection在后台发起请求，下载图片，反馈进度和下载结果。

源码中有几个关键的类，分别是：

SDImageCache，缓存类，在内存和磁盘上缓存图片，并对图片编码。
SDWebImageDownloader，下载管理类，下载图片。
SDWebImageDownloaderOperation，下载操作队列，继承自NSOperation，在后台发起HTTP请求并下载图片。
SDWebImageManager，管理类，协调缓存类与下载类。
categories（分类），扩展视图。

SDImageCache

SDImageCache实现了图片的缓存机制，使用NSCache作为内存缓存，默认以com.hackemist.SDWebImageCache.default为磁盘的缓存命名空间，程序运行后，可以在应用程序的文件夹Library/Caches/default/com.hackemist.SDWebImageCache.default下看到一些缓存文件。当然，也可以指定其它命名空间初始化：

- (id)initWithNamespace:(NSString *)ns diskCacheDirectory:(NSString *)directory{    if ((self = [super init]))    {        NSString *fullNamespace = [@"com.hackemist.SDWebImageCache." stringByAppendingString:ns];        // initialise PNG signature data        kPNGSignatureData = [NSData dataWithBytes:kPNGSignatureBytes length:8];        // Create IO serial queue        _ioQueue = dispatch_queue_create("com.hackemist.SDWebImageCache", DISPATCH_QUEUE_SERIAL);        // Init default values        _maxCacheAge = kDefaultCacheMaxCacheAge;        // Init the memory cache        _memCache = [[AutoPurgeCache alloc] init];        _memCache.name = fullNamespace;        // Init the disk cache        if (directory != nil) {            _diskCachePath = [directory stringByAppendingPathComponent:fullNamespace];        } else {            NSString *path = [self makeDiskCachePath:ns];            _diskCachePath = path;        }        // Set decomPRession to YES        _shouldDecompressImages = YES;        // memory cache enabled        _shouldCacheImagesInMemory = YES;        // Disable iCloud        _shouldDisableiCloud = YES;        dispatch_sync(_ioQueue, ^{            _fileManager = [NSFileManager new];        });#if TARGET_OS_ipHONE        // Subscribe to app events        [[NSNotificationCenter defaultCenter] addObserver:self                                                 selector:@selector(clearMemory)                                                     name:UIapplicationDidReceiveMemoryWarningNotification                                                   object:nil];        [[NSNotificationCenter defaultCenter] addObserver:self                                                 selector:@selector(cleanDisk)                                                     name:UIApplicationWillTerminateNotification                                                   object:nil];        [[NSNotificationCenter defaultCenter] addObserver:self                                                 selector:@selector(backgroundCleanDisk)                                                     name:UIApplicationDidEnterBackgroundNotification                                                   object:nil];#endif    }    return self;}

SDImageCache会在系统发出低内存警告时释放内存，并且在程序进入UIApplicationWillTerminateNotification时，清理磁盘缓存，清理磁盘的机制是：

删除过期的图片，默认7天过期，可以通过maxCacheAge修改过期天数。
如果缓存的数据大小超过设置的最大缓存maxCacheSize，则继续删除缓存，优先删除最老的图片，可以通过修改maxCacheSize来改变最大缓存大小。

缓存中取图片

- (NSOperation *)queryDiskCacheForKey:(NSString *)key done:(SDWebImageQueryCompletedBlock)doneBlock{    if (!doneBlock){        return nil;    }    if (!key){        doneBlock(nil, SDImageCacheTypeNone);        return nil;    }    // First check the in-memory cache...    UIImage *image = [self imageFromMemoryCacheForKey:key];    if (image){        doneBlock(image, SDImageCacheTypeMemory);        return nil;    }    NSOperation *operation = [NSOperation new];    dispatch_async(self.ioQueue, ^{        if (operation.isCancelled){            return;        }        @autoreleasepool {            UIImage *diskImage = [self diskImageForKey:key];            if (diskImage && self.shouldCacheImagesInMemory){                NSUInteger cost = SDCacheCostForImage(diskImage);                [self.memCache setObject:diskImage forKey:key cost:cost];            }            dispatch_async(dispatch_get_main_queue(), ^{                doneBlock(diskImage, SDImageCacheTypeDisk);            });        }    });    return operation;}

传人的Block定义是：

typedef void(^SDWebImageQueryCompletedBlock)(UIImage *image, SDImageCacheType cacheType);

先从内存中取图片，内存中没有的时候再从磁盘中取，通过Block返回取到的图片和获取图片的方式，SDImageCacheType的定义如下：

typedef NS_ENUM(NSInteger, SDImageCacheType){    /**     * The image wasn't available the SDWebImage caches, but was downloaded from the web.     */    SDImageCacheTypeNone,    /**     * The image was obtained from the disk cache.     */    SDImageCacheTypeDisk,    /**     * The image was obtained from the memory cache.     */    SDImageCacheTypeMemory};

当然，也可能磁盘也没有缓存，此时doneBlock中的diskImage的值时nil，处理方式doneBlock将在SDWebImageManager讲到。

把图片存入缓存

- (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;            if (image && (recalculate || !data))            {#if TARGET_OS_IPHONE                // We need to determine if the image is a PNG or a JPEG                // PNGs are easier to detect because they have a unique signature (http://www.w3.org/TR/PNG-Structure.html)                // The first eight bytes of a PNG file always contain the following (decimal) values:                // 137 80 78 71 13 10 26 10                // If the imageData is nil (i.e. if trying to save a UIImage directly or the image was transformed on download)                // and the image has an alpha channel, we will consider it PNG to avoid losing the transparency                int alphaInfo = CGImageGetAlphaInfo(image.CGImage);                BOOL hasAlpha = !(alphaInfo == kCGImageAlphaNone ||                                  alphaInfo == kCGImageAlphaNoneSkipFirst ||                                  alphaInfo == kCGImageAlphaNoneSkipLast);                BOOL imageIsPng = hasAlpha;                // But if we have an image data, we will look at the preffix                if ([imageData length] >= [kPNGSignatureData length]){                    imageIsPng = ImageDataHaspNGPreffix(imageData);                }                if (imageIsPng){                    data = UIImagePNGRepresentation(image);                }                else{                    data = UIImageJPEGRepresentation(image, (CGFloat)1.0);                }#else                data = [NSBitmapImageRep representationOfImageRepsInArray:image.representations usingType: NSJPEGFileType properties:nil];#endif            }            if (data){                if (![_fileManager fileExistsAtPath:_diskCachePath]){                    [_fileManager createDirectoryAtPath:_diskCachePath withIntermediateDirectories:YES attributes:nil error:NULL];                }                // get cache Path for image key                NSString *cachePathForKey = [self defaultCachePathForKey:key];                // transform to NSUrl                NSURL *fileURL = [NSURL fileURLWithPath:cachePathForKey];                [_fileManager createFileAtPath:cachePathForKey contents:data attributes:nil];                // disable iCloud backup                if (self.shouldDisableiCloud){                    [fileURL setResourceValue:[NSNumber numberWithBool:YES] forKey:NSURLIsExcludedFromBackupKey error:nil];                }            }        });    }}

如果需要存入内存，则先存入内存，toDisk标识是否存入磁盘，为Yes的时候，即要存入磁盘，需要先对图片编码，再存入磁盘。

SDWebImageDownloader

SDWebImageDownloader是下载管理类，是一个单例类，图片的下载在一个NSOperationQueue队列中完成。

@property (strong, nonatomic) NSOperationQueue *downloadQueue;

默认情况下，队列最多并发数为6，可以通过修改maxConcurrentOperationCount来改变最多并发数。

- (id)init{    if ((self = [super init])){        ···        _downloadQueue.maxConcurrentOperationCount = 6;                ···    }    return self;}- (void)setMaxConcurrentDownloads:(NSInteger)maxConcurrentDownloads {    _downloadQueue.maxConcurrentOperationCount = maxConcurrentDownloads;}

下载图片的消息是：

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

该方法会创建一个SDWebImageDownloaderOperation操作队列来执行下载操作，传入的两个Block用于网络下载的回调，progressBlock为下载进度回调，completedBlock为下载完成回调，回调信息存储在URLCallbacks中，为保证只有一个线程操作URLCallbacks，SDWebImageDownloader把这些操作放入了一个barrierQueue队列中。

_barrierQueue = dispatch_queue_create("com.hackemist.SDWebImageDownloaderBarrierQueue", DISPATCH_QUEUE_CONCURRENT);- (void)addProgressCallback:(SDWebImageDownloaderProgressBlock)progressBlock andCompletedBlock:(SDWebImageDownloaderCompletedBlock)completedBlock forURL:(NSURL *)url createCallback:(SDWebImageNoParamsBlock)createCallback{    ···    dispatch_barrier_sync(self.barrierQueue, ^{        BOOL first = NO;        if (!self.URLCallbacks[url]){            self.URLCallbacks[url] = [NSMutableArray new];            first = YES;        }        // Handle single download of simultaneous download request for the same URL        NSMutableArray *callbacksForURL = self.URLCallbacks[url];        NSMutableDictionary *callbacks = [NSMutableDictionary new];        if (progressBlock) callbacks[kProgressCallbackKey] = [progressBlock copy];        if (completedBlock) callbacks[kCompletedCallbackKey] = [completedBlock copy];        [callbacksForURL addObject:callbacks];        self.URLCallbacks[url] = callbacksForURL;        if (first){            createCallback();        }    });}

SDWebImageDownloader还提供了两种下载任务调度方式（先进先出和后进先出）：

typedef NS_ENUM(NSInteger, SDWebImageDownloaderExecutionOrder){    /**     * Default value. All download operations will execute in queue style (first-in-first-out).     */    SDWebImageDownloaderFIFOExecutionOrder,    /**     * All download operations will execute in stack style (last-in-first-out).     */    SDWebImageDownloaderLIFOExecutionOrder};

通过修改executionOrder可改变下载方式：

@property (assign, nonatomic) SDWebImageDownloaderExecutionOrder executionOrder;- (id <SDWebImageOperation>)downloadImageWithURL:(NSURL *)url options:(SDWebImageDownloaderOptions)options progress:(SDWebImageDownloaderProgressBlock)progressBlock completed:(SDWebImageDownloaderCompletedBlock)completedBlock{        ···        [wself.downloadQueue addOperation:operation];        if (wself.executionOrder == SDWebImageDownloaderLIFOExecutionOrder)        {            // Emulate LIFO execution order by systematically adding new operations as last operation's dependency            [wself.lastAddedOperation addDependency:operation];            wself.lastAddedOperation = operation;        }    }];    ···}

SDWebImageDownloaderOperation

SDWebImageDownloaderOperation是下载操作队列，继承自NSOperation，并采用了SDWebImageOperation协议，该协议只有一个cancel方法。只暴露了一个方法：

- (id)initWithRequest:(NSURLRequest *)request              options:(SDWebImageDownloaderOptions)options             progress:(SDWebImageDownloaderProgressBlock)progressBlock            completed:(SDWebImageDownloaderCompletedBlock)completedBlock            cancelled:(SDWebImageNoParamsBlock)cancelBlock;

该方法的progressBlock与completedBlockBlock与SDWebImageDownloader下载管理类对应。

SDWebImageDownloaderOperation使用start和done来控制状态，而不是使用main。图片的下载使用NSURLConnection，在协议中接收数据并回调Block通知下载进度和下载完成。

SDWebImageManager

SDWebImageManager是一个单例管理类，负责协调图片缓存和图片下载，是对 SDImageCache和SDWebImageDownloader的封装。

@property (strong, nonatomic, readwrite) SDImageCache *imageCache;@property (strong, nonatomic, readwrite) SDWebImageDownloader *imageDownloader;

在一般的使用中，我们并不直接使用SDImageCache和SDWebImageDownloader，而是使用 SDWebImageManager。SDWebImageManager的核心方法是：

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

代码有点长，这里就不贴出来了，代码控制了图片的缓存和下载的整个流程，同样两个Block与前面的也是一一对应。

Categories（分类）

在Categories目录下实现了多个分类，实现方式都是一致的。使用最多的是UIImageView+WebCache，针对UIImageView扩展了一些方法。在使用的时候调用的方法是：

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

该方法依赖于SDWebImageManager，从SDWebImageManager管理类中获取到图片并刷新显示，至于图片是从缓存中得到的还是从网络上下载的对UIImageView是透明的。

其它的categories就不多说了，当然还可以创建自己的分类。

结语

本文是我读SDWebImage的源代码的一点理解，主要集中在图片的下载和缓存，不包括WebP、GIF和图片编码的讨论。涉及到得技术有：

NSCache。NSCache可在内存中临时缓存对象，类似于NSDictionary
NSOperationQueue和NSOperation。并发编程，更多请参考并发编程：API 及挑战。
NSMutableURLRequest和NSURLConnection。网络请求与下载。
GCD。如dispatch_main_sync_safe、dispatch_async、dispatch_barrier_sync，更多请参考并发编程：API 及挑战