NSCoding:自定义类的对象归档和序列化

序言:最近项目开发有一需求:本公司开发的是智能控制系统,每台机器初始设定时,需要用户设定各个参数的值,由于页面参数众多,用户对一台设定好参数后,可能需要对其他的机器也所有参数设定同样的值。此时需求就出来:每当用户设定好参数后,点击页面的保存按钮后,就会保存该参数模板到本地。当对其他机器设定是,页面会出现使用上次设置按钮,当用户点击此按钮时,就会将本地保存的所有有效的参数值按顺序进行下发设定(有效值:每个参数都会有默认值,一般默认值都是该类型的最大值,没有意义)。


分析:


初期,我的开发思路是这样的:

  • 1. 对应每个页面建一个model,然后在model中按页面参数顺序定义所对应的参数值assign类型的存储属性。初始化时会对所有的参数值初始化一个默认值,即最大值;
  • 2. 当用户点击保存时,会取出当前页面所有的参数值,会按顺序将有效的参数值写入model的存储属性中(默认值就不写入);
  • 3. 当用户点击使用上次设置时,会取出该该model的属性值,按顺序下发有效的参数值。

弊端:对应每个页面都需要创建一个model,对应多个页面就需要多个model;然后每个Model需要定义多个存储属性以一一对应页面的参数。最后可能需要第三方的框架(MJExtension),将每个模型对象转换成NSString对象,继而将该对象存储到沙盒。还要从沙盒中去取该NSString对象,然后转成model对象。
model的.m文件中

- (void)save {
    //将初始化模型(InitiatorModel)转为json字符串
    NSString *json = [self mj_JSONString];
    //写入用户偏好设置数据库
    [[NSUserDefaults standardUserDefaults] setObject:json forKey:ACTIVE_REACTIVE_MODEL_KEY];
}

+ (instancetype)activeReactiveModel {
    //从用户偏好设置数据库取json字符串
    NSString *json = [[NSUserDefaults standardUserDefaults] objectForKey:ACTIVE_REACTIVE_MODEL_KEY];
    if (!json) {
        return nil;
    }
    //通过json字符串转为初始化模型(InitialModel)
    ActiveReactiveModel *activeReactiveModel = [ActiveReactiveModel mj_objectWithKeyValues:json];
    return activeReactiveModel;
}

开发完成之后,基本功能都可以实现,但是发现扩展性不好,每个页面都对应一个model。后来和同事沟通交流,一同事说有更好的实现方式,利用NSKeyedArchiver实现对象的归档。但是有个前提,一般对象都是系统Foundation框架下的类的对象都可以实现。究其根由,Foundation框架下的类都是遵从NSCoding协议。看下苹果开发文档。

NSCoding.png

所有在自己定义的模型model中遵从NSCoding协议,然后实现该协议的两个协议方法。
model文件SARegister
SARegister.h文件:

#import <Foundation/Foundation.h>

@interface SARegister : NSObject<NSCoding>

/// 寄存器地址
@property (nonatomic, assign) NSUInteger address;
/// 寄存器个数(从文件中读取时确定)
@property (nonatomic, assign, readonly) NSUInteger length;
/// 读取上来的 rawValue
@property (nonatomic, strong) NSData *valueData;

/// 计算属性
@property (nonatomic, assign) NSInteger value;
@property (nonatomic, strong) NSString *utf8Value;

/// 最近一次跟新 value 的时间
@property (nonatomic, strong) NSDate *lastDate;
@property (nonatomic, strong) NSString *name;
/** 通过registerId来获取唯一的寄存器 */
@property (nonatomic, strong) NSString *registerId;

@end

SARegister.m文件:

#import "SARegister.h"

@implementation SARegister
...
//省略代码
...
#pragma mark - NSCoding
- (instancetype)initWithCoder:(NSCoder *)aDecoder {
    self = [super init];
    if (self) {
        self.address = [aDecoder decodeIntegerForKey:@"address"];
        self.valueData = [aDecoder decodeObjectForKey:@"valueData"];
        self.lastDate = [aDecoder decodeObjectForKey:@"lastDate"];
        self.name = [aDecoder decodeObjectForKey:@"name"];
        self.registerId = [aDecoder decodeObjectForKey:@"registerId"];
    }
    return self;
}

- (void)encodeWithCoder:(NSCoder *)aCoder {
    [aCoder encodeInteger:self.address forKey:@"address"];
    [aCoder encodeObject:self.valueData forKey:@"valueData"];
    [aCoder encodeObject:self.lastDate forKey:@"lastDate"];
    [aCoder encodeObject:self.name forKey:@"name"];
    [aCoder encodeObject:self.registerId forKey:@"registerId"];
}

@end

页面的ViewController.m文件中:具体展示保存和取出model数组

//文件保存路径:Library/Application Support
- (NSString *)archivePath {
    NSArray *paths = NSSearchPathForDirectoriesInDomains(NSApplicationSupportDirectory, NSUserDomainMask, YES);
    NSString *documentsPath = @"";
    if (paths.count > 0) {
        documentsPath = paths.firstObject;
        if (! [[NSFileManager defaultManager] fileExistsAtPath:documentsPath]) {
            NSError *error;
            if(![[NSFileManager defaultManager] createDirectoryAtPath:documentsPath withIntermediateDirectories:YES attributes:nil error:&error]) {
                NSLog(@"Failed to create directory. error: %@",error);
            }
        }
    }
    return documentsPath;
}

//保存参数模板(model数组)
- (void)saveModel{
    [[NSFileManager defaultManager] changeCurrentDirectoryPath:self.archivePath];
    BOOL succes = [NSKeyedArchiver archiveRootObject:self.saRegisters toFile:self.titleName];
        if (succes) {
            [Utility showSuccessToastStatus:NSLocalizedString(@"保存成功", @"保存成功")];
        } else {
            [Utility showErrorToastStatus:NSLocalizedString(@"数据同步失败"", @"数据同步失败")];
        }
}

//取出model数组
- (NSArray<SAMenuItem *>*)useTemplate {
    if (self.canSave) {
        NSString *path = [self.archivePath stringByAppendingPathComponent:self.titleName];
        NSArray<SAMenuItem *> *archiver = [NSKeyedUnarchiver unarchiveObjectWithFile:path];
        return archiver;
    }
    return nil;
}

注意:如果定义的model中的某个属性同样也是自己定义的一个类的对象,那么该类也是要遵从NSCoding协议,然后实现两个协议方法。

- (instancetype)initWithCoder:(NSCoder *)aDecoder;
- (void)encodeWithCoder:(NSCoder *)aCoder;
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 199,902评论 5 468
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,037评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 146,978评论 0 332
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 53,867评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 62,763评论 5 360
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,104评论 1 277
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,565评论 3 390
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,236评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,379评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,313评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,363评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,034评论 3 315
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,637评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,719评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,952评论 1 255
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,371评论 2 346
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 41,948评论 2 341

推荐阅读更多精彩内容