前言
使用SDWebImage为我们带来的另一个方便就是它提供图片的缓存功能，自动将下载好的图片缓存到本地，防止重复下载。本篇文章主要学习的就是SDWebImage的缓存功能是怎么实现的。
Cache
提供缓存相关的文件有2个，分别是SDImageCacheConfig,SDImageCache。
- SDImageCacheConfig：提供缓存操作的配置属性
//是否解压下载的图片，默认是YES,但是会消耗掉很多内存，如果遇到内存不足的crash时，将值设为NO
@property (assign, nonatomic) BOOL shouldDecompressImages;
//允许自动上传的iCloud
@property (assign, nonatomic) BOOL shouldDisableiCloud;
//允许缓存到内存
@property (assign, nonatomic) BOOL shouldCacheImagesInMemory;
//读取磁盘缓存的策略
@property (assign, nonatomic) NSDataReadingOptions diskCacheReadingOptions;
//最大缓存时间
@property (assign, nonatomic) NSInteger maxCacheAge;
//最大缓存大小
@property (assign, nonatomic) NSUInteger maxCacheSize;
- SDImageCache：实现主要的缓存逻辑，缓存分为内存缓存
memCache和磁盘缓存fileManager两部分，并提供存储，查询，读取，删除相关操作。
内存缓存
内存缓存是使用NSCache实现的，NSCache使用上类似字典，可以用key-Value的方式存取数据。但是NSCache底层实现和NSDictionary不同(NSCache是线程安全的)。
@interface AutoPurgeCache : NSCache
@end
@implementation AutoPurgeCache
- (nonnull instancetype)init {
self = [super init];
if (self) {
#if SD_UIKIT
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(removeAllObjects) name:UIApplicationDidReceiveMemoryWarningNotification object:nil];
#endif
}
return self;
}
可以看到，里面实现了一个NSCache的子类。添加了一个观察者，当收到内存警告的时候，移除所有的缓存。
磁盘缓存
磁盘缓存使用NSFileManager实现，通过一个串行队列进行异步任务管理。并要求所有写操作都必须放在这个队列中执行
_ioQueue = dispatch_queue_create("com.hackemist.SDWebImageCache", DISPATCH_QUEUE_SERIAL);
通过标签检测队列是不是ioQueue
- (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");
}
}
核心缓存方法是- (void)storeImage:(nullable UIImage *)image imageData:(nullable NSData *)imageData forKey:(nullable NSString *)key toDisk:(BOOL)toDisk completion:(nullable SDWebImageNoParamsBlock)completionBlock通过这个方法将图片进行内存缓存或磁盘缓存。
//检测正确性
if (!image || !key) {
if (completionBlock) {
completionBlock();
}
return;
}
//如果需要进行内存缓存，则将图片直接缓存进NSCache中
if (self.config.shouldCacheImagesInMemory) {
NSUInteger cost = SDCacheCostForImage(image);
[self.memCache setObject:image forKey:key cost:cost];
}
//如果需要磁盘缓存
if (toDisk) {
//在串行队列中异步执行缓存操作
dispatch_async(self.ioQueue, ^{
//大量对象生成释放，使用autoreleasepool控制内存
@autoreleasepool {
NSData *data = imageData;
if (!data && image) {
// 图片二进制数据不存在，重新生成，首先获取图片的格式，然后使用`UIImagePNGRepresentation`或者`UIImageJPEGRepresentation`生成图片，之后会查看NSData的这些分类方法
data = [[SDWebImageCodersManager sharedInstance] encodedDataWithImage:image format:SDImageFormatPNG];
}
// 磁盘缓存核心方法
[self storeImageDataToDisk:data forKey:key];
}
if (completionBlock) {
// 主线程回调
dispatch_async(dispatch_get_main_queue(), ^{
completionBlock();
});
}
});
} else {
if (completionBlock) {
completionBlock();
}
}
通过- (void)storeImageDataToDisk:(nullable NSData *)imageData forKey:(nullable NSString *)key方法将数据写入进磁盘
//正确性校验
if (!imageData || !key) {
return;
}
//验证当前队列是否正确
[self checkIfQueueIsIOQueue];
//检测磁盘中是否已存在该文件，如果不存在则创建这个目录
if (![_fileManager fileExistsAtPath:_diskCachePath]) {
[_fileManager createDirectoryAtPath:_diskCachePath withIntermediateDirectories:YES attributes:nil error:NULL];
}
//创建文件名，并转化为URL格式
NSString *cachePathForKey = [self defaultCachePathForKey:key];
NSURL *fileURL = [NSURL fileURLWithPath:cachePathForKey];
//存储图片到该路径
[_fileManager createFileAtPath:cachePathForKey contents:imageData attributes:nil];
// 如果需要，上传到iCloud
if (self.config.shouldDisableiCloud) {
[fileURL setResourceValue:@YES forKey:NSURLIsExcludedFromBackupKey error:nil];
}
缓存查询
核心方法- (nullable NSOperation *)queryCacheOperationForKey:(nullable NSString *)key done:(nullable SDCacheQueryCompletedBlock)doneBlock，当查询图片时，该操作会在内存中放置一份缓存，如果确定需要缓存到磁盘，则将磁盘缓存操作作为一个task放到串行队列中处理。
//正确性校验
if (!key) {
if (doneBlock) {
doneBlock(nil, nil, SDImageCacheTypeNone);
}
return nil;
}
// 检测内存中是否已缓存该图片
UIImage *image = [self imageFromMemoryCacheForKey:key];
if (image) {
NSData *diskData = nil;
// isGIF单独处理
if (image.images) {
diskData = [self diskImageDataBySearchingAllPathsForKey:key];
}
// 查询完成，是内存缓存，查询操作不需要在io队列中执行
if (doneBlock) {
doneBlock(image, diskData, SDImageCacheTypeMemory);
}
return nil;
}
//内存上没有，创建一个任务
NSOperation *operation = [NSOperation new];
//在io队列执行
dispatch_async(self.ioQueue, ^{
if (operation.isCancelled) {
// 检测任务状态
return;
}
@autoreleasepool {
//及时释放内存
NSData *diskData = [self diskImageDataBySearchingAllPathsForKey:key];
UIImage *diskImage = [self diskImageForKey:key];
//如果需要缓存到内存，则把读取出来的数据拷贝一份到内存中
if (diskImage && self.config.shouldCacheImagesInMemory) {
NSUInteger cost = SDCacheCostForImage(diskImage);
[self.memCache setObject:diskImage forKey:key cost:cost];
}
if (doneBlock) {
dispatch_async(dispatch_get_main_queue(), ^{
//回调
doneBlock(diskImage, diskData, SDImageCacheTypeDisk);
});
}
}
});
//返回该任务给调度层
return operation;
移除缓存
可以通过removeImageForKey方法移除指定的缓存。这个操作也是异步的，需要放在ioQueue中执行。
- (void)removeImageForKey:(nullable NSString *)key fromDisk:(BOOL)fromDisk withCompletion:(nullable SDWebImageNoParamsBlock)completion {
if (key == nil) {
return;
}
if (self.config.shouldCacheImagesInMemory) {
[self.memCache removeObjectForKey:key];
}
if (fromDisk) {
dispatch_async(self.ioQueue, ^{
[_fileManager removeItemAtPath:[self defaultCachePathForKey:key] error:nil];
if (completion) {
dispatch_async(dispatch_get_main_queue(), ^{
completion();
});
}
});
} else if (completion){
completion();
}
}
除此之外，SDWebImage还支持批量移除，可以根据配置的缓存时间，缓存大小等参数管理缓存数据的声明周期。
使用deleteOldFilesWithCompletionBlock删除时间太久的数据
使用clearMemory清除NSCache中的数据
使用clearDiskOnCompletion清除所有磁盘上的数据，这个函数会删除创建的目录结构
小结
SDWebImage缓存主要分为内存缓存和磁盘缓存两部分，内存缓存使用NSCache进行缓存，在内存占用过多时可以释放多余内存。磁盘缓存使用NSFileManager实现，使用了一个串行队列来保证操作的正确性，异步执行读写操作保证不影响主线程。提供配置项管理缓存策略让内存缓存和磁盘缓存协调工作。防止了冗余的缓存操作。
相关文章
SDWebImage源码阅读笔记
SDWebImage源码阅读
SDWebImage 源码阅读笔记（二）
SDWebImage源码阅读笔记
