IOS-YYCache时效性改造以及缓存文件被删除导致YYCac
2017-12-02 本文已影响53人
一张小A
前言
做项目的时候常常会遇到各种各样的缓存。一个好的缓存策略需要考虑诸多因素。水平有限的时候会使用一些三方库处理这块逻辑。本人在项目中用到是YYCache处理缓存。但是考虑到项目中有些缓存是具备时效性的。YYCache对这块没有相应的处理。所以针对这块逻辑需要我们基于YYCache进行进一步封装。
1.YYCache简介
YYCache是一款非常优秀的缓存框架。存储的时候会将数据存入内存和磁盘缓存中。并且会根据不同情况选择存储在文件中还是数据库中。读取数据的时候会优先读取内存然后才是磁盘缓存。
YYCache提供了initWithPath:的初始化方法。可以创建多个缓存文件。多账户缓存时，可以一个账户对应一个缓存，不需要再通过拼接key进行缓存啦。
2.时效性缓存策略
创建一个缓存模型，记录下创建时间以及失效时间.然后将这个模型存储。获取缓存的时候，首先将这个失效时间与当前时间对比，如果失效返回空，并删除这个缓存。如果不失效，返回相应数据。
@interface HJCacheModule : HJBasicModle
@property (nonatomic,strong) NSDate *beginDate;
//存储对象满足解档归档
@property (nonatomic,strong) id<NSCoding> data;
@property (nonatomic,strong) NSDate *expirationDate;
-(instancetype)initWithData:(id<NSCoding>)data timeOut:(NSTimeInterval)timeOut;
-(instancetype)initWithData:(id<NSCoding>)data;
@end
@implementation HJCacheModule
- (instancetype)initWithData:(id<NSCoding>)data timeOut:(NSTimeInterval)timeOut{
self = [super init];
if (self) {
self.data = data;
self.beginDate = [NSDate date];
if (timeOut>=0) {
self.expirationDate = [NSDate dateWithTimeInterval:timeOut sinceDate:self.beginDate];
}
}
return self;
}
-(instancetype)initWithData:(id<NSCoding>)data{
return [self initWithData:data timeOut:-1];
}
@end
3.时效性具体实现
-(void)saveFileCache:(id<NSCoding>)object forKey:(NSString *)key timeot:(NSTimeInterval)interval{
HJCacheModule *module = [[HJCacheModule alloc] initWithData:object timeOut:interval];
//采用YYCache缓存
[self.cache setObject:module forKey:key];
}
//文件缓存
- (id<NSCoding>)fileCacheForKey:(NSString *)key{
HJCacheModule *module = [self.cache objectForKey:key];
if (module) {
if (module.expirationDate) {
//判断失效时间晚于当前时间
if ([module.expirationDate isLaterDate:[NSDate date]]) {
return module.data;
}else{
[self.cache removeObjectForKey:key];
return nil;
}
}else{
return module.data;
}
}else{
return nil;
}
}
4.内存缓存和磁盘缓存剥离
实际缓存中可能存在这种场景，数据只存在内存中。比如账户信息等。程序关闭时这些内存信息自动清除，不需要人为清除这些数据。但是YYCache的策略是先存内存，然后在存储在磁盘中。显然是满足不了这种需求的。所以我的方法是，将YYCache中的内存缓存剥离，然后自己处理内存缓存逻辑（这块逻辑不是那么复杂，苹果自带内存缓存库就可以实现）。然后将两者结合，实现上述场景。
4.1内存缓存以及时效性实现
采用系统提供的NSCache 处理内存缓存，时效性处理与目录3类似。
@interface HJMemeCacheManager : NSObject
+(HJMemeCacheManager *)shareInstance;
-(void)saveMemeCacheData:(nullable id<NSCoding>)data withKey:(nonnull NSString *)key;
-(void)saveMemeCacheData:(nullable id<NSCoding>)data withKey:(nonnull NSString *)key timeOut:(NSTimeInterval)timeOut;
-(nullable id<NSCoding>)memeCacheDataWithKey:(nonnull NSString *)key;
-(void)removeMemeCacheWithKey:(nonnull NSString *)key;
-(void)removeAllMemeCache;
@end
@interface HJMemeCacheManager()<NSCacheDelegate>
@property (nonatomic,strong) NSCache *memeCache;
@end
@implementation HJMemeCacheManager
+(HJMemeCacheManager *)shareInstance{
static dispatch_once_t once;
static HJMemeCacheManager *instance =nil;
dispatch_once(&once, ^{
instance = [[self alloc] init];
});
return instance;
}
-(instancetype)init{
if (self = [super init]) {
self.memeCache = [[NSCache alloc] init];
self.memeCache.delegate = self;
}
return self;
}
-(void)saveMemeCacheData:(id<NSCoding>)data withKey:(NSString *)key{
[self saveMemeCacheData:data withKey:key timeOut:-1];
}
-(void)saveMemeCacheData:(id<NSCoding>)data withKey:(NSString *)key timeOut:(NSTimeInterval)timeOut{
HJCacheModule *module = [[HJCacheModule alloc] initWithData:data timeOut:timeOut];
[self.memeCache setObject:module forKey:key];
}
-(id<NSCoding>)memeCacheDataWithKey:(NSString *)key{
HJCacheModule *module = [self.memeCache objectForKey:key];
if (module) {
if (module.expirationDate && [module.expirationDate isEarlierDate:[NSDate date]]) {
return nil;
}else{
return module.data;
}
}else{
return nil;
}
}
-(void)removeMemeCacheWithKey:(NSString *)key{
[self.memeCache removeObjectForKey:key];
}
-(void)removeAllMemeCache{
[self.memeCache removeAllObjects];
}
@end
4.2YYCache内存缓存部分剥离
将YYCache的内存缓存剥离,让YYCache只处理磁盘缓存这块逻辑（这块逻辑还是挺复杂的）。
- (instancetype)initWithPath:(NSString *)path {
if (path.length == 0) return nil;
YYDiskCache *diskCache = [[YYDiskCache alloc] initWithPath:path];
if (!diskCache) return nil;
NSString *name = [path lastPathComponent];
// YYMemoryCache *memoryCache = [YYMemoryCache new];
// memoryCache.name = name;
self = [super init];
_name = name;
_diskCache = diskCache;
// _memoryCache = memoryCache;
return self;
}
具体注释代码见文章最后的demo。
4.3内存缓存和磁盘缓存结合
缓存数据时还是有必要在内存中存上一份的，这样读取效率更快。由于将YYCache的内存缓存去掉，所以需要我们额外处理这块逻辑。
-(void)saveAllCacheWithData:(nullable id<NSCoding>)data cacheKey:(nonnull NSString *)key timeout:(NSTimeInterval)interval{
//存内存
[self saveMemeCacheData:data withKey:key timeOut:interval];
//存缓存
[self saveFileCache:data forKey:key timeot:interval];
}
-(id<NSCoding>)cacheDataWithKey:(NSString *)key{
//读内存
id <NSCoding> object = [self memeCacheDataWithKey:key];
if (object) {
return object;
}else{
//读缓存
return [self fileCacheForKey:key];
}
}
5清楚所有缓存处理
项目中我们还需要存储一些其他数据，比如PDF文件，图片等等。这些数据是不能通过YYCache存储的。因为读取的时候会很麻烦，需要转成相应的内容，然后才能读取成功。
所以在做清除所有缓存操作的时候，直接删除缓存文件比较方便。
+(void)cleanAllCache:(void (^)(BOOL))backBlock{
NSError *error = nil;
NSArray *subFilePaths = [[ NSFileManager defaultManager ] contentsOfDirectoryAtPath:[self cachePath] error:&error];
if (error) {
NSLog(@"error:cache子路径获取有误");
backBlock(NO);
}
//删除你的缓存目录下的所有文件
dispatch_async(dispatch_get_global_queue(0, 0), ^{
NSError *errorTWO = nil;
for (NSString *subFilePath in subFilePaths) {
[[ NSFileManager defaultManager ] removeItemAtPath:[[self cachePath] stringByAppendingPathComponent: subFilePath] error :&errorTWO];
if (error) {
NSLog(@"error:子路径%@删除有误",subFilePath);
backBlock(NO);
return;
}
}
dispatch_async(dispatch_get_main_queue(), ^{
backBlock(YES);
});
});
}
5.删除文件时YYCache的处理
测试过程中发现，将所有文件删除时，YYCache存储将会失败。错误显示数据库操作失败。后来发现是由于YYCache的数据库等文件被删除时，对数据库操作失败了。细想一下不应该呀。没有数据库文件YYCache应该也会再创建一个呀。经过排查代码发现，YYCache在初始化的时候会维护一个数组，这个数组存放相应的YYCache对象，检测数据库的逻辑是放在YYCache初始化的时候。当你把数据库文件删除的时候，这个YYCache对象并没有去除。所以当你存储数据的时候，YYCache对象对空的数据库进行操作，导致存储失败。
解决思路：删除文件的同时清除这个YYCache对象。具体实现如下：
5.1增加清除YYCache对象方法
在YYDiskCache.m 添加清除YYCache对象方法
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;
}
static void _YYDiskCacheSetGlobal(YYDiskCache *cache) {
if (cache.path.length == 0) return;
_YYDiskCacheInitGlobal();
dispatch_semaphore_wait(_globalInstancesLock, DISPATCH_TIME_FOREVER);
[_globalInstances setObject:cache forKey:cache.path];
dispatch_semaphore_signal(_globalInstancesLock);
}
//新增的清空YYCache对象方法
static void _YYDiskCacheRemoveAllGlobal(){
_YYDiskCacheInitGlobal();
dispatch_semaphore_wait(_globalInstancesLock, DISPATCH_TIME_FOREVER);
[_globalInstances removeAllObjects];
dispatch_semaphore_signal(_globalInstancesLock);
}
在YYDiskCache中添加方法以及实现
+(void)removeAllCacheList;
+(void)removeAllCacheList{
_YYDiskCacheRemoveAllGlobal();
}
将方法暴露在YYCache类中
+(void)removeAllCacheList;
+(void)removeAllCacheList{
[YYDiskCache removeAllCacheList];
}
5.2删除缓存文件的时候去掉YYCache对象
+(void)cleanAllCache:(void (^)(BOOL))backBlock{
NSError *error = nil;
NSArray *subFilePaths = [[ NSFileManager defaultManager ] contentsOfDirectoryAtPath:[self cachePath] error:&error];
if (error) {
NSLog(@"error:cache子路径获取有误");
backBlock(NO);
}
dispatch_async(dispatch_get_global_queue(0, 0), ^{
NSError *errorTWO = nil;
for (NSString *subFilePath in subFilePaths) {
[[ NSFileManager defaultManager ] removeItemAtPath:[[self cachePath] stringByAppendingPathComponent: subFilePath] error :&errorTWO];
if (error) {
NSLog(@"error:子路径%@删除有误",subFilePath);
backBlock(NO);
return;
}
}
//清除YYCache对象
[YYCache removeAllCacheList];
dispatch_async(dispatch_get_main_queue(), ^{
backBlock(YES);
});
});
}
总结
总结就没有了，最后附上代码
GitHub
