YYCache源碼分析(三)
本文分析YYDiskCache->YYKVStorage實現過程：
YYDiskCache對YYKVStorage一層封裝，緩存方式：數據庫+文件,下面先分析主要實現類YYKVStorage，再分析表層類YYDiskCache.
img
YYKVStorage.h方法結構圖
img
YYKVStorage.h方法解釋
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
// 用YYKVStorageItem保存緩存相關參數
@interface YYKVStorageItem : NSObject
// 緩存鍵值
@property (nonatomic, strong) NSString *key;
// 緩存對象
@property (nonatomic, strong) NSData *value;
// 緩存文件名
@property (nullable, nonatomic, strong) NSString *filename;
// 緩存大小
@property (nonatomic) int size;
// 修改時間
@property (nonatomic) int modTime;
// 最后使用時間
@property (nonatomic) int accessTime;
// 擴展數據
@property (nullable, nonatomic, strong) NSData *extendedData;
@end
// 可以指定緩存類型
typedef NS_ENUM(NSUInteger, YYKVStorageType) {
// 文件緩存(filename != null)
YYKVStorageTypeFile = 0,
// 數據庫緩存
YYKVStorageTypeSQLite = 1,
// 如果filename != null，則value用文件緩存，緩存的其他參數用數據庫緩存；如果filename == null,則用數據庫緩存
YYKVStorageTypeMixed = 2,
};
// 緩存操作實現
@interface YYKVStorage : NSObject
#pragma mark - Attribute
// 緩存路徑
@property (nonatomic, readonly) NSString *path;
// 緩存方式
@property (nonatomic, readonly) YYKVStorageType type;
// 是否要打開錯誤日志
@property (nonatomic) BOOL errorLogsEnabled;
#pragma mark - Initializer
// 這兩個方法不能使用，因為實例化對象時要有初始化path、type
- (instancetype)init UNAVAILABLE_ATTRIBUTE;
+ (instancetype)new UNAVAILABLE_ATTRIBUTE;
/**
* 實例化對象
*
* @param path 緩存路徑
* @param type 緩存方式
*/
- (nullable instancetype)initWithPath:(NSString *)path type:(YYKVStorageType)type NS_DESIGNATED_INITIALIZER;
#pragma mark - Save Items
/**
* 添加緩存
*
* @param item 把緩存數據封裝到YYKVStorageItem對象
*/
- (BOOL)saveItem:(YYKVStorageItem *)item;
/**
* 添加緩存
*
* @param key 緩存鍵值
* @param value 緩存對象
*/
- (BOOL)saveItemWithKey:(NSString *)key value:(NSData *)value;
/**
* 添加緩存
*
* @param key 緩存鍵值
* @param value 緩存對象
* @param filename 緩存文件名稱
* filename != null
* 則用文件緩存value，并把`key`,`filename`,`extendedData`寫入數據庫
* filename == null
* 緩存方式type：YYKVStorageTypeFile 不進行緩存
* 緩存方式type：YYKVStorageTypeSQLite || YYKVStorageTypeMixed 數據庫緩存
* @param extendedData 緩存拓展數據
*/
- (BOOL)saveItemWithKey:(NSString *)key
value:(NSData *)value
filename:(nullable NSString *)filename
extendedData:(nullable NSData *)extendedData;
#pragma mark - Remove Items
/**
* 刪除緩存
*/
- (BOOL)removeItemForKey:(NSString *)key;
- (BOOL)removeItemForKeys:(NSArray<NSString *> *)keys;
/**
* 刪除所有內存開銷大于size的緩存
*/
- (BOOL)removeItemsLargerThanSize:(int)size;
/**
* 刪除所有時間比time小的緩存
*/
- (BOOL)removeItemsEarlierThanTime:(int)time;
/**
* 減小緩存占的容量開銷，使總緩存的容量開銷值不大于maxSize(刪除原則：LRU 最久未使用的緩存將先刪除)
*/
- (BOOL)removeItemsToFitSize:(int)maxSize;
/**
* 減小總緩存數量，使總緩存數量不大于maxCount(刪除原則：LRU 最久未使用的緩存將先刪除)
*/
- (BOOL)removeItemsToFitCount:(int)maxCount;
/**
* 清空所有緩存
*/
- (BOOL)removeAllItems;
- (void)removeAllItemsWithProgressBlock:(nullable void(^)(int removedCount, int totalCount))progress
endBlock:(nullable void(^)(BOOL error))end;
#pragma mark - Get Items
/**
* 讀取緩存
*/
- (nullable YYKVStorageItem *)getItemForKey:(NSString *)key;
- (nullable YYKVStorageItem *)getItemInfoForKey:(NSString *)key;
- (nullable NSData *)getItemValueForKey:(NSString *)key;
- (nullable NSArray<YYKVStorageItem *> *)getItemForKeys:(NSArray<NSString *> *)keys;
- (nullable NSArray<YYKVStorageItem *> *)getItemInfoForKeys:(NSArray<NSString *> *)keys;
- (nullable NSDictionary<NSString *, NSData *> *)getItemValueForKeys:(NSArray<NSString *> *)keys;
#pragma mark - Get Storage Status
/**
* 判斷當前key是否有對應的緩存
*/
- (BOOL)itemExistsForKey:(NSString *)key;
/**
* 獲取緩存總數量
*/
- (int)getItemsCount;
/**
* 獲取緩存總內存開銷
*/
- (int)getItemsSize;
@end
NS_ASSUME_NONNULL_END
Typically, write data to sqlite is faster than extern file, but
reading performance is dependent on data size. In my test (on iPhone 6 64G),
read data from extern file is faster than from sqlite when the data is larger
than 20KB.
- If you want to store large number of small datas (such as contacts cache),
use YYKVStorageTypeSQLite to get better performance. - If you want to store large files (such as image cache),
use YYKVStorageTypeFile to get better performance. - You can use YYKVStorageTypeMixed and choice your storage type for each item.
通常情況下，數據寫入SQLite比外部文件更快;但讀取性能依賴于數據大小。在我的測試中（iPhone 6 64G），當數據大小超過20KB時，從外部文件讀取數據的速度比從SQLite數據。
Multiple instances with the same path will make the storage unstable.
具有相同路徑的多個實例將使存儲不穩定。
Save an item or update the item with 'key' if it already exists.
- If the
typeis YYKVStorageTypeFile, then the item.filename should not be empty. - If the
typeis YYKVStorageTypeSQLite, then the item.filename will be ignored. - If the
typeis YYKVStorageTypeMixed, then the item.value will be saved to file
system if the item.filename is not empty, otherwise it will be saved to sqlite.
根據key保存一個item，如果它已經存在,就更新。key-value pair 鍵值對；
YYKVStorageTypeFile,item.filename不能為空；YYKVStorageTypeSQLite，item.filename會被忽略；YYKVStorageTypeMixed 如果filename != null，則value用文件緩存，緩存的其他參數用數據庫緩存；如果filename == null,則用數據庫緩存；
YYKVStorage.m方法結構圖
私有方法：
img
公開方法：
img
/*
File:
/path/
/manifest.sqlite
/manifest.sqlite-shm
/manifest.sqlite-wal
/data/
/e10adc3949ba59abbe56e057f20f883e
/e10adc3949ba59abbe56e057f20f883e
/trash/
/unused_file_or_folder
SQL:
// 建表語句
create table if not exists manifest (
key text,
filename text,
size integer,
inline_data blob,
modification_time integer,
last_access_time integer,
extended_data blob,
primary key(key)
);
// 創建索引
create index if not exists last_access_time_idx on manifest(last_access_time);
*/
SQLite3 索引的簡單使用
http://hustcat.github.io/
http://www.blogfshare.com/
iOS-SQLite3和FMDB使用
SQLLite (三)：sqlite3_prepare_v2,sqlite3_step
YYKVStorage.m方法實現
下面分別拎出添加、刪除、查找各個主要的方法來講解
