应用场景:
iOS中需要频繁读取的数据,都可以用NSCache把数据缓存到内存中提高读取性能。
正文:
一:定义
- NSCache是系统提供的一种类似于集合(NSMutableDictionary)的缓存,它与集合的不同如下:
- NSCache具有自动删除的功能,以减少系统占用的内存;
- NSCache是线程安全的,不需要加线程锁;
- 键对象不会像 NSMutableDictionary 中那样被复制。(键不需要实现 NSCopying 协议)。
二:属性介绍
NSCache的属性以及方法介绍:
@property NSUInteger totalCostLimit;
设置缓存占用的内存大小,并不是一个严格的限制,当总数超过了totalCostLimit设定的值,系统会清除一部分缓存,直至总消耗低于totalCostLimit的值。
@property NSUInteger countLimit;
设置缓存对象的大小,这也不是一个严格的限制。
- (id)objectForKey:(id)key;
获取缓存对象,基于key-value对
- (void)setObject:(id)obj forKey:(id)key; // 0 cost
存储缓存对象,考虑缓存的限制属性;
- (void)setObject:(id)obj forKey:(id)key cost:(NSUInteger)g;
存储缓存对象,cost是提前知道该缓存对象占用的字节数,也会考虑缓存的限制属性,建议直接使用 - (void)setObject:(id)obj forKey:(id)key;
NSCacheDelegate代理
三:代理属性声明如下
@property (assign) id<NSCacheDelegate>delegate;
实现了NSCacheDelegate代理的对象,在缓存对象即将被清理的时候,系统回调代理方法如下:
- (void)cache:(NSCache *)cache willEvictObject:(id)obj;
第一个参数是当前缓存(NSCache),不要修改该对象;
第二个参数是当前将要被清理的对象,如果需要存储该对象,可以在此操作(存入Sqlite or CoreData);
该代理方法的调用会在缓存对象即将被清理的时候调用,如下场景会调用:
1. - (void)removeObjectForKey:(id)key; 手动删除对象;
2. 缓存对象超过了NSCache的属性限制;(countLimit 和 totalCostLimit )
3. App进入后台会调用;
4. 系统发出内存警告;
四:NSDiscardableContent协议
NSDiscardableContent是一个协议,实现这个协议的目的是为了让我们的对象在不被使用时,可以将其丢弃,以让程序占用更少的内存。
一个NSDiscardableContent对象的生命周期依赖于一个“counter”变量。一个NSDiscardableContent对象实际是一个可清理内存块,这个内存记录了对象当前是否被其它对象使用。如果这块内存正在被读取,或者仍然被需要,则它的counter变量是大于或等于1的;当它不再被使用时,就可以丢弃,此时counter变量将等于0。当counter变量等于0时,如果当前时间点内存比较紧张的话,内存块就可能被丢弃。这点类似于MRC&ARC,对象内存回收机制。
- (void)discardContentIfPossible
当counter等于0的时候,为了丢弃这些对象,会调用这个方法。
默认情况下,NSDiscardableContent对象的counter变量初始值为1,以确保对象不会被内存管理系统立即释放。
- (BOOL)beginContentAccess (counter++)
调用该方法,对象的counter会加1;
与beginContentAccess相对应的是endContentAccess。如果可丢弃内存不再被访问时调用。其声明如下:
- (void)endContentAccess (counter--)
该方法会减少对象的counter变量,通常是让对象的counter值变回为0,这样在对象的内容不再被需要时,就要以将其丢弃。
NSCache类提供了一个属性,来标识缓存是否自动舍弃那些内存已经被丢弃的对象(默认该属性为YES),其声明如下:
@property BOOL evictsObjectsWithDiscardedContent
如果设置为YES,则在对象的内存被丢弃时舍弃对象。
个人建议:如果需要使用缓存,直接用系统的NSCache就OK了,不要做死。
NSCache就写到这里了,欢迎大家来指正错误,我们一起进步,感谢大家的阅读。
使用场景
一: 缓存数量限制代码示例
代码演练
需要实现NSCacheDelegate
@interface ViewController () <NSCacheDelegate>
实现代理方法:
// MARK: NSCache Delegate
// 当缓存中的对象被清除的时候,会自动调用
// obj 就是要被清理的对象
// 提示:不建议平时开发时重写!仅供调试使用
- (void)cache:(NSCache *)cache willEvictObject:(id)obj {
[NSThread sleepForTimeInterval:0.5];
NSLog(@"清除了-------> %@", obj);
}
声明NSCache变量:
@property (nonatomic, strong) NSCache *cache;
懒加载:
- (NSCache *)cache {
if (_cache == nil) {
_cache = [[NSCache alloc] init];
// 设置数量限制,最大限制为10
_cache.countLimit = 10;
_cache.delegate = self;
}
return _cache;
}
测试Demo:
- (void)touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event {
for (int i = 0; i < 20; ++i) {
NSString *str = [NSString stringWithFormat:@"hello - %04d", i];
NSLog(@"设置 %@", str);
// 添加到缓存
[self.cache setObject:str forKey:@(i)];
}
// - 查看缓存内容,NSCache 没有提供遍历的方法,只支持用 key 来取值
for (int i = 0; i < 20; ++i) {
NSLog(@"缓存中----->%@", [self.cache objectForKey:@(i)]);
}
}
运行结果:
2015-03-25 09:27:19.953 01-NSCache演练[26010:681046] 设置 hello - 0000
2015-03-25 09:27:19.954 01-NSCache演练[26010:681046] 设置 hello - 0001
2015-03-25 09:27:19.954 01-NSCache演练[26010:681046] 设置 hello - 0002
2015-03-25 09:27:19.954 01-NSCache演练[26010:681046] 设置 hello - 0003
2015-03-25 09:27:19.954 01-NSCache演练[26010:681046] 设置 hello - 0004
2015-03-25 09:27:19.954 01-NSCache演练[26010:681046] 设置 hello - 0005
2015-03-25 09:27:19.954 01-NSCache演练[26010:681046] 设置 hello - 0006
2015-03-25 09:27:19.955 01-NSCache演练[26010:681046] 设置 hello - 0007
2015-03-25 09:27:19.955 01-NSCache演练[26010:681046] 设置 hello - 0008
2015-03-25 09:27:19.955 01-NSCache演练[26010:681046] 设置 hello - 0009
2015-03-25 09:27:19.955 01-NSCache演练[26010:681046] 设置 hello - 0010
2015-03-25 09:27:20.456 01-NSCache演练[26010:681046] 清除了-------> hello - 0000
2015-03-25 09:27:20.457 01-NSCache演练[26010:681046] 设置 hello - 0011
2015-03-25 09:27:20.957 01-NSCache演练[26010:681046] 清除了-------> hello - 0001
2015-03-25 09:27:20.957 01-NSCache演练[26010:681046] 设置 hello - 0012
2015-03-25 09:27:21.458 01-NSCache演练[26010:681046] 清除了-------> hello - 0002
2015-03-25 09:27:21.459 01-NSCache演练[26010:681046] 设置 hello - 0013
2015-03-25 09:27:21.959 01-NSCache演练[26010:681046] 清除了-------> hello - 0003
2015-03-25 09:27:21.959 01-NSCache演练[26010:681046] 设置 hello - 0014
2015-03-25 09:27:22.461 01-NSCache演练[26010:681046] 清除了-------> hello - 0004
2015-03-25 09:27:22.461 01-NSCache演练[26010:681046] 设置 hello - 0015
2015-03-25 09:27:22.962 01-NSCache演练[26010:681046] 清除了-------> hello - 0005
2015-03-25 09:27:22.962 01-NSCache演练[26010:681046] 设置 hello - 0016
2015-03-25 09:27:23.464 01-NSCache演练[26010:681046] 清除了-------> hello - 0006
2015-03-25 09:27:23.464 01-NSCache演练[26010:681046] 设置 hello - 0017
2015-03-25 09:27:23.965 01-NSCache演练[26010:681046] 清除了-------> hello - 0007
2015-03-25 09:27:23.965 01-NSCache演练[26010:681046] 设置 hello - 0018
2015-03-25 09:27:24.466 01-NSCache演练[26010:681046] 清除了-------> hello - 0008
2015-03-25 09:27:24.466 01-NSCache演练[26010:681046] 设置 hello - 0019
2015-03-25 09:27:24.967 01-NSCache演练[26010:681046] 清除了-------> hello - 0009
2015-03-25 09:27:24.967 01-NSCache演练[26010:681046] 缓存中----->(null)
2015-03-25 09:27:24.967 01-NSCache演练[26010:681046] 缓存中----->(null)
2015-03-25 09:27:24.968 01-NSCache演练[26010:681046] 缓存中----->(null)
2015-03-25 09:27:24.968 01-NSCache演练[26010:681046] 缓存中----->(null)
2015-03-25 09:27:24.968 01-NSCache演练[26010:681046] 缓存中----->(null)
2015-03-25 09:27:24.968 01-NSCache演练[26010:681046] 缓存中----->(null)
2015-03-25 09:27:24.969 01-NSCache演练[26010:681046] 缓存中----->(null)
2015-03-25 09:27:24.969 01-NSCache演练[26010:681046] 缓存中----->(null)
2015-03-25 09:27:24.969 01-NSCache演练[26010:681046] 缓存中----->(null)
2015-03-25 09:27:24.969 01-NSCache演练[26010:681046] 缓存中----->(null)
2015-03-25 09:27:24.969 01-NSCache演练[26010:681046] 缓存中----->hello - 0010
2015-03-25 09:27:24.970 01-NSCache演练[26010:681046] 缓存中----->hello - 0011
2015-03-25 09:27:24.970 01-NSCache演练[26010:681046] 缓存中----->hello - 0012
2015-03-25 09:27:24.970 01-NSCache演练[26010:681046] 缓存中----->hello - 0013
2015-03-25 09:27:24.970 01-NSCache演练[26010:681046] 缓存中----->hello - 0014
2015-03-25 09:27:24.971 01-NSCache演练[26010:681046] 缓存中----->hello - 0015
2015-03-25 09:27:24.971 01-NSCache演练[26010:681046] 缓存中----->hello - 0016
2015-03-25 09:27:24.971 01-NSCache演练[26010:681046] 缓存中----->hello - 0017
2015-03-25 09:27:24.971 01-NSCache演练[26010:681046] 缓存中----->hello - 0018
2015-03-25 09:27:24.971 01-NSCache演练[26010:681046] 缓存中----->hello - 0019
总结
通过打印结果可以知道,当超多最大成本限制的时候,会先清除缓存中的一条数据,再存入一条新的数据。最后缓存中只能保存最大成本数的数据,即10条。
二:关联沙箱代码示例:(减少频繁读取文件时间)
代码示例
#import "AHPersonInfoManager.h"
#import "YYModel.h"
@interface AHPersonInfoManager()
//用户信息模型
@property(nonatomic,strong)AHPersonInfoModel *model;
//个人信息缓存
@property(nonatomic,strong)NSCache *infoModelCache;
@end
@implementation AHPersonInfoManager
+(instancetype)manager{
static AHPersonInfoManager *personInfoManager = nil;
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
@synchronized (personInfoManager) {
personInfoManager = [[AHPersonInfoManager alloc]init];
personInfoManager.infoModelCache = [[NSCache alloc]init];
}
});
return personInfoManager;
}
#pragma mark 个人资料
-(AHPersonInfoModel*)getInfoModel{
//读取缓存
if (_infoModelCache) {
return [_infoModelCache objectForKey:@"infoModel"];
}
//读取文件
NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
//获取完整路径
NSString *documentsDirectory = [paths objectAtIndex:0];
// LOG(@"homeDirectory = %@", documentsDirectory);
NSString *plistPath = [documentsDirectory stringByAppendingPathComponent:PersonInfoFilePath];
//读出文件
if ( [[NSFileManager defaultManager] fileExistsAtPath:plistPath]) {
NSMutableDictionary *infoDic = [[[NSMutableDictionary alloc] initWithContentsOfFile:plistPath] mutableCopy];
_model = [AHPersonInfoModel yy_modelWithDictionary:infoDic];
}else{
//防nil
_model = [[AHPersonInfoModel alloc]init];
}
//写入缓存
[_infoModelCache setObject:_model forKey:@"infoModel"];
return _model;
}
-(void)setInfoModel:(AHPersonInfoModel*)infoModel{
@synchronized (self) {
//写入缓存
if (!_infoModelCache) {
_infoModelCache = [[NSCache alloc]init];
}
[_infoModelCache setObject:infoModel forKey:@"infoModel"];
//写入文件
NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
//获取完整路径
NSString *documentsDirectory = [paths objectAtIndex:0];
// LOG(@"homeDirectory = %@", documentsDirectory);
NSString *plistPath = [documentsDirectory stringByAppendingPathComponent:PersonInfoFilePath];
NSDictionary *dic = [infoModel yy_modelToJSONObject];
//写入文件
[dic writeToFile:plistPath atomically:YES];
_model = infoModel;
}
}
-(void)setWithJson:(id)json{
@synchronized (self) {
NSMutableDictionary *newInfoDic = [json yy_modelToJSONObject];
NSArray *paths = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
//获取完整路径
NSString *documentsDirectory = [paths objectAtIndex:0];
// LOG(@"homeDirectory = %@", documentsDirectory);
NSString *plistPath = [documentsDirectory stringByAppendingPathComponent:PersonInfoFilePath];
//原模型字典
NSMutableDictionary *oldInfoDic= [[[NSMutableDictionary alloc] initWithContentsOfFile:plistPath] mutableCopy];
//防nil
if (!([oldInfoDic allKeys].count >0)) {
oldInfoDic = [NSMutableDictionary dictionary];
}
//修改对应的key-value
NSArray *keyArray = [newInfoDic allKeys];
if (keyArray.count>0) {
for (NSString *key in keyArray) {
if ( [newInfoDic objectForKey:key]) {
//去除星座
if ([key isEqualToString:@"constellation"]) {
}else{
[oldInfoDic setObject:newInfoDic[key] forKey:key];
}
}
}
[oldInfoDic writeToFile:plistPath atomically:YES];
//写入缓存
if (!_infoModelCache) {
_infoModelCache = [[NSCache alloc]init];
}
AHPersonInfoModel *infoModel = [AHPersonInfoModel yy_modelWithJSON:oldInfoDic];
[_infoModelCache setObject:infoModel forKey:@"infoModel"];
}
}
}