美文网首页
什么是归档? 反归档?

什么是归档? 反归档?

作者: flyrees | 来源:发表于2017-11-03 13:51 被阅读0次

    把 OC 中基本数据存储到沙盒中,被称为基本数据持久化。 基本数据,在 oc中有以下四种,分别为 NSString 、 NSArray 、 NSDictionary 、 NSData。

    字符串、 数组、 字典 和 数据 这四种类型,系统提供了 writeToFile: 直接写入文件的方法, 因此可以直接存储数据到沙盒中。

    而对于 OC 中非基本数据类型,比如: UIImage 、 自定义类型Person 等,系统并没有提供 直接写入文件的方法。 这就需要我们把 非基本数据类型 转化为 NSData ,然后再存入到沙盒中。
    把 复杂类型 通过 编码方式 转化为 data 型数据的过程称为,归档。
    把 已编码的data 型数据, 通过解码方式转化为 原有复杂类型 的过程称为,反归档。

    归档的步骤

    1. 复杂类型 遵守 NSCoding 协议, 实现协议里,编码 和 解码 方法。

    归档 其实 是一个编码过程,把复杂对象通过编码转化为data型数据。
    反归档 其实是一个解码过程, 把已归档的data型数据通过解码重新生成 复杂对象。
    因此, 复杂对象归档反归档的前提是遵守 NSCoding 协议,并且实现 编码,解码方法。
    比如: Person 类 ,遵守 NSCoding 协议

     #import <Foundation/Foundation.h>
     #import <UIKit/UIKit.h>*
    

    // 归档的前提:被归档的对象需要遵守编码协议,并实现相应方法
    @interface Person : NSObject <NSCoding>

    @property (nonatomic,assign) NSInteger age; // 年龄integer类型
    @property (nonatomic,copy) NSString *name; // 姓名,oc对象类型
    @property (nonatomic,strong) UIImage *image; // 图片,UIImage类型

    @end

    Person 类,实现 NSCoding 协议方法。
    编码方法,归档时触发。

    • (void)encodeWithCoder:(NSCoder *)aCoder
      解码方法,反归档时触发。

    • (nullable instancetype)initWithCoder:(NSCoder *)aDecoder
      // 归档的过程是一个编码的过程,对象内部属性需要进行编码

    • (void)encodeWithCoder:(NSCoder *)aCoder
      {

      // 注意1:编码时,需要注意,不同类型的实例变量,使用不同的编码方式
      // person 中 age 为integer 类型, name 为 nsstring 类型,image 为 UIImage类型
      // 注意2:编码时,需要在编码时加上标记;编码 data型数据时,不需要加标记。

      [aCoder encodeInteger:_age forKey:@"age"]; // 类型:integer 标记:age
      [aCoder encodeObject:_name forKey:@"name"]; // 类型:nsstring 标记:name
      [aCoder encodeDataObject:UIImagePNGRepresentation(_image)]; // 类型:data 标记:不需要
      }
      // 反归档,是一个解码过程。解码过程,是一个重新创建对象的过程,因此,解码方法是一个初始化方法。 init开头

    • (nullable instancetype)initWithCoder:(NSCoder *)aDecoder
      {
      self = [super init];
      if (self) {
      // 解码,给内部对象赋值, 选择对应类型的解码方法 和 标记解码。
      self.age = [aDecoder decodeIntegerForKey:@"age"];
      self.name = [aDecoder decodeObjectForKey:@"name"];
      self.image = [UIImage imageWithData:[aDecoder decodeDataObject]];
      }
      return self;
      }

    2. 归档
    // 归档 , 归档是把 复杂对象转化为一个mutableData 的过程,转化完毕后,把mutaleData 写入到文件

    // 1. 创建可变数据
    NSMutableData *data1 = [NSMutableData data];
    
    // 2. 创建一个归档对象 NSKeyedArchiver
    NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:data1];
    
    // 3. 归档
    [archiver encodeObject:person1 forKey:@"p1"];
    
    // 4. 归档完成
    [archiver finishEncoding];
    
    // 5. 把归档完成的数据写入到沙盒
    NSString *dataPath = [NSHomeDirectory() stringByAppendingPathComponent:@"data1"];
    
    [data1 writeToFile:dataPath atomically:YES];
    

    我们来归纳一下,如果要对一个复杂对象进行归档。首先,复杂对象要遵守 NSCoding 协议,并实现协议里的 编码方法 和 解码方法。然后 归档。
    我们来思考一个问题,如果一个类中有 100 个属性,怎么实现 编码 和 解码方法? 如果让每个属性都 encode decode, 那么你至少要写 200 行代码!
    我们可以再思考一个问题,现在一个类中有 100 个属性, 我现在的 应用程序中,需要用到 10个类,这十个类都需要归档。如何实现 编码 和 解码方法?
    如果还让每个类中每个属性都 encode decode ,那么你至少要写 10 * 100 = 1000 行代码。
    这显然是不现实的。

    NSCoding

    我们在 NSCoding 的协议方法里面做的操作如下:

    编码方法 - (void)encodeWithCoder:(NSCoder *)aCoder ,里面做的操作

    • 根据 属性类型,对属性进行编码。

    • 加上编码 标记,(秉着 见名知意的原则 标记值与属性名一样)。

    • (nullable instancetype)initWithCoder:(NSCoder *)aDecoder 解码方法里面做的操作

    • 根据 属性类型 以及 编码时加的 标记, 进行解码。

    • 解码完成后,给 属性赋值(可以使用 kvc 赋值方法)。

    因此如果我们:

    • 获取到每个属性类型,就可以 根据类型对属性进行编码。

    • 获取到每个属性名, 就可以在编码的时候添加 标记。

    • 有了标记 和 属性类型,就可以正确的解码。

    objc/runtime 实现归档反归档
    我们需要用到 动态运行时类库中的以下几种类型、函数 来获取 属性名,属性类型。

    类型 实例变量 Ivar

    表示类中的实例变量的一种类型。原类型为 struct objc_ivar *。

    //An opaque type that represents an instance variable.
    typedef struct objc_ivar *Ivar;

    struct objc_ivar {
    char *ivar_name OBJC2_UNAVAILABLE;
    char *ivar_type OBJC2_UNAVAILABLE;
    int ivar_offset OBJC2_UNAVAILABLE;

    ifdef LP64

    int space                                                          OBJC2_UNAVAILABLE;
    

    endif

    } OBJC2_UNAVAILABLE;

    实例变量指针 Ivar
    表示 Ivar 类型指针,我们通常用来声明 Ivar 类型数组。
    比如:
    用来存储 类中所有实例变量的数组 varArray。

    Ivar *varArray = class_copyIvarList([self class], &count);

    **函数**
    

    获取本类中所有实例变量函数 class_copyIvarList

    Ivar * class_copyIvarList(Class cls, unsigned int *outCount)
    获取一个数组 Ivar *, 该数组中含有本类中所有的实例变量,但并不会获取父类中声明的实例变量。 当不使用的时候 使用 free() 释放该数组。

    获取实例变量名 ivar_getName

    const char * ivar_getTypeEncoding( Ivar ivar)
    返回一个 实例变量的名称, 为 C 字符串。

    获取实例变量类型 ivar_getTypeEncoding

    const char * ivar_getTypeEncoding( Ivar ivar)
    获取实例变量的 编码类型, 为 C 字符串。

    下面我们按照上面归档反归档的分析出来的思路,使用 runtime 中函数,写一个通用的 NSObject 归档反归档分类。

    创建一个NSObject 的分类 NSObject+AGCoding
    .h 文件

    import <Foundation/Foundation.h>
    

    @interface NSObject (AGCoding) <NSCoding> // 遵守编码协议

    @end

    .m 文件

     #import "NSObject+AGCoding.h"
    
     #import <objc/runtime.h> 
    
     #import <UIKit/UIKit.h>
    

    /*
    成员变量类型
    获取 实例变量的类型 方法
    NSLog(@"%s", ivar_getTypeEncoding(array[i]));
    */
    static NSString *intType = @"i"; // int
    static NSString *integerType = @"q"; // long
    static NSString *floatType = @"f"; // float
    static NSString *doubleType = @"d"; // double
    static NSString *boolType = @"B"; // bool
    static NSString *imageType = @"UIImage"; // UIImage 类型
    static NSString *stringType = @"NSString"; // NSString 类型

    // 定义属性字典,用来存储 属性名(key) 类型(value)
    // 比如: age q
    static NSMutableDictionary *proDic = nil;

    @implementation NSObject (AGCoding)

    // 归档是一个编码的过程

    • (void)encodeWithCoder:(NSCoder *)aCoder
      {
      // (1). 给字典分配空间
      proDic = [NSMutableDictionary dictionary];

      // (2). 获取类中所有实例变量
      unsigned int count; // 属性个数
      // 定义Ivar, copy
      Ivar *varArray = class_copyIvarList([self class], &count);

      // (3). for循环,获取属性名称 属性类型
      for (int i = 0; i < count; i++) {

        Ivar var = varArray[i];
      
        // 1. 获取属性名称 : age,name,image
        const char *cName = ivar_getName(var); // 属性名c字符串
        NSString *proName = [[NSString stringWithUTF8String:cName] substringFromIndex:1]; // OC字符串,并且去掉下划线 _
      
        // 2. 获取属性类型 : NSInteger NSString  UIImage 等类型
        const char *cType = ivar_getTypeEncoding(var); // 获取变量类型, c 字符串
      
        // 3. kvc 取值, 用于 (5) 中判断是否为 object 类型
        id value = [self valueForKey:proName];
      
        // 4. 把属性类型 从 c 转化为 oc 字符串
        // c 字符串 转化为 oc 字符串,会加上 @""
        // 属性类型
        NSString *proType = [NSString stringWithUTF8String:cType]; // oc 字符串
      
        // 5. 如果是OC类型数据,且不属于 NSNumber类,把 @"" 去掉
        if ([value isKindOfClass:[NSObject class]] && ![value isKindOfClass:[NSNumber class]]) {
      
            // 截取前: @"@\"NSString\""
            // 截取后: @\"NSString\"
            NSUInteger length = proType.length;
            proType = [proType substringWithRange:NSMakeRange(2, length - 3)];
      
        }
      
        // (4). proDic字典赋值 : 属性名(key)_属性类型(value)
        if (![proName isEqualToString:@"proDic"]) {
      
            [proDic setValue:proType forKey:proName];
            
        }
      
        // (5). 根据类型进行编码
        if ([proType isEqualToString:integerType]) {
        
            // integer 类型
            [aCoder encodeInteger:[value integerValue] forKey:proName];
            
        } else if ([proType isEqualToString:imageType]) {
            // image 类型
            [aCoder encodeDataObject:UIImagePNGRepresentation( value)];
            
        } else if ([proType isEqualToString:stringType]) {
      
            // string 类型
            [aCoder encodeObject:value forKey:proName];
        }
        // 若再有类型添加即可
      

      }
      // for 循环,获取结束
      // 释放varArray
      free(varArray);
      }

    // 反归档,是一个解码的过程。

    • (instancetype)initWithCoder:(NSCoder *)aDecoder
      {
      self = [self init];

      if (self) {

        // 注意:解档时重新给 proDic赋值
        [self setProDic];
      
        //  解码,给 属性赋值
        // 注意: 根据属性类型解码,根据属性名 kvc 赋值
        
        // (1) 获取 字典中的属性名
        for (NSString *proName in proDic) {
      
            // (2) 获取 属性类型
            NSString *proType = proDic[proName];
      
            // (3) 解码,kvc 赋值
            if ([proType isEqualToString:integerType]) { 
      
                // integer 类型
                // 解码
                NSInteger number = [aDecoder decodeIntegerForKey:proName];
                // 赋值
                [self setValue:@(number) forKey:proName];
      
            } else if ([proType isEqualToString:imageType]) {
            
                // image 类型
                UIImage *image = [UIImage imageWithData:[aDecoder decodeDataObject]];
                [self setValue:image forKey:proName];
      
            } else if ([proType isEqualToString:stringType]) { 
            
                // string 类型
                NSString *string = [aDecoder decodeObjectForKey:proName];
                [self setValue:string forKey:proName];
      
            }
            // 若再有类型添加即可
        } 
        // for 循环结束
      

      }
      return self;
      }

    // 解码时重新给当前类的proDic赋值

    • (void)setProDic
      {
      // (1). 给字典分配空间
      proDic = [NSMutableDictionary dictionary];

      // (2). 获取类中所有实例变量
      unsigned int count; // 属性个数
      // 定义Ivar, copy
      Ivar *varArray = class_copyIvarList([self class], &count);

      // (3). for循环,获取属性名称 属性类型
      for (int i = 0; i < count; i++) {

        Ivar var = varArray[i];
      
        // 1. 获取属性名称 : age      name       image
        const char *cName = ivar_getName(var); // 属性名c字符串
        NSString *proName = [[NSString stringWithUTF8String:cName] substringFromIndex:1]; // OC字符串,并且去掉下划线 _
      
        // 2. 获取属性类型 : NSInteger NSString  UIImage 等类型
        const char *cType = ivar_getTypeEncoding(var); // 获取变量类型, c 字符串
      
        // 3. 把属性类型 从 c 转化为 oc 字符串
        // c 字符串 转化为 oc 字符串,会加上 @""
        // 属性类型
        NSString *proType = [NSString stringWithUTF8String:cType]; // oc 字符串
      
        // 获取 @ 的个数
        NSArray *array = [proType componentsSeparatedByString:@"@"];
      
        // 4. 如果属性字符串中,多了 @"" 把 @"" 去掉
        if (array.count >= 2) {
      
            // 截取前: @"@\"NSString\""
            // 截取后: @\"NSString\"
            NSUInteger length = proType.length;
            proType = [proType substringWithRange:NSMakeRange(2, length - 3)];
      
        }
        
        // (4). proDic字典赋值 : 属性名(key)_属性类型(value)
        if (![proName isEqualToString:@"proDic"]) {
        
            [proDic setValue:proType forKey:proName];
            
        }
      

      }
      // for 循环,获取结束
      // 释放varArray
      free(varArray);
      }

    @end

    相关文章

      网友评论

          本文标题:什么是归档? 反归档?

          本文链接:https://www.haomeiwen.com/subject/qsdtmxtx.html