AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

【原】iOS动态性(四)：一行代码实现iOS序列化与反序列化(runtime)

2017-11-09 1363
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：

一、变量声明

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

Biology:

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

@implementation Biology
@end

Person:

#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

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

二、问题引入

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

- (id)initWithCoder:(NSCoder *)coder;
- (void)encodeWithCoder:(NSCoder *)coder;
- (id)copyWithZone:(NSZone *)zone;

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

//对变量编码
- (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

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

  • 若Person是个很大的类，有非常多的变量需要进行encode/decode处理呢？
  • 若你的工程中有很多像Person的自定义类需要做序列化操作呢？
  • 若Person不是直接继承自NSObject而是有多层的父类呢？(请注意，序列化的原则是所有层级的父类的属性变量也要需要序列化)；

如果采用开始的传统的序列化方式进行序列化，在碰到以上问题时容易暴露出以下缺陷(仅仅是缺陷，不能称为问题)：

  • 工程代码中冗余代码很多
  • 父类层级复杂容易导致遗漏点一些父类中的属性变量

那是不是有更优雅的方案来回避以上问题呢？那是必须的。这里我们将共同探讨使用runtime来实现一种接口简洁并且十分通用的iOS序列化与反序列方案。

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

3.1 总体思路

观察上面的initWithCoder代码我们可以发现，序列化与反序列化中最重要的环节是遍历类的变量，保证不能遗漏。

这里需要特别注意的是:
编解码的范围不能仅仅是自身类的变量，还应当把除NSObject类外的所有层级父类的属性变量也进行编解码！

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

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

runtime中获取某类的所有变量(属性变量以及实例变量)API：

Ivar *class_copyIvarList(Class cls, unsigned int *outCount)

获取某类的所有属性变量API：

objc_property_t *class_copyPropertyList(Class cls, unsigned int *outCount)

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

struct objc_ivar {
    char *ivar_name;                                   
    char *ivar_type;                                    
    int ivar_offset;
#ifdef __LP64__
    int space;
#endif
} 
typedef struct objc_ivar *Ivar;
  • ivar_name:变量名，对于一个给定的Ivar，可以通过const char *ivar_getName(Ivar v) 函数获得char *类型的变量名；
  • ivar_type: 变量类型，在runtime中变量类型用字符串表示，例如用@表示id类型，用i表示int类型...。这不在本文讨论之列。类似地，可以通过const char *ivar_getTypeEncoding(Ivar v) 函数获得变量类型；

  • ivar_offset： 基地址偏移字节数，可以不用理会
    获取所有变量的代码一般长这样子：

    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);//记得释放掉

    objc_property_t是runtime对于属性变量的定义，本质上也是一个结构体（事实上OC是对C的封装，大多数类型的本质都是C结构体）。在runtime.h头文件中只有typedef struct objc_property *objc_property_t，并没有更详细的结构体介绍。虽然runtime的源码是开源的，但这里并不打算深入介绍，这并不影响我们今天的主题。与Ivar的应用同理，获取类的属性变量的代码一般长这样子：

    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);

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

    有了前面两节的铺垫，到这里自然就水到渠成了。我们可以在initWithCoder:以及encoderWithCoder:中遍历类的所有变量，取得变量名作为KEY值，最后使用KVC强制取得或者赋值给对象。于是我们可以得到如下的自动序列化与发序列化代码，关键部分有注释：
    ```
    @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);
      }
      ``###3.4 优化 上面代码有个缺陷，在获取变量时都是指定当前类，也就是[self class]`。当你的Model对象并不是直接继承自NSObject时容易遗漏掉父类的属性。请牢记3.1节我们提到的：

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

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

- (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); //指针指向当前类的父类
    }   
}

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

- (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];   
            if (varValue) { 
                [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];   
            if (varValue) { 
                [coder encodeObject:varValue forKey:key];   
            }   
        }   
        free(ivarList); 
        free(propList); 
        cls = class_getSuperclass(cls); 
    }   
}

3.5 最终的封装

在逻辑上，上面的代码应该是目前为止比较完美的自动序列化与反序列解决方案了。即使某个类的继承深度极其深，变量极其多，序列化的代码也就以上这些。但是我们回到文章第二节提出的几点场景假设，其中有一点提到：

若你的工程中有很多像Person的自定义类需要做序列化操作呢？

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

#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];   \
            if (varValue) { \
                [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];   \
            if (varValue) { \
                [coder encodeObject:varValue forKey:key];   \
            }   \
        }   \
        free(ivarList); \
        free(propList); \
        cls = class_getSuperclass(cls); \
    }   \
}

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

本文转自编程小翁博客园博客，原文链接：http://www.cnblogs.com/wengzilin/p/5003545.html，如需转载请自行联系原作者

文章标签：
iOS开发
编解码
API
关键词：
序列化反序列化
iOS代码
iOS序列化
序列化ios
iOS runtime
文艺小青年
目录
相关文章
小王老师呀
|
1月前
|
JSON 数据格式 索引
Python中序列化/反序列化JSON格式的数据
【11月更文挑战第4天】本文介绍了 Python 中使用 `json` 模块进行序列化和反序列化的操作。序列化是指将 Python 对象（如字典、列表）转换为 JSON 字符串，主要使用 `json.dumps` 方法。示例包括基本的字典和列表序列化，以及自定义类的序列化。反序列化则是将 JSON 字符串转换回 Python 对象，使用 `json.loads` 方法。文中还提供了具体的代码示例，展示了如何处理不同类型的 Python 对象。
小王老师呀
31 1
游客moiomvrp3vyac2
|
1月前
|
存储 安全 Java
Java编程中的对象序列化与反序列化
【10月更文挑战第22天】在Java的世界里，对象序列化和反序列化是数据持久化和网络传输的关键技术。本文将带你了解如何在Java中实现对象的序列化与反序列化，并探讨其背后的原理。通过实际代码示例，我们将一步步展示如何将复杂数据结构转换为字节流，以及如何将这些字节流还原为Java对象。文章还将讨论在使用序列化时应注意的安全性问题，以确保你的应用程序既高效又安全。
游客moiomvrp3vyac2
31 4
历年考试不作弊
|
2月前
|
存储 Java
Java编程中的对象序列化与反序列化
【10月更文挑战第9天】在Java的世界里，对象序列化是连接数据持久化与网络通信的桥梁。本文将深入探讨Java对象序列化的机制、实践方法及反序列化过程，通过代码示例揭示其背后的原理。从基础概念到高级应用，我们将一步步揭开序列化技术的神秘面纱，让读者能够掌握这一强大工具，以应对数据存储和传输的挑战。
历年考试不作弊
40 1
历年考试不作弊
|
2月前
|
存储 安全 Java
Java编程中的对象序列化与反序列化
【10月更文挑战第3天】在Java编程的世界里，对象序列化与反序列化是实现数据持久化和网络传输的关键技术。本文将深入探讨Java序列化的原理、应用场景以及如何通过代码示例实现对象的序列化与反序列化过程。从基础概念到实践操作，我们将一步步揭示这一技术的魅力所在。
历年考试不作弊
55 4
武子康
|
2月前
|
消息中间件 存储 Java
大数据-58 Kafka 高级特性 消息发送02-自定义序列化器、自定义分区器 Java代码实现
大数据-58 Kafka 高级特性 消息发送02-自定义序列化器、自定义分区器 Java代码实现
武子康
60 3
武子康
|
2月前
|
分布式计算 资源调度 Hadoop
Hadoop-10-HDFS集群 Java实现MapReduce WordCount计算 Hadoop序列化 编写Mapper和Reducer和Driver 附带POM 详细代码 图文等内容
Hadoop-10-HDFS集群 Java实现MapReduce WordCount计算 Hadoop序列化 编写Mapper和Reducer和Driver 附带POM 详细代码 图文等内容
武子康
119 3
软件求生
|
1月前
|
存储 缓存 NoSQL
一篇搞懂！Java对象序列化与反序列化的底层逻辑
本文介绍了Java中的序列化与反序列化，包括基本概念、应用场景、实现方式及注意事项。序列化是将对象转换为字节流，便于存储和传输；反序列化则是将字节流还原为对象。文中详细讲解了实现序列化的步骤，以及常见的反序列化失败原因和最佳实践。通过实例和代码示例，帮助读者更好地理解和应用这一重要技术。
软件求生
48 0
古明地盆
|
3月前
|
JSON 安全 编译器
扩展类实例的序列化和反序列化
扩展类实例的序列化和反序列化
古明地盆
45 1
buguge
|
3月前
|
JSON fastjson Java
niubility！即使JavaBean没有默认无参构造器，fastjson也可以反序列化。- - - - 阿里Fastjson反序列化源码分析
本文详细分析了 Fastjson 反序列化对象的源码（版本 fastjson-1.2.60），揭示了即使 JavaBean 沲有默认无参构造器，Fastjson 仍能正常反序列化的技术内幕。文章通过案例展示了 Fastjson 在不同构造器情况下的行为，并深入探讨了 `ParserConfig#getDeserializer` 方法的核心逻辑。此外，还介绍了 ASM 字节码技术的应用及其在反序列化过程中的角色。
buguge
98 10
bruce_xiaowei
|
3月前
|
存储 XML JSON
用示例说明序列化和反序列化
用示例说明序列化和反序列化
bruce_xiaowei
26 1