一行代码实现iOS序列化与反序列化(runtime)

一、变量声明

为便于下文讨论，提前创建父类Biology以及子类Person：

Biology:
<pre>@interface Biology : NSObject
{
NSInteger *_hairCountInBiology;
}
@property (nonatomic, copy) NSString *introInBiology;
@end

@implementation Biology
@end
</pre>

Person:
<pre>

import <Foundation/Foundation.h>

import "Biology.h"

import <objc/runtime.h>

@interface Person : Biology
{
NSString *_father;
}
@property (nonatomic, copy) NSString *name;
@property (nonatomic, assign) NSInteger age;
@end

@implementation Person

@end
</pre>

补充说明
凡是在父类中定义的属性或者变量，末尾都有InBiology标志；反之也成立

二、问题引入

在iOS中一个自定义对象是无法直接存入到文件中的，必须先转化成二进制流才行。从对象到二进制数据的过程我们一般称为对象的序列化(Serialization)，也称为归档(Archive)。同理，从二进制数据到对象的过程一般称为反序列化或者反归档。
在序列化实现中不可避免的需要实现NSCoding以及NSCopying(非必须)协议的以下方法：
<pre>

  • (id)initWithCoder:(NSCoder *)coder;
  • (void)encodeWithCoder:(NSCoder *)coder;
  • (id)copyWithZone:(NSZone *)zone;
    </pre>

假设我们现在需要对直接继承自NSObject的Person类进行序列化，代码一般长这样子：

<pre>
//对变量编码

  • (void)encodeWithCoder:(NSCoder *)coder
    {
    [coder encodeObject:self.name forKey:@"name"];
    [coder encodeObject:@(self.age) forKey:@"age"];
    [coder encodeObject:_father forKey:@"_father"];
    //... ... other instance variables
    }
    //对变量解码
  • (id)initWithCoder:(NSCoder *)coder
    {
    self.name = [coder decodeObjectForKey:@"name"];
    self.age = [[coder decodeObjectForKey:@"age"] integerValue];
    _father = [coder decodeObjectForKey:@"_father"];
    //... ... other instance variables
    </pre>

似乎so easy？至少到目前为止是这样的。但是请考虑以下问题：

若Person是个很大的类，有非常多的变量需要进行encode/decode处理呢？
若你的工程中有很多像Person的自定义类需要做序列化操作呢？
若Person不是直接继承自NSObject而是有多层的父类呢？(请注意，序列化的原则是所有层级的父类的属性变量也要需要序列化)；
如果采用开始的传统的序列化方式进行序列化，在碰到以上问题时容易暴露出以下缺陷(仅仅是缺陷，不能称为问题)：

工程代码中冗余代码很多
父类层级复杂容易导致遗漏点一些父类中的属性变量
那是不是有更优雅的方案来回避以上问题呢？那是必须的。这里我们将共同探讨使用runtime来实现一种接口简洁并且十分通用的iOS序列化与反序列方案。

三、runtime: iOS序列化与反序列化利器

3.1 总体思路

观察上面的initWithCoder代码我们可以发现，序列化与反序列化中最重要的环节是遍历类的变量，保证不能遗漏。
<pre>
这里需要特别注意的是:
编解码的范围不能仅仅是自身类的变量，还应当把除NSObject类外的所有层级父类的属性变量也进行编解码！
</pre>

由此可见，这几乎是个纯体力活。而runtime在遍历变量这件事情上能为我们提供什么帮助呢？我们可以通过runtime在运行时获取自身类的所有变量进行编解码；然后对父类进行递归，获取除NSObject外每个层级父类的属性(非私有变量)，进行编解码。

3.2 使用runtime获取变量以及属性

runtime中获取某类的所有变量(属性变量以及实例变量)API：
<pre>
Ivar *class_copyIvarList(Class cls, unsigned int *outCount)
</pre>

获取某类的所有属性变量API：
<pre>
objc_property_t *class_copyPropertyList(Class cls, unsigned int *outCount)
</pre>

runtime的所有开放API都放在objc/runtime.h里面。上面的一些数据类型有些同学可能没见过，这里我们先简单地介绍一下，更详细的介绍请自行查阅其他资料，强烈建议打开
Ivar是runtime对于变量的定义，本质是一个结构体：
<pre>
struct objc_ivar {
char *ivar_name;
char *ivar_type;
int ivar_offset;

ifdef LP64 

int space;

endif

}
typedef struct objc_ivar *Ivar;
</pre>

ivar_name:变量名，对于一个给定的Ivar，可以通过const char *ivar_getName(Ivar v)函数获得char *类型的变量名；

ivar_type: 变量类型，在runtime中变量类型用字符串表示，例如用@表示id类型，用i表示int类型...。这不在本文讨论之列。类似地，可以通过const char *ivar_getTypeEncoding(Ivar v)函数获得变量类型；

ivar_offset： 基地址偏移字节数，可以不用理会
获取所有变量的代码一般长这样子：
<pre>
unsigned int numIvars; //成员变量个数
Ivar *vars = class_copyIvarList(NSClassFromString(@"UIView"), &numIvars);
NSString *key=nil;
for(int i = 0; i < numIvars; i++) {
Ivar thisIvar = vars[i];
key = [NSString stringWithUTF8String:ivar_getName(thisIvar)]; //获取成员变量的名字
NSLog(@"variable name :%@", key);
key = [NSString stringWithUTF8String:ivar_getTypeEncoding(thisIvar)]; //获取成员变量的数据类型
NSLog(@"variable type :%@", key);
}
free(vars);//记得释放掉
</pre>

objc_property_t是runtime对于属性变量的定义，本质上也是一个结构体（事实上OC是对C的封装，大多数类型的本质都是C结构体）。在runtime.h头文件中只有typedef struct objc_property *objc_property_t，并没有更详细的结构体介绍。虽然runtime的源码是开源的，但这里并不打算深入介绍，这并不影响我们今天的主题。与Ivar的应用同理，获取类的属性变量的代码一般长这样子：
<pre>
unsigned int outCount, i;
objc_property_t *properties = class_copyPropertyList([self class], &outCount);
for (i = 0; i < outCount; i++) {
objc_property_t property = properties[i];
NSString *propertyName = [[[NSString alloc] initWithCString:property_getName(property)] ;
NSLog(@"property name:%@", propertyName);
}
free(properties);
</pre>

3.3 用runtime实现序列化与反序列化

有了前面两节的铺垫，到这里自然就水到渠成了。我们可以在initWithCoder:以及encoderWithCoder:中遍历类的所有变量，取得变量名作为KEY值，最后使用KVC强制取得或者赋值给对象。于是我们可以得到如下的自动序列化与发序列化代码，关键部分有注释：
<pre>
@implementation Person
//解码

  • (id)initWithCoder:(NSCoder *)coder
    {
    unsigned int iVarCount = 0;
    Ivar *iVarList = class_copyIvarList([self class], &iVarCount);//取得变量列表,[self class]表示对自身类进行操作
    for (int i = 0; i < iVarCount; i++) {
    Ivar var = *(iVarList + i);
    const char * varName = ivar_getName(var);//取得变量名字，将作为key
    NSString *key = [NSString stringWithUTF8String:varName];
    //decode
    id value = [coder decodeObjectForKey:key];//解码
    if (value) {
    [self setValue:value forKey:key];//使用KVC强制写入到对象中
    }
    }
    free(iVarList);//记得释放内存
    return self;
    }
    //编码
    • (void)encodeWithCoder:(NSCoder *)coder
      {
      unsigned int varCount = 0;
      Ivar *ivarList = class_copyIvarList([self class], &varCount);
      for (int i = 0; i < varCount; i++) {
      Ivar var = *(ivarList + i);
      const char *varName = ivar_getName(var);
      NSString *key = [NSString stringWithUTF8String:varName];
      id varValue = [self valueForKey:key];//使用KVC获取key对应的变量值
      if (varValue) {
      [coder encodeObject:varValue forKey:key];
      }
      }
      free(ivarList);
      }
      </pre>

3.4 优化

上面代码有个缺陷，在获取变量时都是指定当前类，也就是[self class]。当你的Model对象并不是直接继承自NSObject时容易遗漏掉父类的属性。请牢记3.1节我们提到的：

<pre>编解码的范围不能仅仅是自身类的变量，还应当把除NSObject类外的所有层级父类的属性变量也进行编解码！</pre>

因此在上面代码的基础上我们我们需要注意一下细节，设一个指针，先指向本身类，处理完指向SuperClass，处理完再指向SuperClass的SuperClass...。代码如下(这里仅以encodeWithCoder:为例，毕竟initWithCoder:同理)：

<pre>

  • (void)encodeWithCoder:(NSCoder )coder
    {
    Class cls = [self class];
    while (cls != [NSObject class]) {//对NSObject的变量不做处理
    unsigned int iVarCount = 0;
    Ivar ivarList = class_copyIvarList([cls class], &iVarCount);/变量列表，含属性以及私有变量    /
    for (int i = 0; i < iVarCount; i++) {
    const char varName = ivar_getName((ivarList + i));
    NSString key = [NSString stringWithUTF8String:varName];
    /    valueForKey只能获取本类所有变量以及所有层级父类的属性，不包含任何父类的私有变量(会崩溃)*/
    id varValue = [self valueForKey:key];
    if (varValue) {
    [coder encodeObject:varValue forKey:key];
    }
    }
    free(ivarList);
    cls = class_getSuperclass(cls); //指针指向当前类的父类
    }
    }
    </pre>

这样真的结束了吗？不是的。当你的跑上面的代码时程序有可能会crash掉，crash的地方在[self valueForKey:key]这一句上。原来是这里的KVC无法获取到父类的私有变量(即实例变量)。因此，在处理到父类时不能简单粗暴地使用class_copyIvarList，而只能取父类的属性变量。这时候3.2节部分的class_copyPropertyList就派上用场了。在处理父类时用后者代替前者。

<pre>
在最近的iOS中打印propertyList会发现有 superClass、description、debugDescription、hash等四个属性。
对这几个属性进行encode操作会导致crash。因此在encode前需要屏蔽掉这些key
</pre>

于是最终的代码(额~其实还不算最终)：
<pre>

  • (id)initWithCoder:(NSCoder )coder
    {
    NSLog(@"%s",func);
    Class cls = [self class];
    while (cls != [NSObject class]) {
    /    判断是自身类还是父类/
    BOOL bIsSelfClass = (cls == [self class]);
    unsigned int iVarCount = 0;
    unsigned int propVarCount = 0;
    unsigned int sharedVarCount = 0;
    Ivar ivarList = bIsSelfClass ? class_copyIvarList([cls class], &iVarCount) : NULL;/变量列表，含属性以及私有变量    /
    objc_property_t propList = bIsSelfClass ? NULL : class_copyPropertyList(cls, &propVarCount);/属性列表*/
    sharedVarCount = bIsSelfClass ? iVarCount : propVarCount;

      for (int i = 0; i < sharedVarCount; i++) {  
      const char *varName = bIsSelfClass ? ivar_getName(*(ivarList + i)) : property_getName(*(propList + i)); 
      NSString *key = [NSString stringWithUTF8String:varName];   
      id varValue = [coder decodeObjectForKey:key]; 
      NSArray *filters = @[@"superclass", @"description", @"debugDescription", @"hash"];   
      if (varValue && [filters containsObject:key] == NO) { 
          [self setValue:varValue forKey:key];    
      }   
  }   
  free(ivarList); 
  free(propList); 
  cls = class_getSuperclass(cls);

    }
    return self;
    }

  • (void)encodeWithCoder:(NSCoder )coder
    {
    NSLog(@"%s",func);
    Class cls = [self class];
    while (cls != [NSObject class]) {
    /    判断是自身类还是父类/
    BOOL bIsSelfClass = (cls == [self class]);
    unsigned int iVarCount = 0;
    unsigned int propVarCount = 0;
    unsigned int sharedVarCount = 0;
    Ivar ivarList = bIsSelfClass ? class_copyIvarList([cls class], &iVarCount) : NULL;/变量列表，含属性以及私有变量    /
    objc_property_t propList = bIsSelfClass ? NULL : class_copyPropertyList(cls, &propVarCount);/属性列表*/
    sharedVarCount = bIsSelfClass ? iVarCount : propVarCount;

      for (int i = 0; i < sharedVarCount; i++) {  
      const char *varName = bIsSelfClass ? ivar_getName(*(ivarList + i)) : property_getName(*(propList + i)); 
      NSString *key = [NSString stringWithUTF8String:varName];    
      /*valueForKey只能获取本类所有变量以及所有层级父类的属性，不包含任何父类的私有变量(会崩溃)*/  
      id varValue = [self valueForKey:key];
      NSArray *filters = @[@"superclass", @"description", @"debugDescription", @"hash"];    
      if (varValue && [filters containsObject:key] == NO) { 
          [coder encodeObject:varValue forKey:key];   
      }   
  }   
  free(ivarList); 
  free(propList); 
  cls = class_getSuperclass(cls);

    }
    }
    </pre>

3.5 最终的封装

在逻辑上，上面的代码应该是目前为止比较完美的自动序列化与反序列解决方案了。即使某个类的继承深度极其深，变量极其多，序列化的代码也就以上这些。但是我们回到文章第二节提出的几点场景假设，其中有一点提到：
<pre>若你的工程中有很多像Person的自定义类需要做序列化操作呢？</pre>

如果是在以上场景下，每个Model类都需要写一次上面的代码。这在一定程度上也造成冗余了。同时，你也会觉得这篇文章的标题就是瞎扯淡，根本就不是一行代码的事。上面的代码冗余，我这种对代码有很强洁癖的程序旺是万万接受不了的。那就再封装一层！这里我采用宏的方式将上述代码浓缩成一行，放到一个叫WZLSerializeKit.h的头文件中：

<pre>

define WZLSERIALIZE_CODER_DECODER() \

\

  • (id)initWithCoder:(NSCoder )coder
    {
    NSLog(@"%s",func);
    Class cls = [self class];
    while (cls != [NSObject class]) {
    /    判断是自身类还是父类/
    BOOL bIsSelfClass = (cls == [self class]);
    unsigned int iVarCount = 0;
    unsigned int propVarCount = 0;
    unsigned int sharedVarCount = 0;
    Ivar ivarList = bIsSelfClass ? class_copyIvarList([cls class], &iVarCount) : NULL;/变量列表，含属性以及私有变量    /
    objc_property_t propList = bIsSelfClass ? NULL : class_copyPropertyList(cls, &propVarCount);/属性列表/
    sharedVarCount = bIsSelfClass ? iVarCount : propVarCount;

    for (int i = 0; i < sharedVarCount; i++) {
    const char varName = bIsSelfClass ? ivar_getName((ivarList + i)) : property_getName(    (propList + i));
    NSString *key = [NSString stringWithUTF8String:varName];
    id varValue = [coder decodeObjectForKey:key];
    NSArray *filters = @[@"superclass", @"description", @"debugDescription", @"hash"];
    if (varValue && [filters containsObject:key] == NO) {
    [self setValue:varValue forKey:key];
    }
    }
    free(ivarList);
    free(propList);
    cls = class_getSuperclass(cls);
    }
    return self;
    }
    \
  • (void)encodeWithCoder:(NSCoder )coder
    {
    NSLog(@"%s",func);
    Class cls = [self class];
    while (cls != [NSObject class]) {
    /    判断是自身类还是父类/
    BOOL bIsSelfClass = (cls == [self class]);
    unsigned int iVarCount = 0;
    unsigned int propVarCount = 0;
    unsigned int sharedVarCount = 0;
    Ivar ivarList = bIsSelfClass ? class_copyIvarList([cls class], &iVarCount) : NULL;/变量列表，含属性以及私有变量    /
    objc_property_t propList = bIsSelfClass ? NULL : class_copyPropertyList(cls, &propVarCount);/属性列表/
    sharedVarCount = bIsSelfClass ? iVarCount : propVarCount;

    for (int i = 0; i < sharedVarCount; i++) {
    const char varName = bIsSelfClass ? ivar_getName((ivarList + i)) : property_getName(    (propList + i));
    NSString key = [NSString stringWithUTF8String:varName];
    /    valueForKey只能获取本类所有变量以及所有层级父类的属性，不包含任何父类的私有变量(会崩溃)*/
    id varValue = [self valueForKey:key];
    NSArray *filters = @[@"superclass", @"description", @"debugDescription", @"hash"];
    if (varValue && [filters containsObject:key] == NO) {
    [coder encodeObject:varValue forKey:key];
    }
    }
    free(ivarList);
    free(propList);
    cls = class_getSuperclass(cls);
    }
    }
    </pre>

之后需要序列化的地方只要两步：1、import "WZLSerializeKit.h" 2、调用WZLSERIALIZE_CODER_DECODER();
即可。两个字：清爽。此外，copyWithZone
中同样可以用相同的原理对变量进行自动化copy。同样地，我们也可以用一个宏封装掉copyWithZone
方法。这里就不再赘述。值得一提的是，以上代码作者已经放到Github中，并且提供了CocoaPods支持。使用的时候只需要pod WZLSerializeKit。点 此处 跳转到Github.

本文是 [编程小翁] 原创
地址：http://www.jianshu.com/p/fed1dcb1ac9f

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,547评论 6赞 477
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,399评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,428评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,599评论 1赞 274
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,612评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,577评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,941评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,603评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,852评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,375评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,955评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2赞 342

推荐阅读更多精彩内容