背景
App 中不可避免的要做一些本地缓存, 如网络图片, 网络数据, 用户登录状态等等.
一般常用 SDwebImage 来处理网络图片的加载, 缓存, 常用 FMDB 来处理网络数据的缓存, 个别地方也有使用到 NSUserDefault.
对于网络数据, 一般都是 JSON 格式的形式, 而项目中通常会转换成相应的数据模型对象. 对于数据模型的缓存, 是否可以通过类扩展 (增加读, 取两个方法) 来更方便的处理? 在最近的两个项目中, 我采用了这种方式, 有便利的地方, 也有一些需要注意, 待完善的地方, 本文做一些记录, 以后有更好的想法也会追记下来.
基本思路
创建 NSObject 扩展, 增加读, 写的方法, 默认以存取对象的 class 名作为文件名, 也可以按传入的文件名存取.
- //
- // NSObject+ZKLocalCache.m
- // AU_FX
- //
- // Created by Evan on 2018/12/16.
- //
- #import "NSObject+ZKLocalCache.h"
- @implementation NSObject (ZKLocalCache)
- /**
- * 保存到本地
- */
- - (void)zk_writeToLocal {
- // 默认 Class 名作为文件名
- [self zk_writeToLocalWithFilename:NSStringFromClass([self class])];
- }
- /**
- * 保存到本地
- * @param filename 文件名
- */
- - (void)zk_writeToLocalWithFilename:(NSString *)filename {
- // 必须遵守 NSCoding 协议
- if ([self conformsToProtocol:@protocol(NSCoding)]) {
- // 默认存在 / Library/Caches 目录下
- NSArray<NSString *> *directories = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
- NSString *directory = directories.firstObject;
- NSString *path = [NSString stringWithFormat:@"%@/%@", directory, filename];
- // 归档
- [NSKeyedArchiver archiveRootObject:self toFile:path];
- }
- }
- /**
- * 从本地缓存读取
- */
- + (id)zk_readFromLocal {
- // 默认 Class 名作为文件名
- return [self zk_readFromLocalWithFilename:NSStringFromClass([self class])];
- }
- /**
- * 从本地缓存读取
- * @param filename 文件名
- */
- + (id)zk_readFromLocalWithFilename:(NSString *)filename {
- // 默认存在 / Library/Caches 目录下
- NSArray<NSString *> *directories = NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES);
- NSString *directory = directories.firstObject;
- NSString *path = [NSString stringWithFormat:@"%@/%@", directory, filename];
- // 解档
- return [NSKeyedUnarchiver unarchiveObjectWithFile:path];
- }
- @end
想要缓存的数据对象, 必须遵守 NSCoding 协议. 如果项目中引用了小码哥的 MJExtension, 则一行代码搞定.
- //
- // ZKHomeDataModel.m
- // AU_FX
- //
- // Created by Evan on 2018/12/16.
- //
- #import "ZKHomeDataModel.h"
- @implementation ZKHomeDataModel
- MJCodingImplementation
- @end
数据对象需要缓存, 读取时, 直接调用 NSObject 扩展的方法即可.
- #import "ZKHomeDataModel.h"
- #import "NSObject+ZKLocalCache.h"
- @implementation VFXHomeViewController
- - (void)viewDidLoad {
- [super viewDidLoad];
- // 从缓存中读取数据
- ZKHomeDataModel *dataModel = [ZKHomeDataModel zk_readFromLocal];
- if (!dataModel) { // 如果之前未缓存
- // ...
- }
- // 界面设定
- // ...
- // 通过调用 API 获取网络数据
- // ... 网络数据转换成 dataModel
- // 缓存到本地
- [dataModel zk_writeToLocal];
- }
使用起来还是挺方便的.
需要注意的地方
如果有频繁读取本地文件的情况, 比如项目中有使用 socket,websocket 长连接的场景, 1 秒钟要处理多次数据, 如果在这个处理中存取文件, 会导致 App 卡顿. 这种情况就需要妥善处理了. 可以考虑单例模式.
考虑到大多数 App 都有清除缓存的操作, 对清除本地缓存文件需要区别对待. 比如用户信息, 用户在退出登录前不可清除, 退出登录时必须清除.
如有需要, 可对缓存的有效期进行设定. 在取缓存之前, 先做有效期的判定.
对 NSObject 扩展, 即使 NSDictionary,NSArray 等也可以方便的存取. 但感觉范围太广泛了, 如果是对数据模型的基类进行扩展, 那么所有的数据模型必须继承该基类, NSDictionary,NSArray 等类型的数据则无法使用该扩展方法.
来源: http://www.jianshu.com/p/fa9c6f44b7f1