前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >iOS数据持久化之二——归档与设计可存储化的数据模型基类

iOS数据持久化之二——归档与设计可存储化的数据模型基类

作者头像
珲少
发布2018-08-16 11:35:12
1.1K0
发布2018-08-16 11:35:12
举报
文章被收录于专栏:一“技”之长一“技”之长

iOS数据持久化之二——归档与设计可存储化的数据模型基类

一、引言

        在上一篇博客中,我们介绍了用plist文件进行数据持久化的方法。虽然简单易用,但随着开发的深入,你会发现,这种方式还是有很大的局限性。试想,如果我们可以将用户的登录返回信息模型,游戏中角色的属性信息模型进行直接的持久化存取,那是不是非常爽的事,幸运的是,我们可以通过归档,来设计一个这样的数据模型。

二、先来精通归档吧

        归档也是iOS提供给开发者的一种数据存储的方式,事实上,几乎所有的数据类型都可以通过归档来进行存取。其存储与读取的过程,主要封装在两个类中:NSKeyedArchiver和NSKeyedUnarchiver。

1、归档的原理

        归档是将一种或者多种数据类型进行序列化,解归档的过程就是将序列化的数据进行反序列化的解码,这里需要注意一点,归档的核心并非是数据的持久化处理,而是数据的序列化处理,持久化的处理依然是通过文件存取来实现的。因此,被归档的数据类型都必须遵守一个相同的协议,才能在这个协议的约束下进行正确的归档与解归档,这个协议就是NSCoding协议,我们可以先来看一下NSCoding中的内容:

代码语言:javascript
复制
@protocol NSCoding

- (void)encodeWithCoder:(NSCoder *)aCoder;
- (id)initWithCoder:(NSCoder *)aDecoder;

@end

这个协议非常简单,一个init的归档方法,一个encode的解归档方法,NSCoder就是归档对象。原则上说,无论是什么数据类型的对象,系统的或者是我们自定义的,都可以通过实现这个协议中的方法来支持归档操作。

2、几种归档与解归档的应用
(1)通过类方法来对rootKey进行归档

        这种方式,我个人理解,很类似于NSUserDefaults中的standardUserDefaults,只是后者是系统为我们创建的一个默认plist文件,而rootKey是系统为我们创建的一个默认的归档键值。说起来比较复杂,举个例子就十分清晰了:

代码语言:javascript
复制
    NSString *homeDictionary = NSHomeDirectory();//获取根目录
    NSString *homePath  = [homeDictionary stringByAppendingPathComponent:@"atany.archiver"];//添加储存的文件名
    //方式一:通过data数据归档,在将数据写入文件
    NSData *data= [NSKeyedArchiver archivedDataWithRootObject:@"123"];
    [data writeToFile:homePath atomically:YES];
    //方式二:直接写入文件
    [NSKeyedArchiver archiveRootObject:@"456" toFile:homePath];
    //方式一和方式二的效果完全一样 只是解归档的时候不同
    
    //方式一的解归档:先获取data数据,在进行data数据的解归档
    NSLog(@"%@",[NSKeyedUnarchiver unarchiveObjectWithData:data]);
    //方式二的解归档:直接解文件中的归档
    NSLog(@"%@",[NSKeyedUnarchiver unarchiveObjectWithFile:homePath]);

上面的示例是对字符串类型进行的归档,是对单一的数据对象进行的归档,当然,这里的对象是支持数组、字典等集合的,但集合其中的对象,也必须全部支持归档操作。

(2)通过构造新的archiver对象,对多个对象进行归档

        除了上面的类方法,我们还可以自己构造一个归档对象,来对多种不同的对象进行归档:

代码语言:javascript
复制
    NSString *homeDictionary = NSHomeDirectory();//获取根目录
    NSString *homePath  = [homeDictionary stringByAppendingPathComponent:@"atany.archiver"];//添加储存的文件名
    //这里创建一个可变的data对象作为归档的容器
    NSMutableData * data = [[NSMutableData alloc]init];
    //创建一个归档对象,归档后写入data数据
    NSKeyedArchiver * archiver = [[NSKeyedArchiver alloc]initForWritingWithMutableData:data];
    //对下面的字符串和int值进行归档序列化
    [archiver encodeObject:@"jaki" forKey:@"name"];
    [archiver encodeInt:24 forKey:@"age"];
    //写入data
    [archiver finishEncoding];
    //写入文件
    [data writeToFile:homePath atomically:YES];
    
    //创建解归档的反序列化对象
    NSKeyedUnarchiver * unarchiver = [[NSKeyedUnarchiver alloc]initForReadingWithData:data];
    //进行反序列化
    NSString * name = [unarchiver decodeObjectForKey:@"name"];
    int age = [unarchiver decodeIntForKey:@"age"];
    //打印信息
    NSLog(@"\nname:%@\nage:%d",name,age);

结果如下:

(3)进行自定义对象的归档

        上面介绍中有提到,原则上,任何遵守了NSCoding协议的类都可以进行归档操作,那么对于我们自定义的对象,我们该如何来做呢?

首先,我们新建一个类:

仿照上面的例子,我们写一个这样的类:

代码语言:javascript
复制
@interface MyObject : NSObject
@property(nonatomic,strong)NSString * name;
@property(nonatomic,assign)int age;
@end

对其进行归档:

代码语言:javascript
复制
    //进行归档
    MyObject * obj = [[MyObject alloc]init];
    obj.name = @"jaki";
    obj.age = 24;
    NSData * data =  [NSKeyedArchiver archivedDataWithRootObject:obj];
    //进行解档
    MyObject * obj2 = [NSKeyedUnarchiver unarchiveObjectWithData:data];
    NSLog(@"\nname:%@\nage:%d",obj2.name,obj2.age);

直接运行,程序会崩溃掉,打印如下:

可以看出,正是我们前边说过的,必须遵守归档协议的对象,才可以被归档,我们在MyObject类中实现如下两个方法:

代码语言:javascript
复制
//解档方法
- (instancetype)initWithCoder:(NSCoder *)coder
{
    if (self=[super init]) {
        _name = [coder decodeObjectForKey:@"name"];
        _age = [coder decodeIntForKey:@"age"];
    }
    return self;
}

//归档方法
- (void)encodeWithCoder:(NSCoder *)coder
{
    [coder encodeObject:_name forKey:@"name"];
    [coder encodeInt:_age forKey:@"age"];
}

添加了上面两个方法,我们自定义的对象就可以自由归档存取,并可以写入本地,非常cool吧。

三、设计可以归档存取的数据模型基类

1、动机与初衷

        通过上面对归档的介绍,我们可以发现归档一个十分有潜力的应用:可以自由存取自定义的数据对象。这个特性的优势是毫无疑问的,除了可以使我们的数据用起来更加方便,无需多次解析数据外,安全性也更好。但是也带来了一个缺陷,每个类都需要实现NSCoding中的两个方法是十分繁琐的,并且类越复杂,这个步骤越繁琐,如果在之后的修改和优化中类做了改变,相应的方法也要做改变,这将增加很大的工作量并且埋下潜在bug的风险。

        所以我们会想,能否设计一个这样的model基类,来使需要存储的model都继承于它,使我们的model不需要实现NSCoding方法的同时可以支持归档呢,通过runtime和OC语言特性的一些小技巧,我们是可以做到的。

2、基类模型的设计

        我们新建一个BaseModel类,核心方法如下:

代码语言:javascript
复制
//归档与解归档的方法
- (instancetype)initWithCoder:(NSCoder *)coder
{
    self = [super init];
    if (self) {
        //获取所有属性
        NSArray * porpertyArray = [self getAllPropertys];
        for (NSString * name in porpertyArray) {
            //去掉属性名前面的_
            NSString * key = [name substringFromIndex:1];
            //约定好的键值对 c+key
            [self setValue:[coder decodeObjectForKey:[NSString stringWithFormat:@"c%@",key]] forKey:key];
        }
    }
    return self;
}
- (void)encodeWithCoder:(NSCoder *)coder
{
    
    //获取所有属性
    NSArray * porpertyArray = [self getAllPropertys];
    for (NSString * name in porpertyArray) {
        //去掉属性名前面的_
        NSString * key = [name substringFromIndex:1];
        //约定好的键值对 c+key
        [coder encodeObject:[self valueForKey:key] forKey:[NSString stringWithFormat:@"c%@",key]];
    }
}
//获取model所有属性
-(NSArray *)getAllPropertys{
    NSMutableArray * array = [[NSMutableArray alloc]init];
    
    unsigned int * count = malloc(sizeof(unsigned int));
    //调用runtime的方法
    //Ivar:方法返回的对象内容对象,这里将返回一个Ivar类型的指针
    //class_copyIvarList方法可以捕获到类的所有变量,将变量的数量存在一个unsigned int的指针中
    Ivar * mem = class_copyIvarList([self class], count);
    //进行遍历
    for (int i=0; i< *count ; i++) {
        //通过移动指针进行遍历
        Ivar var = * (mem+i);
        //获取变量的名称
        const char * name = ivar_getName(var);
        NSString * str = [NSString stringWithCString:name encoding:NSUTF8StringEncoding];
        [array addObject:str];
    }
    //释放内存
    free(count);
    //注意处理野指针
    count=nil;
    return array;
}

通过这样的一个runtime机制,我们可以很方便的是新建的model继承于这个基类,无需其他处理直接支持归档,修改与优化都不受影响。

四、为志同道合的朋友分享

        这个model集成在了我的一个开源的开发框架中,当然,那里面也综合和许多许多这样方便开发者使用的功能,如果你感兴趣,可以在https://github.com/ZYHshao/YHBaseFoundationTest上面看到。如果你发现了一些bug或者可以添加或者优化的地方,请务必告知我,十分你感谢。QQ:316045346

专注技术,热爱生活,交流技术,也做朋友。 ——珲少 QQ群:203317592

本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
原始发表:2015/10/08 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • iOS数据持久化之二——归档与设计可存储化的数据模型基类
    • 一、引言
      • 二、先来精通归档吧
        • 1、归档的原理
        • 2、几种归档与解归档的应用
      • 三、设计可以归档存取的数据模型基类
        • 1、动机与初衷
        • 2、基类模型的设计
      • 四、为志同道合的朋友分享
      相关产品与服务
      容器服务
      腾讯云容器服务(Tencent Kubernetes Engine, TKE)基于原生 kubernetes 提供以容器为核心的、高度可扩展的高性能容器管理服务,覆盖 Serverless、边缘计算、分布式云等多种业务部署场景,业内首创单个集群兼容多种计算节点的容器资源管理模式。同时产品作为云原生 Finops 领先布道者,主导开源项目Crane,全面助力客户实现资源优化、成本控制。
      领券
      问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档