iOS - 数据的归档和反归档

Love The Way You Lie 2023-01-23 03:53 212阅读 0赞

# 前言 #

由于机缘巧合，有了对 iOS 基础知识查漏补缺的机会，为了建立更加完善的 iOS 开发知识体系，这里将会更新一段时间的基础知识相关的文章。本篇文章主要介绍利用 `NSKeyedArchiver` 和 `NSKeyedUnarchiver` 对数据进行归档和反归档的操作。

### 文章目录 ###

*  前言
 *  1. 基本认知
 *   *  1.1 归档
     *  1.2 反归档
     *  1.3 归档的应用场景
 *  2. 归档与反归档的具体操作
 *   *  2.1 对 Foundation 对象进行归档
     *   *  归档操作
         *  反归档操作
         *  应用实例
     *  2.2 对自定类型对象进行归档
     *   *  利用 Runtime 优化
     *  2.3 对多种类型的对象进行归档
 *  3. 解决方法已被弃用问题
 *   *  3.1 旧方法被弃用的原因
     *  3.2 新方法的使用
 *  参考资料

# 1. 基本认知 #

## 1.1 归档 ##

归档是指对需要存储的对象数据进行编码，然后以文件的形式存储到沙盒的 Documents 目录下，实现数据的持久化存储。**归档的数据是经过加密的，打开沙盒中归档的文件，看到的内容会是乱码**，因此具有一定的可靠性。

## 1.2 反归档 ##

反归档是归档的逆过程，是指读取沙盒中经过归档的文件，经过解码后重新转化为对象数据，提供给程序使用。

## 1.3 归档的应用场景 ##

*  用于数据的离线缓存，在手机网络正常的时候，通过归档缓存一些数据。等到手机断网的时候，用这些归档数据进行展示。
 *  进行持久化存储，可以存出用户的一些搜索记录之类的一些数据。

# 2. 归档与反归档的具体操作 #

## 2.1 对 Foundation 对象进行归档 ##

### 归档操作 ###

归档操作需要用上 `NSKeyedArchiver` 类提供的类方法：

/** * 对对象进行归档操作 * * @param rootObject 需要进行归档的对象 * @param path 在沙盒中的存储路径 * @return 归档操作是否成功 */
    + (BOOL)archiveRootObject:(id)rootObject toFile:(NSString *)path;

PS：被归档的对象需要遵循 `NSCoding` 协议，Foundation 框架中的常用类都满足这个前提，如 NSString、NSArray、NSDictionary等。

### 反归档操作 ###

反归档操作则需要用上 `NSKeyedUnarchiver` 类提供的类方法：

/** * 对对象进行反归档操作 * * @param path 在沙盒中的存储路径 * @return 反归档获取到的对象 */
    + (nullable id)unarchiveObjectWithFile:(NSString *)path;

### 应用实例 ###

这里可以看一个简单的例子，我们创建一个数组对象，然后将该对象归档到沙盒的 Documents 目录下，文件命名为 arr.archiver。

NSArray *arr = @[@"Kobe", @"James", @"Iverson", @"Curry"];
    // 在沙盒中获取 Documents 路径
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
    // 归档对象的最终存储位置
    NSString *arrPath = [docPath stringByAppendingPathComponent:@"arr.archiver"]; // 后缀名可随意填写
     
    BOOL isSussess = [NSKeyedArchiver archiveRootObject:arr toFile:arrPath];
    NSLog(@"%d", isSussess ? @"Sussess" : @"Fail");

在需要用到归档数据的时候，我们将文件 arr.archiver 进行反归档，还原成数组对象，并将其输出。

NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
    NSString *arrPath = [docPath stringByAppendingPathComponent:@"arr.archiver"];
    
    // 通过反归档获取到在沙盒中存储的对象信息
    NSArray *arr = [NSKeyedUnarchiver unarchiveObjectWithFile:arrPath];
    // 遍历获取到的数组，验证结果
    [arr enumerateObjectsUsingBlock:^(NSString * _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) { 
    	NSLog(@"%lu - %@", idx, obj);
    }];

## 2.2 对自定类型对象进行归档 ##

要想对自定义类型对象进行归档，其实流程和上面一样，但是需要让自定义的类遵循 `NSCoding` 协议。

// 让自定义的类遵循 NSCoding 协议
    @interface VGPerson : NSObject <NSCoding>
    
    @property (nonatomic, assign) NSInteger age;
    @property (nonatomic, copy) NSString *name;
    
    @end

在 .m 文件中，实现 `NSCoding` 协议中所要求的两个方法。

@implementation VGPerson
    
    - (nullable instancetype)initWithCoder:(NSCoder *)coder { 
        if (self = [super init]) { 
            self.age = [coder decodeIntegerForKey:@"age"];
            self.name = [coder decodeObjectForKey:@"name"];
        }
        return self;
    }
    
    - (void)encodeWithCoder:(NSCoder *)coder { 
        [coder encodeInteger:self.age forKey:@"age"];
        [coder encodeObject:self.name forKey:@"name"];
    }
    
    @end

在完成些操作之后，我们就可以对自定义对象进行归档了，**操作和上面提到的 Foundation 框架对象的归档操作一样**。

显然，我们不难理解，Foundation 框架对象之所以可以直接进行归档，是因为系统已经帮我们实现了了 `NSCoding` 协议，可以看下下面 `NSString` 的类声明。

// 系统实现了 NSSecureCoding 协议，它继承自 NSCoding
    @interface NSString : NSObject <NSCopying, NSMutableCopying, NSSecureCoding>

### 利用 Runtime 优化 ###

上面的常规写法并没有什么问题，但是当这个类的属性比较多，而且改动频繁的时候，我们编码比较麻烦，需要频繁改动。这个时候，我们可以利用 Rumtime 对写法进行优化。

首先，我们利用 runtime 获取到该类的 `objc_ivar_list`（实例变量列表），然后遍历该 `objc_ivar_list`，**获取每个实例变量的名称，再结合 `KVO` 技术进行存取值操作**，就可以实现一次编码，长久使用的效果。

#import <objc/runtime.h>
    
    @implementation VGPerson
    
    - (nullable instancetype)initWithCoder:(NSCoder *)coder { 
        if (self = [super init]) { 
            unsigned int count = 0;
            // 获取该类的 objc_ivar_list
            Ivar *ivars = class_copyIvarList([VGPerson class], &count);
            for (int i = 0; i < count; i++) { 
                Ivar ivar = ivars[i];
                const char *name = ivar_getName(ivar);
                NSString *key = [NSString stringWithUTF8String:name];
                // 根据 key 解码获取属性值
                id value = [coder decodeObjectForKey:key];
                // 利用 KVC 进行赋值
                [self setValue:value forKey:key];
            }
        }
        return self;
    }
    
    - (void)encodeWithCoder:(NSCoder *)coder { 
        unsigned int count = 0;
        Ivar *ivars = class_copyIvarList([VGPerson class], &count);
        for (int i = 0; i < count; i++) { 
            Ivar ivar = ivars[i];
            const char *name = ivar_getName(ivar);
            NSString *key = [NSString stringWithUTF8String:name];
            // 通过 KVC 进行取值
            [coder encodeObject:[self valueForKey:key] forKey:key];
        }
    }
    
    @end

## 2.3 对多种类型的对象进行归档 ##

我们可以对多种类型的对象进行归档，下面例子就是对**基本类型变量、OC 对象，结构体类型变量**等进行归档。

// 要进行归档的对象
    NSInteger num = 1024;
    NSString *name = @"Veggie";
    CGPoint point = CGPointMake(1, -1);
    
    NSMutableData *mutibleData = [NSMutableData data];
    NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:mutibleData];
    
    // 对要进行归档的数据进行编码，转化二进制
    [archiver encodeInteger:num forKey:@"num"];
    [archiver encodeObject:name forKey:@"name"];
    [archiver encodeCGPoint:point forKey:@"point"];
    
    [archiver finishEncoding];
    
    // 确定数据在沙盒中的存储路径
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
    NSString *dataPath = [docPath stringByAppendingPathComponent:@"data.archiver"];
    
    // 归档
    BOOL isSussess = [mutibleData writeToFile:dataPath atomically:YES];
    NSLog(@"%d", isSussess);

反归档并输出结果进行验证。

// 数据在沙盒中的存储路径
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
    NSString *dataPath = [docPath stringByAppendingPathComponent:@"data.archiver"];
    
    // 创建 NSData 和 NSKeyedUnarchiver 对象，反归档获取二进制数据
    NSData *data = [[NSData alloc] initWithContentsOfFile:dataPath];
    NSKeyedUnarchiver *unArchhiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:data];
    
    // 解码获取数据
    NSInteger num = [unArchhiver decodeIntegerForKey:@"num"];
    NSString *name = [unArchhiver decodeObjectForKey:@"name"];
    CGPoint point = [unArchhiver decodeCGPointForKey:@"point"];
    
    // 解码完成
    [unArchhiver finishDecoding];
    
    // 输出结果进行验证
    NSLog(@"num: %ld", (long)num);
    NSLog(@"name: %@", name);
    NSLog(@"point: (%.0f, %.0f)", point.x, point.y);

# 3. 解决方法已被弃用问题 #

在编写上面的归档代码时，你会发现方法 `archiveRootObject:toFile:` 和 `unarchiveObjectWithFile:` 等的一些方法在 iOS 12 中已经被弃用，会收 Xcode 提示的 deprecated in iOS 12.0 的 warning。

虽然说被弃用并不是能用，但是我们要编写质量更高的代码，就要去学习新的 API，在新的 iOS 版本中使用新的系统方法，避免编译器报 warning。

## 3.1 旧方法被弃用的原因 ##

以往 iOS 防止数据篡改，主要重心放在网络传输策略，但是**数据处理部分依然存在被攻击风险**。而归档，正是短板所在而所有对象归档、编解码都会走同一个方法，这对攻击者而言也十分方便。

于是，苹果在 iOS 12 之后为归档方法提供了安全的编解码方式，它主要是**利用类名校验机制，再编解码之前，先检测数据是否为指定的类，然后再决定是否要编解码**。

## 3.2 新方法的使用 ##

在新的归档方法中，它要求被归档对象所属的类遵循继承自 `NSCoding` 的 `NSSecureCoding` 协议，它相比 `NSCoding` 协议需要额外实现如下方法，方法返回 `true` 表示支持安全的编解码方式。

+ (BOOL)supportsSecureCoding { 
        return YES;
    }

PS：**Foundation 框架的常用类都有遵循该协议**。

这里是对 2.1 应用实例的修改，运用了新的归档方法。

NSArray *arr = @[@"Kobe", @"James", @"Iverson", @"Curry"];
    
    NSError *error = nil;
    // 新的归档方法
    NSData *data = [NSKeyedArchiver archivedDataWithRootObject:arr requiringSecureCoding:YES error:&error];
    if (data == nil && error != nil) { 
    	NSLog(@"归档失败 %@", error);
    }
    
    // 在沙盒中获取 Documents 路径
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
    // 归档对象的最终存储位置
    NSString *arrPath = [docPath stringByAppendingPathComponent:@"arr.archiver"]; // 后缀名可随意填写
    
    [data writeToFile:arrPath atomically:YES];

相对应地反归档操作，这里也运用了新的反归档方法。

// 在沙盒中获取 Documents 路径
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
    // 归档对象的最终存储位置
    NSString *arrPath = [docPath stringByAppendingPathComponent:@"arr.archiver"]; // 后缀名可随意填写
    NSData *data = [NSData dataWithContentsOfFile:arrPath];
    
    NSError *error = nil;
    // 新的反归档方法
    NSArray *arr = [NSKeyedUnarchiver unarchivedObjectOfClass:[NSArray class] fromData:data error:&error];
    
    if (arr == nil && error != nil) { 
        NSLog(@"反归档失败：%@", error);
    } else { 
        // 遍历获取到的数组，验证结果
        [arr enumerateObjectsUsingBlock:^(NSString * _Nonnull obj, NSUInteger idx, BOOL * _Nonnull stop) { 
    		NSLog(@"%lu - %@", idx, obj);
        }];
    }

**对于多种类型对象的归档，目前还有没有找到像 2.3 那样便捷的方法**，感觉在 iOS 12 之后，归档能力有所下降。但是考虑到归档的应用场景，所要进行归档对象基本都是同一类型的，**如果涉及到多种类型，可以选择进行多次归档操作**，它所提供的 API 已经能满足我们平时使用的需求。

# 参考资料 #

*  [https://www.jianshu.com/p/185e9ea021a2][https_www.jianshu.com_p_185e9ea021a2]
 *  [https://www.jianshu.com/p/3e08fa21316d][https_www.jianshu.com_p_3e08fa21316d]
 *  [https://github.com/ChenYilong/iOS12AdaptationTips/issues/1][https_github.com_ChenYilong_iOS12AdaptationTips_issues_1]
 *  [https://stackoverflow.com/questions/51372551/how-to-replace-nskeyedarchivers-initializer-initforwritingwith-in-ios-12-to][https_stackoverflow.com_questions_51372551_how-to-replace-nskeyedarchivers-initializer-initforwritingwith-in-ios-12-to]
 *  [NSKeyedUnarchiver | Apple Developer Documentation][NSKeyedUnarchiver _ Apple Developer Documentation]

[https_www.jianshu.com_p_185e9ea021a2]: https://www.jianshu.com/p/185e9ea021a2
[https_www.jianshu.com_p_3e08fa21316d]: https://www.jianshu.com/p/3e08fa21316d
[https_github.com_ChenYilong_iOS12AdaptationTips_issues_1]: https://github.com/ChenYilong/iOS12AdaptationTips/issues/1
[https_stackoverflow.com_questions_51372551_how-to-replace-nskeyedarchivers-initializer-initforwritingwith-in-ios-12-to]: https://stackoverflow.com/questions/51372551/how-to-replace-nskeyedarchivers-initializer-initforwritingwith-in-ios-12-to
[NSKeyedUnarchiver _ Apple Developer Documentation]: https://developer.apple.com/documentation/foundation/nskeyedunarchiver