YYCache深刻学习

时间 2019-11-16

标签 yycache 深刻学习繁體版

原文原文链接

深知，源码仍是一点点读，加点读书笔记，才能够深刻挖掘，所以仍是以为每次读源码都记录一番，不管好坏，若有写错，请斧正node

简介

YYCahce 是做为 ibireme 大神开源的一个YYkit组件库中的一部分，YYCache提供了内存缓存，和持久性的硬盘缓存。ios

一个合理缓存应该有的设计

合理的增删改查接口
高速缓存，提升经常使用缓存的返回性能和效率
低速缓存，磁盘大文件缓存
良好缓存限制策略
高性能，线程安全

基本设计思路

YYCache 提供对外的整合接口，YYMemoryCache 提供内存存储缓存，经过lru算法进行处理，YYDiskCache提供file和sqlite3的两种持久化存储方式算法

YYMemoryCache

YYMemoryCahce 做为一个内存缓存，提供高速缓存，而且由于内存有限，须要进行必定的限制sql

线程安全数据库

在频率高的并发数据操做中，必须保证线程安全，否则拿到的数据不符合预期，或者致使读写冲突在YYMemoryCache中，采用的pthread_mutex加锁api

pthread_mutex 定义了一组跨平台的线程相关的 API，pthread_mutex 表示互斥锁。互斥锁的实现原理与信号量很是类似，不是使用忙等，而是阻塞线程并睡眠，须要进行上下文切换。缓存
```
// 主要使用api	
 pthread_mutex_lock(&mutex); // 申请锁  
 // 临界区
 pthread_mutex_unlock(&mutex); // 释放锁  
复制代码
```
pthread_mutex支持递归锁，递归锁，就是在内部加锁调用的时候，递归了自身，这样子，会致使死锁。安全
- pthread_mutex则支持递归处理 attr PTHREAD_MUTEX_RECURSIVEbash
- memory中使用pthread，在循环释放的时候，经过pthread_mutex_trylock实现简单的自旋锁数据结构
原文：OSSpinLock 和 dispatch_semaphore 都不会产生特别明显的死锁，因此我也没法肯定用 dispatch_semaphore 代替 OSSpinLock 是否正确。可以确定的是，用 pthread_mutex 是安全的。
LRU

最近使用优先，也就是认为，最近使用的，最大可能性会再次用到里面实现用到一个双向链表的结构进行处理，使用到的就会被移动到表头在删除释放的时候，就会从队尾进行删除释放

键值对存储操做

经过建立链表节点node，进行间接操做数据

#pragma mark - _YYLinkedMapNode
@interface _YYLinkedMapNode : NSObject {
    // 相似C中的private_extern，使用@private的话，限制太大，@package在类的镜像外进行引用就会报错
    // 使用@public @protect等的话，就没什么限制的
    // 目的是，限制在本文件中使用
    @package
    __unsafe_unretained _YYLinkedMapNode *_prev; // 经过dic进行持有
    __unsafe_unretained _YYLinkedMapNode *_next; // 经过dic进行持有
    id _key;
    id _value;
    NSUInteger _cost;
    NSTimeInterval _time;
}
@end
复制代码

限制策略

// 限制条件有3个，age cost count ，通常状况下默认都不作限制
/// 个数限制
@property NSUInteger countLimit;
/// 过时时间
@property NSTimeInterval ageLimit;
/// 存储消耗限制，setObject的时候时候把内存大小的存进去
@property NSUInteger costLimit;

@property BOOL shouldRemoveAllObjectsWhenEnteringBackground; // 进入后台检查限制删除缓存，默认YES
@property BOOL shouldRemoveAllObjectsOnMemoryWarning; // 收到内存警告的时候

复制代码

MemoryCache中使用的LRU的的算法进行删除缓存，当超过必定的限制的时候，会进行循环清理，也就是说，memory里面的东西并非存进去就会在app的生命周期中一直存在的，可能会被释放掉。所以外部在使用的时候，须要判空处理的，若是为nil，则认为缓存已经失效，须要从新更新。

所以，YYMemoryCahce并非数据在app的生命周期会被一直保留的，因此，在使用YYCahce最外层接口的时候，YYCache是会经过YYMemoryCache提供高速缓存，同时存入到低速缓存中。

获取的时候，YYMemoryCache获取不到，则会询问YYDiskCache。

某些小技巧，用于提供性能

会在一段时间，自行检查是否超过限制策略，超过则循环释放。 YYMemoryCache默认在进入后台的时候会进行检查。由于一次释放太多，会致使资源消耗过大，所以，经过dispatch_aync block的方式，放到后台线程释放

YYDiskCache

线程安全

disk中使用dispatch_semaphore信号量进行处理

dispatch_semaphore 是信号量，但当信号总量设为 1 时也能够看成锁来。在没有等待状况出现时，它的性能比 pthread_mutex 还要高，但一旦有等待状况出现时，性能就会降低许多。相对于 OSSpinLock 来讲，它的优点在于等待时不会消耗 CPU 资源。对磁盘缓存来讲，它比较合适。

dispatch_semaphore是属于闲等待，CPU不会消耗，所以，在作磁盘缓存的时候，用时较长，须要等待的话，会比较节省资源

OSSpinLock 自旋锁，不安全，因此使用了dispatch_semaphore进行处理，由于大文件，须要等待的状况较多

大文件处理

YYKVStorage 经过key value的一个封装，实现增删改查

YYKVStorage 实现细节:

提供对应的sqlite3的db增删改查的接口，在操做的过程都作了防护式的操做

- (BOOL)_dbClose {
    // 关闭数据库
    if (!_db) {
        return YES;
    }
    
    int result = 0;
    BOOL retry = NO;
    BOOL stmtFinalized = NO;
    
    if (_dbStmtCache) {
        _dbStmtCache = NULL;
    }
    
    do {
        retry = NO;
        result = sqlite3_close(_db);
        
        if (result == SQLITE_BUSY || result == SQLITE_LOCKED) {
            // 若是sqlite被占用，那进行stmt的析构操做，让其释放资源
            // 在从新试一次
            if (!stmtFinalized) {
                stmtFinalized = YES; //析构
                sqlite3_stmt *stmt;
                // sqlite3_stmt 是一种辅助数据结构，用于操做二进制数据
                // 循环释放全部的sqlite stmt
                while ((stmt = sqlite3_next_stmt(_db, nil))) {
                    sqlite3_finalize(stmt); //析构 全部的sqlite stmt的辅助
                    retry = YES; // 而后重试，
                }
            }
        } else if (result != SQLITE_OK) {
            // 关闭失败
            // 输出 错误日志
            NSLog(@"关闭失败");
        }
        
    } while (retry);
    
    _db = NULL;
    return YES;
    
}

- (BOOL)_dbCheck {
    if (_db) {
        // 若是重试错误的次数小于限定次数，而且大于最小重试时间，则从新进行打开和初始化检查
        if (_dbOpenErrorCount < kMaxErrorRetryCount &&
            CACurrentMediaTime() - _dbLastOpenErrorTime > kMinRetryTimeInterval) {
            return [self _dbOpen] && [self _dbInitialize];
        } else {
            return NO;
        }
    }
    return YES; // 正常
}
复制代码

对sqlite的stmt也作了缓存，加速其性能

// 获取缓存中的stmt，用sql作key
- (sqlite3_stmt *)_dbPrepareStmt:(NSString *)sql {
    if (![self _dbCheck] || sql.length == 0 || !_dbStmtCache) return NULL;
    sqlite3_stmt *stmt = (sqlite3_stmt *)CFDictionaryGetValue(_dbStmtCache, (__bridge const void *)(sql));
    
    if (!stmt) {
        // 若是stmt为空的话
        int result = sqlite3_prepare_v2(_db, sql.UTF8String, -1, &stmt, NULL);
        if (result != SQLITE_OK) {
            // 若是不成功
            NSLog(@"建立stmt失败");
            return NULL; // 返回空
        }
        CFDictionarySetValue(_dbStmtCache, sql.UTF8String, stmt); // 缓存起来，都是同一个stmt，每次建立的话，会大量消耗资源，所以这里作了缓存
    } else {
        sqlite3_reset(stmt);
    }
    
    return stmt;
}
复制代码

存储方式有三个模式
- 文件
- sqlite3
- 混合 // 混合的状况有个阈值，大于阈值，则存文件
db sqlite3的使用细节
- sqlite3_stmt 操做数据的辅助数据接口，用于执行sql，而且返回结果
- stmt 也进行作了缓存，由于这个sql会重复不按期使用
优化: 能够升级最新版本的sqlite3，以此提升效率

YYCache

提供了增删改查的API，底下调用的YYMemoryCache和YYDiskCache，封装了一些基本逻辑。在save的时候，会保存到YYMemoryCache和YYDiskCache，读取的时候，会优先读取YYMemoryCache实现高速缓存，再读取低速缓存。

参考

实际上在看的时候，下面这位大佬写得更加清晰的，之因此我按本身的理解再写一次，也是为了让本身更好的研究，根据全部学习技巧来讲，最重要的仍是应用，所以有了这篇文章，但愿以后能逐渐写出一些更好blog

从 YYCache 源码 Get 到如何设计一个优秀的缓存 - https://juejin.im/post/59f6e3b051882534af253d4a

ibireme blog - http://blog.ibireme.com/category/tec/ios-tec/