YYCache源碼分析(二)
原文鏈接:http://www.reibang.com/p/492c3c3a0485
本文分析YYMemoryCache實(shí)現(xiàn)原理:
YYMemoryCache是內(nèi)存緩存,所以存取速度非衬墓ぃ快捅儒,主要用到兩種數(shù)據(jù)結(jié)構(gòu)的LRU(Least Recently Used 近期最少使用算法)淘汰算法
1.LRU
Cache的容量是有限的,當(dāng)Cache的空間都被占滿后缤言,如果再次發(fā)生緩存失效,就必須選擇一個(gè)緩存塊來替換掉.LRU法是依據(jù)各塊使用的情況, 總是選擇那個(gè)最長(zhǎng)時(shí)間未被使用的塊替換换团。這種方法比較好地反映了程序局部性規(guī)律
2.LRU主要采用兩種數(shù)據(jù)結(jié)構(gòu)實(shí)現(xiàn)
- 雙向鏈表(Doubly Linked List)
- 哈希表(Dictionary)
3.對(duì)一個(gè)Cache的操作無非三種:插入、替換校焦、查找
- 插入:當(dāng)Cache未滿時(shí)赊抖,新的數(shù)據(jù)項(xiàng)只需插到雙鏈表頭部即可
- 替換:當(dāng)Cache已滿時(shí),將新的數(shù)據(jù)項(xiàng)插到雙鏈表頭部寨典,并刪除雙鏈表的尾結(jié)點(diǎn)即可
- 查找:每次數(shù)據(jù)項(xiàng)被查詢到時(shí)氛雪,都將此數(shù)據(jù)項(xiàng)移動(dòng)到鏈表頭部
4.分析圖(分析源碼時(shí)可以對(duì)照該圖)
5.YYMemoryCache.m里的兩個(gè)分類
鏈表節(jié)點(diǎn)_YYLinkedMapNode:
@interface _YYLinkedMapNode : NSObject {
@package
// 指向前一個(gè)節(jié)點(diǎn)
__unsafe_unretained _YYLinkedMapNode *_prev; // retained by dic
// 指向后一個(gè)節(jié)點(diǎn)
__unsafe_unretained _YYLinkedMapNode *_next; // retained by dic
// 緩存key
id _key;
// 緩存對(duì)象
id _value;
// 當(dāng)前緩存內(nèi)存開銷
NSUInteger _cost;
// 緩存時(shí)間
NSTimeInterval _time;
}
@end
鏈表_YYLinkedMap
@interface _YYLinkedMap : NSObject {
@package
// 用字典保存所有節(jié)點(diǎn)_YYLinkedMapNode (為什么不用oc字典?因?yàn)橛肅FMutableDictionaryRef效率高,畢竟基于c)
CFMutableDictionaryRef _dic;
// 總緩存開銷
NSUInteger _totalCost;
// 總緩存數(shù)量
NSUInteger _totalCount;
// 鏈表頭節(jié)點(diǎn)
_YYLinkedMapNode *_head;
// 鏈表尾節(jié)點(diǎn)
_YYLinkedMapNode *_tail;
// 是否在主線程上耸成,異步釋放 _YYLinkedMapNode對(duì)象
BOOL _releaseOnMainThread;
// 是否異步釋放 _YYLinkedMapNode對(duì)象
BOOL _releaseAsynchronously;
}
// 添加節(jié)點(diǎn)到鏈表頭節(jié)點(diǎn)
- (void)insertNodeAtHead:(_YYLinkedMapNode *)node;
// 移動(dòng)當(dāng)前節(jié)點(diǎn)到鏈表頭節(jié)點(diǎn)
- (void)bringNodeToHead:(_YYLinkedMapNode *)node;
// 移除鏈表節(jié)點(diǎn)
- (void)removeNode:(_YYLinkedMapNode *)node;
// 移除鏈表尾節(jié)點(diǎn)(如果存在)
- (_YYLinkedMapNode *)removeTailNode;
// 移除所有緩存
- (void)removeAll;
@end
方法插入报亩、替換、查找方法實(shí)現(xiàn):
// 添加節(jié)點(diǎn)到鏈表頭節(jié)點(diǎn)
- (void)insertNodeAtHead:(_YYLinkedMapNode *)node {
// 字典保存鏈表節(jié)點(diǎn)node
CFDictionarySetValue(_dic, (__bridge const void *)(node->_key), (__bridge const void *)(node));
// 疊加該緩存開銷到總內(nèi)存開銷
_totalCost += node->_cost;
// 總緩存數(shù)+1
_totalCount++;
if (_head) {
// 存在鏈表頭井氢,取代當(dāng)前表頭
node->_next = _head;
_head->_prev = node;
// 重新賦值鏈表表頭臨時(shí)變量_head
_head = node;
} else {
// 不存在鏈表頭
_head = _tail = node;
}
}
存在表頭情況圖形分析(其他情況不用圖分析,自己想象吧弦追,呵呵)
// 移動(dòng)當(dāng)前節(jié)點(diǎn)到鏈表頭節(jié)點(diǎn)
- (void)bringNodeToHead:(_YYLinkedMapNode *)node {
// 當(dāng)前節(jié)點(diǎn)已是鏈表頭節(jié)點(diǎn)
if (_head == node) return;
if (_tail == node) {
//**如果node是鏈表尾節(jié)點(diǎn)**
// 把node指向的上一個(gè)節(jié)點(diǎn)賦值給鏈表尾節(jié)點(diǎn)
_tail = node->_prev;
// 把鏈表尾節(jié)點(diǎn)指向的下一個(gè)節(jié)點(diǎn)賦值nil
_tail->_next = nil;
} else {
//**如果node是非鏈表尾節(jié)點(diǎn)和鏈表頭節(jié)點(diǎn)**
// 把node指向的上一個(gè)節(jié)點(diǎn)賦值給node指向的下一個(gè)節(jié)點(diǎn)node指向的上一個(gè)節(jié)點(diǎn)
node->_next->_prev = node->_prev;
// 把node指向的下一個(gè)節(jié)點(diǎn)賦值給node指向的上一個(gè)節(jié)點(diǎn)node指向的下一個(gè)節(jié)點(diǎn)
node->_prev->_next = node->_next;
}
// 把鏈表頭節(jié)點(diǎn)賦值給node指向的下一個(gè)節(jié)點(diǎn)
node->_next = _head;
// 把node指向的上一個(gè)節(jié)點(diǎn)賦值nil
node->_prev = nil;
// 把節(jié)點(diǎn)賦值給鏈表頭節(jié)點(diǎn)的指向的上一個(gè)節(jié)點(diǎn)
_head->_prev = node;
_head = node;
}
如果node是非鏈表尾節(jié)點(diǎn)和鏈表頭節(jié)點(diǎn)情況圖形分析(其他情況不用圖分析,自己想象吧,呵呵)
// 移除節(jié)點(diǎn)
- (void)removeNode:(_YYLinkedMapNode *)node {
// 從字典中移除node
CFDictionaryRemoveValue(_dic, (__bridge const void *)(node->_key));
// 減掉總內(nèi)存消耗
_totalCost -= node->_cost;
// // 總緩存數(shù)-1
_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;
}
// 移除尾節(jié)點(diǎn)(如果存在)
- (_YYLinkedMapNode *)removeTailNode {
if (!_tail) return nil;
// 拷貝一份要?jiǎng)h除的尾節(jié)點(diǎn)指針
_YYLinkedMapNode *tail = _tail;
// 移除鏈表尾節(jié)點(diǎn)
CFDictionaryRemoveValue(_dic, (__bridge const void *)(_tail->_key));
// 減掉總內(nèi)存消耗
_totalCost -= _tail->_cost;
// 總緩存數(shù)-1
_totalCount--;
if (_head == _tail) {
// 清除節(jié)點(diǎn)花竞,鏈表上已無節(jié)點(diǎn)了
_head = _tail = nil;
} else {
// 設(shè)倒數(shù)第二個(gè)節(jié)點(diǎn)為鏈表尾節(jié)點(diǎn)
_tail = _tail->_prev;
_tail->_next = nil;
}
// 返回完tail后_tail將會(huì)釋放
return tail;
}
// 移除所有緩存
- (void)removeAll {
// 清空內(nèi)存開銷與緩存數(shù)量
_totalCost = 0;
_totalCount = 0;
// 清空頭尾節(jié)點(diǎn)
_head = nil;
_tail = nil;
if (CFDictionaryGetCount(_dic) > 0) {
// 拷貝一份字典
CFMutableDictionaryRef holder = _dic;
// 重新分配新的空間
_dic = CFDictionaryCreateMutable(CFAllocatorGetDefault(), 0, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
if (_releaseAsynchronously) {
// 異步釋放緩存
dispatch_queue_t queue = _releaseOnMainThread ? dispatch_get_main_queue() : YYMemoryCacheGetReleaseQueue();
dispatch_async(queue, ^{
CFRelease(holder); // hold and release in specified queue
});
} else if (_releaseOnMainThread && !pthread_main_np()) {
// 主線程上釋放緩存
dispatch_async(dispatch_get_main_queue(), ^{
CFRelease(holder); // hold and release in specified queue
});
} else {
// 同步釋放緩存
CFRelease(holder);
}
}
}
YYMemoryCache.m實(shí)現(xiàn)分析(如果上面弄清楚劲件,接下來就簡(jiǎn)單多了),增刪改都是調(diào)用上面的方法左胞,下面分析查找與添加緩存方法實(shí)現(xiàn)
// 查找緩存
- (id)objectForKey:(id)key {
if (!key) return nil;
// 加鎖寇仓,防止資源競(jìng)爭(zhēng)
// OSSpinLock 自旋鎖,性能最高的鎖烤宙。原理很簡(jiǎn)單遍烦,就是一直 do while 忙等。它的缺點(diǎn)是當(dāng)?shù)却龝r(shí)會(huì)消耗大量 CPU 資源躺枕,所以它不適用于較長(zhǎng)時(shí)間的任務(wù)服猪。對(duì)于內(nèi)存緩存的存取來說,它非常合適拐云。
pthread_mutex_lock(&_lock);
// _lru為鏈表_YYLinkedMap罢猪,全部節(jié)點(diǎn)存在_lru->_dic中
// 獲取節(jié)點(diǎn)
_YYLinkedMapNode *node = CFDictionaryGetValue(_lru->_dic, (__bridge const void *)(key));
if (node) {
//** 有對(duì)應(yīng)緩存 **
// 重新更新緩存時(shí)間
node->_time = CACurrentMediaTime();
// 把當(dāng)前node移到鏈表表頭(為什么移到表頭?根據(jù)LRU淘汰算法:Cache的容量是有限的叉瘩,當(dāng)Cache的空間都被占滿后膳帕,如果再次發(fā)生緩存失效,就必須選擇一個(gè)緩存塊來替換掉.LRU法是依據(jù)各塊使用的情況薇缅, 總是選擇那個(gè)最長(zhǎng)時(shí)間未被使用的塊替換危彩。這種方法比較好地反映了程序局部性規(guī)律)
[_lru bringNodeToHead:node];
}
// 解鎖
pthread_mutex_unlock(&_lock);
// 有緩存則返回緩存值
return node ? node->_value : nil;
}
// 添加緩存
- (void)setObject:(id)object forKey:(id)key withCost:(NSUInteger)cost {
if (!key) return;
if (!object) {
// ** 緩存對(duì)象為空,移除緩存 **
[self removeObjectForKey:key];
return;
}
// 加鎖
pthread_mutex_lock(&_lock);
// 查找緩存
_YYLinkedMapNode *node = CFDictionaryGetValue(_lru->_dic, (__bridge const void *)(key));
// 當(dāng)前時(shí)間
NSTimeInterval now = CACurrentMediaTime();
if (node) {
//** 之前有緩存泳桦,更新舊緩存 **
// 更新值
_lru->_totalCost -= node->_cost;
_lru->_totalCost += cost;
node->_cost = cost;
node->_time = now;
node->_value = object;
// 移動(dòng)節(jié)點(diǎn)到鏈表表頭
[_lru bringNodeToHead:node];
} else {
//** 之前未有緩存汤徽,添加新緩存 **
// 新建節(jié)點(diǎn)
node = [_YYLinkedMapNode new];
node->_cost = cost;
node->_time = now;
node->_key = key;
node->_value = object;
// 添加節(jié)點(diǎn)到表頭
[_lru insertNodeAtHead:node];
}
if (_lru->_totalCost > _costLimit) {
// ** 總緩存開銷大于設(shè)定的開銷 **
// 異步清理最久未使用的緩存
dispatch_async(_queue, ^{
[self trimToCost:_costLimit];
});
}
if (_lru->_totalCount > _countLimit) {
// ** 總緩存數(shù)量大于設(shè)定的數(shù)量 **
// 移除鏈表尾節(jié)點(diǎn)(最久未訪問的緩存)
_YYLinkedMapNode *node = [_lru removeTailNode];
if (_lru->_releaseAsynchronously) {
dispatch_queue_t queue = _lru->_releaseOnMainThread ? dispatch_get_main_queue() : YYMemoryCacheGetReleaseQueue();
dispatch_async(queue, ^{
[node class]; // and release in queue
});
} else if (_lru->_releaseOnMainThread && !pthread_main_np()) {
dispatch_async(dispatch_get_main_queue(), ^{
[node class]; //hold and release in queue
});
}
}
pthread_mutex_unlock(&_lock);
}
4.YYMemoryCache.m tips
// 用字典保存所有節(jié)點(diǎn)_YYLinkedMapNode (為什么不用oc字典?因?yàn)橛肅FMutableDictionaryRef效率高,畢竟基于c)
CFMutableDictionaryRef _dic;
_dic = CFDictionaryCreateMutable(CFAllocatorGetDefault(), 0, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
CFMutableDictionaryRef 用法mark灸撰。
http://everettjf.github.io/2016/03/17/yycache-learn
YYMemoryCache 是內(nèi)存緩存谒府。
Key是retained拼坎,而不是copied。
使用了LRU(最近最少使用)算法完疫。
if __has_include("YYDispatchQueuePool.h")
可以這么判斷是否包含了某個(gè)頭文件泰鸡。
@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
雙向鏈表的節(jié)點(diǎn)。 cost以及time(最后使用時(shí)間)趋惨。 _prev 和 _next 是__unsafe_unretained 修飾鸟顺,被外層的 CFMutableDictionaryRef retained惦蚊。
@package 修飾符器虾,在framework內(nèi)部可訪問,framework外部不可訪問蹦锋。
@interface _YYLinkedMap : NSObject {
@package
CFMutableDictionaryRef _dic; // do not set object directly
NSUInteger _totalCost;
NSUInteger _totalCount;
_YYLinkedMapNode *_head; // MRU, do not change it directly
_YYLinkedMapNode *_tail; // LRU, do not change it directly
BOOL _releaseOnMainThread;
BOOL _releaseAsynchronously;
}
雙向鏈表 定義兆沙。頭、尾莉掂。dic用于存儲(chǔ)元素葛圃,同時(shí)retain元素。
- (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];
});
}
簡(jiǎn)單的定時(shí)器憎妙。 dispatch_after實(shí)現(xiàn)库正,因?yàn)樗f歸調(diào)用,所以它不是一次性厘唾,循環(huán)的褥符;
- (void)_trimToCost:(NSUInteger)costLimit {
BOOL finish = NO;
pthread_mutex_lock(&_lock);
if (costLimit == 0) {
[_lru removeAll];
finish = YES;
} else if (_lru->_totalCost <= costLimit) {
finish = YES;
}
pthread_mutex_unlock(&_lock);
if (finish) return;
NSMutableArray *holder = [NSMutableArray new];
while (!finish) {
if (pthread_mutex_trylock(&_lock) == 0) {
if (_lru->_totalCost > costLimit) {
_YYLinkedMapNode *node = [_lru removeTailNode];
if (node) [holder addObject:node];
} else {
finish = YES;
}
pthread_mutex_unlock(&_lock);
} else {
usleep(10 * 1000); //10 ms
}
}
if (holder.count) {
dispatch_queue_t queue = _lru->_releaseOnMainThread ? dispatch_get_main_queue() : YYMemoryCacheGetReleaseQueue();
dispatch_async(queue, ^{
[holder count]; // release in queue
});
}
}
這里老版本使用了OSSpinLock,現(xiàn)在已經(jīng)更換為pthread_mutex_lock抚垃,原因見作者的文章喷楣, http://blog.ibireme.com/2016/01/16/spinlock_is_unsafe_in_ios/
這里trylock,無法獲得鎖時(shí)鹤树,usleep铣焊。
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(_appDidReceiveMemoryWarningNotification) name:UIApplicationDidReceiveMemoryWarningNotification object:nil];
[[NSNotificationCenter defaultCenter] addObserver:self selector:@selector(_appDidEnterBackgroundNotification) name:UIApplicationDidEnterBackgroundNotification object:nil];
監(jiān)聽進(jìn)入后臺(tái)或者內(nèi)存警告
- (id)objectForKey:(id)key {
if (!key) return nil;
pthread_mutex_lock(&_lock);
_YYLinkedMapNode *node = CFDictionaryGetValue(_lru->_dic, (__bridge const void *)(key));
if (node) {
node->_time = CACurrentMediaTime();
[_lru bringNodeToHead:node];
}
pthread_mutex_unlock(&_lock);
return node ? node->_value : nil;
}
注意鎖。并設(shè)置訪問元素的最新訪問時(shí)間罕伯。并把此元素放到雙向鏈表的頭部曲伊。這里時(shí)間復(fù)雜度都是常數(shù)。
學(xué)到了獲取時(shí)間的一個(gè)函數(shù) CACurrentMediaTime()追他。
- (void)setObject:(id)object forKey:(id)key withCost:(NSUInteger)cost {
if (!key) return;
if (!object) {
[self removeObjectForKey:key];
return;
}
pthread_mutex_lock(&_lock);
_YYLinkedMapNode *node = CFDictionaryGetValue(_lru->_dic, (__bridge const void *)(key));
NSTimeInterval now = CACurrentMediaTime();
if (node) {
_lru->_totalCost -= node->_cost;
_lru->_totalCost += cost;
node->_cost = cost;
node->_time = now;
node->_value = object;
[_lru bringNodeToHead:node];
} else {
node = [_YYLinkedMapNode new];
node->_cost = cost;
node->_time = now;
node->_key = key;
node->_value = object;
[_lru insertNodeAtHead:node];
}
if (_lru->_totalCost > _costLimit) {
dispatch_async(_queue, ^{
[self trimToCost:_costLimit];
});
}
if (_lru->_totalCount > _countLimit) {
_YYLinkedMapNode *node = [_lru removeTailNode];
if (_lru->_releaseAsynchronously) {
dispatch_queue_t queue = _lru->_releaseOnMainThread ? dispatch_get_main_queue() : YYMemoryCacheGetReleaseQueue();
dispatch_async(queue, ^{
[node class]; //hold and release in queue
});
} else if (_lru->_releaseOnMainThread && !pthread_main_np()) {
dispatch_async(dispatch_get_main_queue(), ^{
[node class]; //hold and release in queue
});
}
}
pthread_mutex_unlock(&_lock);
}
pthread_main_np 判斷主線程坟募。返回非零,則為主線程湿酸。
- (NSUInteger)totalCount {
pthread_mutex_lock(&_lock);
NSUInteger count = _lru->_totalCount;
pthread_mutex_unlock(&_lock);
return count;
}
pthread_mutex_init(&_lock, NULL);
pthread_mutex_destroy(&_lock); pthread mutex 基本使用方法婿屹。
if (pthread_mutex_trylock(&_lock) == 0) 使用trylock避免阻塞
static inline dispatch_queue_t YYMemoryCacheGetReleaseQueue()
tatic inline 文件內(nèi),內(nèi)聯(lián)