iOS archive（归档）的总结

Posted 2022-12-09 小杨在玩iOS

ios 归档的记录

归档是一种很常用的文件储存方法，几乎任何类型的对象都能够被归档储存（实际上是一种文件保存的形式），浏览网上的一些资料后，并结合自己的一些经验，总结成此文。

一、使用archiveRootObject进行简单的归档

使用NSKeyedArichiver进行归档、NSKeyedUnarchiver进行接档，这种方式会在写入、读出数据之前对数据进行序列化、反序列化操作。

归档：

    NSString *homeDictionary = NSHomeDirectory();//获取根目录
    NSString *homePath  = [homeDictionary stringByAppendingPathComponent:@"atany.archiver"];//添加储存的文件名
    BOOL flag = [NSKeyedArchiver archiveRootObject:@”归档” toFile:homePath];//归档一个字符串

这种方式可以对字符串、数字等进行归档，当然也可以对NSArray与NSDictionary进行归档。返回值Flag标志着是否归档成功，YES为成功，NO为失败。

接档：

[NSKeyedUnarchiver unarchiveObjectWithFile:homePath]

使用NSKeyedUnarchiver进行接档（反序列化）。

这种归档的方式存在一个缺点：只能把一个对象归档进一个文件中，那么怎么对多个对象进行归档呢？

二、对多个对象的归档

同样是使用NSKeyedArchiver进行归档，不同的是同时归档多个对象，这里我们举例放入了一个CGPoint点、字符串、整数（当然很多类型都可以的，例如UIImage、float等等），使用encodeXXX方法进行归档，最后通过writeToFile方法写入文件。

归档：写入数据

    //准备数据
    CGPoint point = CGPointMake(1.0, 2.0);
    NSString *info = @"坐标原点";
    NSInteger value = 10;
    NSString *multiHomePath = [NSHomeDirectory() stringByAppendingPathComponent:@"multi.archiver"];
    NSMutableData *data = [[NSMutableData alloc]init];
    NSKeyedArchiver *archvier = [[NSKeyedArchiver alloc]initForWritingWithMutableData:data];

    //对多个对象进行归档
    [archvier encodeCGPoint:point forKey:@"kPoint"];
    [archvier encodeObject:info forKey:@"kInfo"];
    [archvier encodeInteger:value forKey:@"kValue"];
    [archvier finishEncoding];
    [data writeToFile:multiHomePath atomically:YES];

接档：从路径中获得数据构造NSKeyedUnarchiver实例，使用decodeXXXForKey方法获得文件中的对象。

    NSMutableData *dataR = [[NSMutableData alloc]initWithContentsOfFile:multiHomePath];
    NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc]initForReadingWithData:dateR];
    CGPoint pointR = [unarchiver decodeCGPointForKey:@"kPoint"];
    NSString *infoR = [unarchiver decodeObjectForKey:@"kInfo"];
    NSInteger valueR = [unarchiver decodeIntegerForKey:@"kValue"];
    [unarchiver finishDecoding];
    NSLog(@"%f,%f,%@,%d",pointR.x,pointR.y,infoR,valueR);

可以看出对多个对象进行归档还是挺方便的，这里又出现一个问题，这里的对象都是基本类型数据，那么怎么对自己定义类生成的实例对象进行归档呢？

三、对自定义对象进行归档

自定义对象，应用范围很广，因为它对应着MVC中的Model层，即实体类。在程序中，我们会在Model层定义很多的entity，例如User，Teacher。。

那么对自定义对象的归档显得重要的多，因为很多情况下我们需要在Home键之后保存数据，在程序恢复时重新加载，那么，归档便是一个好的选择。

首先我们需要，自定义一个实体类，Archive。

Archive.h

#import <Foundation/Foundation.h>

@interface Archive : NSObject
@property (copy,nonatomic) NSString *name;
@property NSInteger age;
@property (copy,nonatomic) NSString *address;
@property (copy,nonatomic) UIImage *photo;

@end

Archive.m

#import "Archive.h"
#define kNameKey @"NameKey"
#define kAgeKey @"AgeKey"
#define kAddress @"AddressKey"
#define kPhotoKey @"PhotoKey"

@implementation Archive
@synthesize name = _name;
@synthesize age = _age;
@synthesize address = _address;
@synthesize photo = _photo;

#pragma mark - NSCoding
- (void)encodeWithCoder:(NSCoder *)aCoder 
    [aCoder encodeObject:_name forKey:kNameKey];
    [aCoder encodeInteger:_age forKey:kAgeKey];
    [aCoder encodeObject:_address forKey:kAddress];
    [aCoder encodeObject:_photo forKey:kPhotoKey];


- (id)initWithCoder:(NSCoder *)aDecoder 
    if (self = [super init]) 
        _name = [aDecoder decodeObjectForKey:kNameKey];
        _age = [aDecoder decodeIntegerForKey:kAgeKey];
        _address = [aDecoder decodeObjectForKey:kAddress];
        _photo = [aDecoder decodeObjectForKey:kPhotoKey];
    
    return self;


#pragma mark - NSCoping
- (id)copyWithZone:(NSZone *)zone 
    Archive *copy = [[[self class] allocWithZone:zone] init];
    copy.name = [self.name copyWithZone:zone];
    copy.age = self.age;
    copy.address = [self.address copyWithZone:zone];
    copy.photo = self.photo;
    return copy;

@end

Archive类有四个字段（名字、年纪、地址、头像），除了年纪为整型之外，其他的都看作Object。

【注】：要将一个自定义的类进行归档，那么类里面的每个属性都必须是可以被归档的，如果是不能归档的类型，我们可以把他转化为NSValue进行归档，然后在读出来的时候在转化为相应的类。

Archive实现了三个委托方法1）encodeWithCoder: 2）initWithCoder:  3）copyWithZone:

1)encodeWithCoder

Encodes the receiverusing a given archiver

通过一个给定的archiver把消息接收者进行编码。

当接收到encodeObject消息的时候，类终端encodeWithCoder方法被调用。

2)initWithCoder

Returns an objectinitialized from data in a given unarchiver. (required)

从一个给定unarchiver的数据中返回一个初始化对象。

3）copyWithZone

Returnsa new instance that’s a copy of the receiver

返回消息接收者的一个复制的新实例。

SDK的概念就是这样，下面看看这个自定义类归档的具体代码，其实和多个对象的归档是一样的。。。

 

归档：

//保存图片与归档
- (IBAction)save:(id)sender 
    
    //准备数据
    NSString *name = @"小杨在玩iOS";
    NSInteger age = 22;
    NSString *address = @"你猜我在哪~";
    UIImage *photo = [UIImage imageNamed:@"loginman.jpg"];
    //存储数据到类
    Archive *archivingData = [[Archive alloc] init];
    archivingData.name = name;
    archivingData.age = age;
    archivingData.address = address;
    archivingData.photo = photo;
    
    //归档
    NSMutableData *data = [[NSMutableData alloc] init];
    NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:data];

    [archiver encodeObject:archivingData forKey:kArchivingDataKey]; // archivingDate的encodeWithCoder
方法被调用
    [archiver finishEncoding];
    //写入文件
    [data writeToFile:self.archivingFilePath atomically:YES];

接档：

- (IBAction)loadArchive:(id)sender 
    NSData *data = [[NSMutableData alloc] initWithContentsOfFile:self.archivingFilePath];
    NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:data];
    
    //获得类
    Archive *archivingData = [unarchiver decodeObjectForKey:kArchivingDataKey];// initWithCoder方法被调用
    [unarchiver finishDecoding];
    
    //读取的数据
    NSString *name = archivingData.name;
    NSInteger age = archivingData.age;
    NSString *address = archivingData.address;
    self.imageView.image = archivingData.photo;
    NSLog(@"%@||%d||%@",name,age,address);

我们save之后loadArchive一次

打出结果为：

2013-11-04 19:29:41.743TestArchives[16708:c07]小杨在玩iOS||22||你猜我在哪~

获取成功。

OK，面朝大海，春暖花开

杨光（atany）原创，转载请注明博主与博文链接，未经博主允许，禁止任何商业用途。

博文地址：http://blog.csdn.net/yang8456211/article/details/14146585

博客地址：http://blog.csdn.net/yang8456211

本文遵循“署名-非商业用途-保持一致”创作公用协议