YYCache(2)---YYDiskCache

1 前文铺垫

参考链接: YYCache(1)---YYMemoryCache

2 YYKVStorage

这部分的测试函数主要是: + (void)diskCacheWriteSmallDataBenchmark;
要学习的内容包括:YYKVStorage、YYDiskCache。(涉及到sqlite3的内容,我并不是掌握很多,有兴趣的可以自行深入了解)

YYKVStorage: 是一个基于sqlite和文件系统的键值存储类,一般情况下,我们不会直接使用这个类。
YYDiskCache: 是一个线程安全的基于sqlite和文件系统的键值存储类。

2.1 Write

它实际上有2种存储数据的策略,file system、sqlite,对应以下的枚举类型:

typedef NS_ENUM(NSUInteger, YYKVStorageType) {
    YYKVStorageTypeFile = 0,
    YYKVStorageTypeSQLite = 1,
    YYKVStorageTypeMixed = 2,
};

YYCache作者注:如果存储大量的小数据,比如电话号码,建议使用SQLite;如果存储大型文件,如图片,建议使用File;当然,我们也可以使用Mixed类型来配置每一个item的存储方式。

YYKVStorage对象初始化时,会在提供的目录下默认创建以下文件:

默认文件

主要存储数据方法如下:

- (BOOL)saveItemWithKey:(NSString *)key value:(NSData *)value filename:(NSString *)filename extendedData:(NSData *)extendedData {
    if (key.length == 0 || value.length == 0) return NO;
    if (_type == YYKVStorageTypeFile && filename.length == 0) {
        return NO;
    }
    
    if (filename.length) {
        if (![self _fileWriteWithName:filename data:value]) {
            return NO;
        }
        if (![self _dbSaveWithKey:key value:value fileName:filename extendedData:extendedData]) {
            [self _fileDeleteWithName:filename];
            return NO;
        }
        return YES;
    } else {
        if (_type != YYKVStorageTypeSQLite) {
            NSString *filename = [self _dbGetFilenameWithKey:key];
            if (filename) {
                [self _fileDeleteWithName:filename];
            }
        }
        return [self _dbSaveWithKey:key value:value fileName:nil extendedData:extendedData];
    }
}

我们看到有2个核心的方法:

- (BOOL)_fileWriteWithName:(NSString *)filename data:(NSData *)data;
- (BOOL)_dbSaveWithKey:(NSString *)key value:(NSData *)value fileName:(NSString *)fileName extendedData:(NSData *)extendedData;

前者(简称:方法1)是根据filename和data,将数据用系统自带的writeToFile
方法写入文件,会存储到data目录下;后者(简称:方法2)是将文件存储到数据库(即前文默认创建的manifest)。

2.2 Read

读取数据主要使用- (YYKVStorageItem *)getItemForKey:(NSString *)key;方法。

- (YYKVStorageItem *)getItemForKey:(NSString *)key {
    if (key.length == 0) return nil;
    YYKVStorageItem *item = [self _dbGetItemWithKey:key excludeInlineData:NO];
    if (item) {
        [self _dbUpdateAccessTimeWithKey:key];
        if (item.filename) {
            item.value = [self _fileReadWithName:item.filename];
            if (!item.value) {
                [self _dbDeleteItemWithKey:key];
                item = nil;
            }
        }
    }
    return item;
}

不难发现,我们找到了2个与Write相对应的方法。有兴趣可以深入去了解他们的内部实现:

- (BOOL)_fileDeleteWithName:(NSString *)filename;
- (YYKVStorageItem *)_dbGetItemWithKey:(NSString *)key excludeInlineData:(BOOL)excludeInlineData;

3 YYDiskCache

首先我们看一下初始化方法,默认的threshold是20KB,当存储的数据大于这个门槛时,会选择file system方式存储;否则选择sqlite方式。

- (instancetype)initWithPath:(NSString *)path;
- (instancetype)initWithPath:(NSString *)path inlineThreshold:(NSUInteger)threshold;

3.1 初始化方法中,第一部分是通过_YYDiskCacheGetGlobal方法获取一个YYDiskCache实例,他内部是如何实现的?

static void _YYDiskCacheInitGlobal() {
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        _globalInstancesLock = dispatch_semaphore_create(1);
        _globalInstances = [[NSMapTable alloc] initWithKeyOptions:NSPointerFunctionsStrongMemory valueOptions:NSPointerFunctionsWeakMemory capacity:0];
    });
}

static YYDiskCache *_YYDiskCacheGetGlobal(NSString *path) {
    if (path.length == 0) return nil;
    _YYDiskCacheInitGlobal();
    dispatch_semaphore_wait(_globalInstancesLock, DISPATCH_TIME_FOREVER);
    id cache = [_globalInstances objectForKey:path];
    dispatch_semaphore_signal(_globalInstancesLock);
    return cache;
}

解析:
①初始化创建了NSMapTable,key为文件的路径,value为指向数据的指针
②用信号量控制线程并发数量为1,一次只获取一个cache,并返回

3.2 初始化获取cache失败,则生成一个YYKVStorage实例作为cache。

可以看出,YYDiskCache是对YYKVStorage的封装。生成cache成功后,会把他存放到NSMaper的实例中。

3.3 缓存方法

我们看一下缓存方法是如何实现的。set和get方法思路一样,掌握其中一个即可。

- (void)setObject:(id)object forKey:(NSString *)key {
    if (!key) return;
    if (!object) {
        [self removeObjectForKey:key];
        return;
    }
    
    NSData *extendedData = [YYDiskCache getExtendedDataFromObject:object];
    NSData *value = nil;
    if (_customArchiveBlock) {
        value = _customArchiveBlock(object);
    } else {
        @try {
            value = [NSKeyedArchiver archivedDataWithRootObject:object];
        }
        @catch (NSException *exception) {
            // nothing to do...
        }
    }
    if (!value) return;
    NSString *filename = nil;
    if (_kv.type != YYKVStorageTypeSQLite) {
        if (value.length > _inlineThreshold) {
            filename = [self _filenameForKey:key];
        }
    }
    
    Lock();
    [_kv saveItemWithKey:key value:value filename:filename extendedData:extendedData];
    Unlock();
}

解析:
①如果object为nil,删除这个key-value
②如果需要自定义的解档方式,可以通过customArchiveBlock实现,默认是系统提供的方法
③选择文件存储策略
④调用YYKVStorage的方法存储(可见上文)

总结

摘抄YYCahce作者的一段话:

我的 YYDiskCache 也是采用的 SQLite 配合文件的存储方式,在 iPhone 6 64G 上的性能基准测试结果见下图。在存取小数据 (NSNumber) 时,YYDiskCache 的性能远远高出基于文件存储的库;而较大数据的存取性能则比较接近了。但得益于 SQLite 存储的元数据,YYDiskCache 实现了 LRU 淘汰算法、更快的数据统计,更多的容量控制选项。

你可能感兴趣的:(YYCache(2)---YYDiskCache)