iOS数据持久化：使用NSKeyedArchiver进行数据归档

栏目: IOS · 发布时间: 6年前

内容简介：结果：

写在前面

这次记录的是iOS中利用 NSKeyedArchiver 和 NSKeyedUnarchiver 进行数据的归档和解档操作。

所谓的归档，就是将数据写到一个文件里面去。一般我们的应用的变量常量之类的数据都是在内存里面的，只要APP关闭，这些数据都会丢失。但是把数据存储到文件里面去，就能将数据保存到本地磁盘里面（目前iOS基本就是在沙盒里面操作了），不管是APP关闭还是重启设备，下次启动APP的时候都能够读出来。
所谓解档 (别人也叫 反归档 )，就是将数据从文件里面读取出来。在程序里面使用。

本文会由浅入深介绍我们常用的使用 NSKeyedArchiver 和 NSKeyedUnarchiver 进行数据的归档和解档的方法。

主要有以下几点内容：

普通数组的归档和解档
因为文件夹不存在造成归档失败
因为无写权限造成归档失败
普通字典的归档和解档
多个普通对象同时归档和解档
自定义对象的归档和解档
自定义对象数组的归档和解档
自定义对象里面有另一个自定义对象的归档和解档

普通数组的归档和解档

普通数组的归档流程：

获得文件归档的路径
使用 NSKeyedArchiver 类的 NSKeyedArchiver+ (BOOL)archiveRootObject:(id)rootObject toFile:(NSString *)path 方法将数据归档

//普通数组归档
- (IBAction)onClickBtn1:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"numbers.plist"];

    NSArray *numbers = @[@"one",@"two"];

    //将数据归档到path文件路径里面
    BOOL success = [NSKeyedArchiver archiveRootObject:numbers toFile:path];

    if (success) {
        NSLog(@"文件归档成功");
    }
}

注： + (BOOL)archiveRootObject:(id)rootObject toFile:(NSString *)path 方法有个BOOL类型的返回值。说明归档操作是有可能失败的。一般来说，归档失败最多的情况有两种：文件路径不存在以及无写入权限。后面会单独讲。

普通数组解档流程：

获得文件归档的路径
使用 NSKeyedUnarchiver 类的 + (nullable id)unarchiveObjectWithFile:(NSString *)path; 方法进行解档，读取内容。

//普通数组解档
- (IBAction)onClickBtn2:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"numbers.plist"];

    //将path文件路径的数据解档出来
    NSArray *numbers = [NSKeyedUnarchiver unarchiveObjectWithFile:path];

    NSLog(@"numbers=%@",numbers);
}

因为文件夹不存在造成归档失败

归档是有可能失败。

很多时候造成归档失败的原因是，你给出了一个文件路径，但是这个文件的文件夹路径并不存在。所以程序无法给你归档，创建文件。这时，我们应该要先创建文件夹，再进行归档。

上面我们的例子我们取的文件夹路径是沙盒里面的Documents文件夹。我们是让程序在这个文件加里面创建了一个文件进行归档。

假如我们想要在Documents文件夹内的Archive文件夹进行归档呢？会发生什么情况？

//因为文件夹不存在造成归档失败
- (IBAction)onClickBtn1_2:(id)sender {
    //沙盒home目录
    NSString *docPath = NSHomeDirectory();
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"Documents/Archive/numbers.plist"];

    NSArray *numbers = @[@"one",@"two"];

    //将数据归档到path文件路径里面
    BOOL success = [NSKeyedArchiver archiveRootObject:numbers toFile:path];

    if (success) {
        NSLog(@"归档成功");
    }else {
        NSLog(@"归档失败");
    }

    //将path文件路径的数据解档出来
    NSArray *unarchiveNumbers = [NSKeyedUnarchiver unarchiveObjectWithFile:path];
    NSLog(@"unarchiveNumbers=%@",unarchiveNumbers);
}

结果：

2018-05-10 15:42:54.966 iOSArchiveAndUnArchive[11508:441222] 沙盒路径：/Users/mac/Library/Developer/CoreSimulator/Devices/662CE852-A601-496B-827B-44A8122A5F52/data/Containers/Data/Application/EAF9F153-8F41-4650-A58E-CFC2BED411EE
2018-05-10 15:42:57.618 iOSArchiveAndUnArchive[11508:441222] 归档失败
2018-05-10 15:42:57.619 iOSArchiveAndUnArchive[11508:441222] unarchiveNumbers=(null)

以上代码会导致归档失败。看了看，原来Documents目录下并没有Archive文件夹。

那么，在归档之前，我们最好先判断下文件夹是否存在，如果不存在，则先创建文件夹，然后再进行归档操作

。

//先判断下文件夹是否存在，如果不存在，则先创建文件夹，然后再进行归档操作
- (IBAction)onClickBtn1_2:(id)sender {

    //沙盒home目录
    NSString *docPath = NSHomeDirectory();
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"Documents/Archive/numbers.plist"];

    //获取文件夹路径
    NSString *directory = [path stringByDeletingLastPathComponent];
    //判断文件夹是否存在
    BOOL fileExists = [[NSFileManager defaultManager] fileExistsAtPath:directory isDirectory:nil];
    //如果不存在则创建文件夹
    if (!fileExists) {

        NSLog(@"文件夹不存在");
        //创建文件夹
        NSError *error = nil;
        [[NSFileManager defaultManager] createDirectoryAtPath:directory withIntermediateDirectories:YES attributes:nil error:&error];
        if (error) {
            NSLog(@"error=%@",error.description);
        } else {
            NSLog(@"文件夹创建成功");
        }
    }

    NSArray *numbers = @[@"one",@"two"];

    //将数据归档到path文件路径里面
    BOOL success = [NSKeyedArchiver archiveRootObject:numbers toFile:path];

    if (success) {
        NSLog(@"归档成功");
    }else {
        NSLog(@"归档失败");
    }

    //将path文件路径的数据解档出来
    NSArray *unarchiveNumbers = [NSKeyedUnarchiver unarchiveObjectWithFile:path];
    NSLog(@"unarchiveNumbers=%@",unarchiveNumbers);
}

因为无写权限造成归档失败

导致归档失败的另一个原因是程序没有写权限。

因为归档操作本质是创建一个文件，然后在这个文件里面存储数据。如果你在一个文件夹路径上面并没有写权限，那么失败也就能理解了。

有些不熟悉的人可能会遇到这个问题：我在模拟器上归档操作是成功的，可是在真机上运行的时候却归档失败了。到底是什么原因？

这个就是遇到了写权限的问题了。在模拟器上，因为是写在电脑上面的路径的，所以这个路径我们有写权限。但是真机不一样，真机上我们一般情况下只能操作沙盒路径里面文件夹。无法在其他的地方写文件。

//因为无写权限造成归档失败
- (IBAction)onClickBtn1_3:(id)sender {

     //安装目录
    //NSString *docPath = [[NSBundle mainBundle] bundlePath];
    //沙盒home目录
    NSString *docPath = NSHomeDirectory();
    NSLog(@"docPath=%@",docPath);

    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"Documents/numbers.plist"];

    //获取文件夹路径
    NSString *directory = [path stringByDeletingLastPathComponent];

    if (![[NSFileManager defaultManager] isWritableFileAtPath:directory]) {
        NSLog(@"目录无写入权限");
    }

    NSArray *numbers = @[@"one",@"two"];
    //将数据归档到path文件路径里面
    BOOL success = [NSKeyedArchiver archiveRootObject:numbers toFile:path];

    if (success) {
        NSLog(@"归档成功");
    }else {
        NSLog(@"归档失败");
    }

    //将path文件路径的数据解档出来
    NSArray *unarchiveNumbers = [NSKeyedUnarchiver unarchiveObjectWithFile:path];
    NSLog(@"unarchiveNumbers=%@",unarchiveNumbers);
}

一般因为没有权限导致归档失败，都是在两个目录：

安装包目录 [[NSBundle mainBundle] bundlePath] 。这个很明显。我们一般只操作沙盒目录，对安装包目录是没有权限的（模拟器不算）。
沙盒home目录的根目录。这个比较容易出错了。我们明明可以操作沙盒的，为什么没有权限呢？

因为你是在沙盒的根目录操作。

NSHomeDirectory 这个就是沙盒的根目录。直接在这个目录下归档也是会导致归档失败的。一般我们都是在沙盒的Documents目录里面玩。

普通字典的归档和解档

普通字典归档跟上面数组的归档的操作是一样的。

//普通字典归档
- (IBAction)onClickBtn3:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"personDict.archive"];

    NSDictionary *personDict = @{
                                 @"name":@"shixueqian",
                                 @"age":@(27)
                                 };
    //将数据归档到path文件路径里面
    BOOL success = [NSKeyedArchiver archiveRootObject:personDict toFile:path];

    if (success) {
        NSLog(@"归档成功");
    }else {
        NSLog(@"归档失败");
    }
}

这里的后缀名用了 .archive 。实际上对于归档操作来说，用什么后缀名都无所谓的。只是我们一般习惯用 .archive 。之前数组的时候用 .plis t，是为了方便演示。

普通字典解档跟上面数组的解档的操作是一样的。

//普通字典解档

- (IBAction)onClickBtn4:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"personDict.archive"];

    //将path文件路径的数据解档出来
    NSDictionary *personDict = [NSKeyedUnarchiver unarchiveObjectWithFile:path];
    NSLog(@"personDict=%@",personDict);
}

多个普通对象同时归档和解档

上面的例子是将单个的数组或者单个字典归档到一个文件。其实我们也可以将多个数组、字典、字符串、数组等内容归档到同一个文件里面去。

//多个普通对象同时归档
- (IBAction)onClickBtn5:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"manyData.plist"];

    NSInteger age = 27;
    NSString *name = @"shixueqian";
    NSArray *array = @[@"one",@"two"];

    NSMutableData *data = [[NSMutableData alloc] init];
    NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:data];
    [archiver encodeObject:name forKey:@"name"];
    [archiver encodeInteger:age forKey:@"age"];
    [archiver encodeObject:array forKey:@"numbers"];

    //完成归档
    [archiver finishEncoding];

    //将归档好的数据写到文件里面
    [data writeToFile:path atomically:YES];
}

//多个普通对象同时解档
- (IBAction)onClickBtn6:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"manyData.plist"];

    NSMutableData *data = [NSMutableData dataWithContentsOfFile:path];
    NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:data];
    NSString *name = [unarchiver decodeObjectForKey:@"name"];
    NSInteger age = [unarchiver decodeIntegerForKey:@"age"];
    NSArray *numbers = [unarchiver decodeObjectForKey:@"numbers"];

    [unarchiver finishDecoding];

    NSLog(@"name=%@，age=%zd,numbers=%@",name,age,numbers);
}

自定义对象的归档和解档

上面的例子，归档的内容都是系统Foundation框架提供的类以及一些基本的数据类型。

Foundation框架提供的类都是实现了 NSCoding 协议的，所以能够直接进行归档。

如果我们自己自定义了一个类，例如Person类，是无法能够直接将这个类进行归档操作的。

如果想要对自定义的类创建出来的对象进行归档，我们需要先实现 NSCoding 协议。

Person.h文件内容：

#import 
  

@interface Person : NSObject<NSCoding>

@property (nonatomic,copy)NSString *name;

@property (nonatomic,assign)NSInteger age;

//有些属性可以不进行归档
@property (nonatomic,assign)CGFloat height;

@end

Person.m文件内容：

#import "Person.h"

@implementation Person

//NSCoding协议方法：将需要归档的属性进行归档
- (void)encodeWithCoder:(NSCoder *)aCoder {

    [aCoder encodeObject:self.name forKey:@"name"];
    [aCoder encodeInteger:self.age forKey:@"age"];
}

//NSCoding协议方法：将需要解档的属性进行解档
- (instancetype)initWithCoder:(NSCoder *)aDecoder {

    if (self = [super init]) {
        self.name = [aDecoder decodeObjectForKey:@"name"];
        self.age = [aDecoder decodeIntegerForKey:@"age"];
    }

    return self;
}

//重写description方法，方便直接打印对象
- (NSString *)description {
    return [NSString stringWithFormat:@"person.name=%@,person.age=%zd,person.height=%f",self.name,self.age,self.height];
}

@end

Person类实现了 NSCoding 协议之后，就可以跟普通的Foundation框架提供的基本对象一样进行归档和解档操作了。

//自定义对象归档
- (IBAction)onClickBtn7:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"person.archive"];

    Person *person = [[Person alloc] init];
    person.name = @"谦言忘语";
    person.age = 27;

    //将数据归档到path文件路径里面
    BOOL success = [NSKeyedArchiver archiveRootObject:person toFile:path];

    if (success) {
        NSLog(@"归档成功");
    }else {
        NSLog(@"归档失败");
    }
}

//自定义对象解档
- (IBAction)onClickBtn8:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"person.archive"];

    Person *person = [NSKeyedUnarchiver unarchiveObjectWithFile:path];
    NSLog(@"person=%@",person);
}

自定义对象数组的归档和解档

通过上面的内容，普通数组NSArray对象的归档和解档已经知道怎么做了。自定义对象的归档和解档操作也已经知道怎么做了。

那么，自定义对象数组的归档和解档怎么处理呢？比如自定义了一个Person类，然后有一个数组，里面都是person类的对象。

NSArray *array = @[person1,person2,person3]; 。

嗯，其实挺简单的。当我们自定义的类实现了 NSCoding 协议之后，存放自定义类对象的数组就可以当做是普通数组一样进行归档和解档了。

下面代码中的Person类已经实现了 NSCoding 协议，代码上面有，就省略了。

//自定义对象数组归档
- (IBAction)onClickBtn9:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"persons.archive"];

    Person *person1 = [[Person alloc] init];
    person1.name = @"大帅哥";
    person1.age = 18;

    Person *person2 = [[Person alloc] init];
    person2.name = @"谦言忘语";
    person2.age = 27;

    NSArray *persons = @[person1,person2];

    //将数据归档到path文件路径里面
    BOOL success = [NSKeyedArchiver archiveRootObject:persons toFile:path];

    if (success) {
        NSLog(@"归档成功");
    }else {
        NSLog(@"归档失败");
    }

}

//自定义对象数组解档
- (IBAction)onClickBtn10:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"persons.archive"];

    NSArray *persons = [NSKeyedUnarchiver unarchiveObjectWithFile:path];
    NSLog(@"persons=%@",persons);
}

自定义对象里面有另一个自定义对象的归档和解档

上面的Person类，里面的属性的类型就只有Foundation框架里面提供的基本对象以及基本的数据类型。比如 NSString 类型， NSInterger 类型等等。

那假如我们自定义的类里面有另外一个自定义的类的对象作为属性呢？

其实本篇归档和解档的问题可以遵循一个原则：

只要一个类实现了 NSCoding 协议，那么这个类的对象就可以进行归档和解档。类里面的属性实现了 NSCoding 协议，那么这个属性就可以进行归档和解档。

比如上面的Person类，实现了 NSCoding 协议，那么这个类就可以进行归档和解档。

类的属性 name 类型是 NSString ,已经实现过了 NSCoding 协议，所以可以将这个属性归档。

age 是基本数组类型，也可以进行归档。

但是如果这个Person类中还有一个属性为 pet ，类型是我们自定义的 Pet 类，并且这个类没有实现 NSCoding 协议，那么这个pet的属性就无法进行归档。但是，只要Pet类实现了 NSCoding 协议，那就可以了。

以下代码中，自定义的Pet类里面拥有一个master属性，类型为Person。

Pet.h文件代码：

#import 
  

#import "Person.h"

@interface Pet : NSObject<NSCoding>

@property (nonatomic,strong)NSString *name;

@property (nonatomic,strong)Person *master;

@end

Pet.m文件代码：

#import "Pet.h"

@implementation Pet

//NSCoding协议方法：将需要归档的属性进行归档
- (void)encodeWithCoder:(NSCoder *)aCoder {

    [aCoder encodeObject:self.name forKey:@"name"];
    [aCoder encodeObject:self.master forKey:@"master"];
}

//NSCoding协议方法：将需要解档的属性进行解档
- (instancetype)initWithCoder:(NSCoder *)aDecoder {

    self = [super init];
    if (self) {
        self.name = [aDecoder decodeObjectForKey:@"name"];
        self.master = [aDecoder decodeObjectForKey:@"master"];
    }
    return self;
}

//重写description方法，方便直接打印对象
- (NSString *)description {
    return [NSString stringWithFormat:@"pet.name=%@,pet.master:%@",self.name,self.master];
}

@end

//自定义对象里面有另一个自定义对象归档
- (IBAction)onClickBtn11:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"pet.archive"];

    Person *person = [[Person alloc] init];
    person.name = @"谦言忘语";
    person.age = 27;

    Pet *pet = [[Pet alloc] init];
    pet.name = @"小白";
    pet.master = person;


    //将数据归档到path文件路径里面
    BOOL success = [NSKeyedArchiver archiveRootObject:pet toFile:path];

    if (success) {
        NSLog(@"归档成功");
    }else {
        NSLog(@"归档失败");
    }
}

//自定义对象里面有另一个自定义对象解档
- (IBAction)onClickBtn12:(id)sender {

    //沙盒ducument目录
    NSString *docPath = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];
    //完整的文件路径
    NSString *path = [docPath stringByAppendingPathComponent:@"pet.archive"];

    Pet *pet = [NSKeyedUnarchiver unarchiveObjectWithFile:path];
    NSLog(@"pet=%@",pet);
}

参考

iOS 从url中获取文件名以及后缀

IOS判断文件是否可读可写可执行

浅析iOS中的归档与反归档

文章的demo已经放在了我的github 上面

谦言忘语

最近感觉很多东西都忘了，所以感觉有必要多写点文章，就当做是做笔记了。

以上所述就是小编给大家介绍的《iOS数据持久化：使用NSKeyedArchiver进行数据归档》，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对码农网的支持！

查看所有标签

猜你喜欢:

本站部分资源来源于网络，本站转载出于传递更多信息之目的，版权归原作者或者来源机构所有，如转载稿涉及版权问题，请联系我们。

码农书籍

神一样的产品经理

闫荣 / 电子工业出版社 / 2012-6-1 / 79.00元

这是一本系统阐述移动与互联网产品从无到有、从有到优的产品经理实践案例著作。《神一样的产品经理：基于移动与互联网产品实践》贯穿着“人如产品，产品如人”、“产品的根基和源泉来自现实生活”的写作理念，表达了产品的成功需要神一样的产品经理管理的观点。《神一样的产品经理：基于移动与互联网产品实践》由浅入深、循序渐进地阐述了产品经理、产品需求、用户体验、项目管理、产品运营和产品团队管理的内容，理论与实......一起来看看《神一样的产品经理》这本书的介绍吧!

码农工具