一直想研究研究YYKit的源码，最近刚好抽出了些时间开始看，希望这是一个系列的文章。说句题外话YYKit真的一个庞大的工具库，涵盖了我们日常绝大多数需要的工具，不仅仅是常用的YYModel、YYCache、YYImage、YYText还提供了NSString、NSObject、NSArray、NSNumber等的Category，提供了使用平率很高的工具方法，甚至提供了KVO的block形式的封装，接入一个YYKit很多其他的第三方库都不再需要接入了。
好了直入主题，下图是YYCache的架构图：
下面是YYCache的使用方法:
YYCache *cache = [YYCache cacheWithName:@"courseCache"];
[cache setObject:obj1 forKey:key1];
[cache containsObjectForKey:key1];
[cache objectForKey:key1];
...
默认情况下YYCache会在内存和文件/DB中分别缓存一份数据，取数据时先向内存取，若没有名中则向文件/DB取，同时更新内存中的缓存，这一点和SDWebImage中对图片的缓存机制是一致的。YYCache内部实现了LRU算法，然后通过总数量、总大小、存活时间这些指标配合LRU实现了淘汰缓存文件的机制。本文主要是介绍YYCache内部的LRU实现机制。
YYMemoryCache
YYMemoryCache内部用一个双向链表实现了LRU算法。
链表节点_YYLinkedMapNode：
/**
A node in linked map.
*/
@interface _YYLinkedMapNode : NSObject {
@package
__unsafe_unretained _YYLinkedMapNode *_prev; // 指向前一个节点 retained by dic
__unsafe_unretained _YYLinkedMapNode *_next; // 指向后一个节点 retained by dic
id _key;
id _value;
NSUInteger _cost;
NSTimeInterval _time;
}
@end
@implementation _YYLinkedMapNode
@end
双向链表结构_YYLinkedMap：
/**
A linked map used by YYMemoryCache.
It's not thread-safe and does not validate the parameters.
*/
@interface _YYLinkedMap : NSObject {
@package
CFMutableDictionaryRef _dic; // 实际持有节点的字典
NSUInteger _totalCost;
NSUInteger _totalCount;
_YYLinkedMapNode *_head; // 尾节点
_YYLinkedMapNode *_tail; // 头结点
BOOL _releaseOnMainThread;
BOOL _releaseAsynchronously;
}
下面是一些双向链表的操作，就是一个典型的双向链表的操作，相信读者都能看明白，不做过多注释 :)
头部插入操作：
- (void)insertNodeAtHead:(_YYLinkedMapNode *)node {
CFDictionarySetValue(_dic, (__bridge const void *)(node->_key), (__bridge const void *)(node));
_totalCost += node->_cost;// cost增加
_totalCount++; //数量增加
if (_head) {
node->_next = _head;
_head->_prev = node;
_head = node;
} else {
_head = _tail = node;
}
}
删除操作：
- (void)removeNode:(_YYLinkedMapNode *)node {
CFDictionaryRemoveValue(_dic, (__bridge const void *)(node->_key));
_totalCost -= node->_cost;
_totalCount--;
if (node->_next) node->_next->_prev = node->_prev;
if (node->_prev) node->_prev->_next = node->_next;
if (_head == node) _head = node->_next;
if (_tail == node) _tail = node->_prev;
}
将一个节点移至头结点：
- (void)bringNodeToHead:(_YYLinkedMapNode *)node {
if (_head == node) return;
if (_tail == node) {
_tail = node->_prev;
_tail->_next = nil;
} else {
node->_next->_prev = node->_prev;
node->_prev->_next = node->_next;
}
node->_next = _head;
node->_prev = nil;
_head->_prev = node;
_head = node;
}
同时YYMemory内部有一个计时器，默认每隔5秒钟检查一次缓存的状态（主要是总数量、总大小、存活时间），若超出则通过双向链表删除尾节点。
- (void)_trimRecursively {
__weak typeof(self) _self = self;
dispatch_after(dispatch_time(DISPATCH_TIME_NOW, (int64_t)(_autoTrimInterval * NSEC_PER_SEC)), dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_LOW, 0), ^{
__strong typeof(_self) self = _self;
if (!self) return;
[self _trimInBackground];
[self _trimRecursively];
});
}
- (void)_trimInBackground {
dispatch_async(_queue, ^{
[self _trimToCost:self->_costLimit];
[self _trimToCount:self->_countLimit];
[self _trimToAge:self->_ageLimit];
});
}
至于这里为什么没有用NSTimer，我也没弄明白（摊手。还请知道的读者赐教。
update: 2017.10.26
NSTimer必须放在runloop中才能生效，使用dispatch_after的方式可以避开这个限制。
YYDiskCache
YYDiskCache用文件和SQLite作为存储介质。至于这两者的规则，YYDiskCache.h有这样一个参数:
@property (readonly) NSUInteger inlineThreshold;
简而言之超过这个阈值会使用文件存储，低于这个阈值会使用SQLite存储，这个值默认是20KB。
但是注意，这里的文件存储和SQLite存储并不是指的数据完全用文件存储或者SQLite存储；具体的规则还是代码比较好说明：
YYKVStorage.h
typedef NS_ENUM(NSUInteger, YYKVStorageType) {
YYKVStorageTypeFile = 0,
YYKVStorageTypeSQLite = 1,
YYKVStorageTypeMixed = 2,
};
YYDiskCache.m
- (instancetype)initWithPath:(NSString *)path inlineThreshold:(NSUInteger)threshold {
...
if (threshold == 0) {
type = YYKVStorageTypeFile;
} else if (threshold == NSUIntegerMax) {
type = YYKVStorageTypeSQLite;
} else {
type = YYKVStorageTypeMixed;
}
...
}
- (void)setObject:(id)object forKey:(NSString *)key {
...
NSString *filename = nil;
if (_kv.type != YYKVStorageTypeSQLite) {
if (value.length > _inlineThreshold) {
filename = [self _filenameForKey:key];//计算key的MD5值
}
}
Lock();
[_kv saveItemWithKey:key value:value filename:filename extendedData:extendedData];
Unlock();
}
YYKVStorage.m
- (BOOL)saveItemWithKey:(NSString *)key value:(NSData *)value filename:(NSString *)filename extendedData:(NSData *)extendedData {
...
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];
}
}
oh no，我真的不想贴这么多源码，也难为ibreme设计出这么一套规则，反正就一个目的，在SQLite是一定能找到缓存数据对应的key->filename的。至于真正的数据data(value)只有在type是YYKVStorageTypeFile才会在文件中存储一份备份。至于为什么这么做？因为SQLite能用时间戳取排序取出数据来实现LRU淘汰算法。所以所有的缓存数据必须在SQLite中找到索引。
一些其他的技巧
宏
作者ibreme在源码中使用了很多宏，比如NS_DESIGNATED_INITIALIZER UNAVAILABLE_ATTRIBUTE等等，UNAVAILABLE_ATTRIBUTE这个宏在封装组件的时候尤其有用，当某各类的初始化强依赖于几个必要的属性的时候，可以禁用init方法和new方法 or whatever。下面是这个宏的使用姿势：
YYCache.h
- (nullable instancetype)initWithName:(NSString *)name;
- (instancetype)init UNAVAILABLE_ATTRIBUTE;
+ (instancetype)new UNAVAILABLE_ATTRIBUTE;
效果如下:
NSMapTable
日常开发中使用的NSDictionary、NSArray、NSSet对key和value都是强引用，但是在遇到需要对key或者value的指针是个弱引用的时候这个类就派上用场了：
[[NSMapTable alloc] initWithKeyOptions:NSPointerFunctionsStrongMemory valueOptions:NSPointerFunctionsWeakMemory capacity:0];
YYDiskCache中由于想通过一个哈希表记录path -> cache(YYDiskCache) 但是却不想对cache形成强引用而使用了这个类。