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;