首页 > 代码库 > OC学习篇之---归档和解挡
OC学习篇之---归档和解挡
今天我们来看一下OC中的一个重要知识点:归档
OC中的归档就是将对象写入到一个文件中,Java中的ObjectInputStream和ObjectOutputStream来进行操作的。当然在操作的这些对象都是需要实现一个接口:Serializable,同样的OC中操作的对象也是需要实现一个协议的,后面会说到。
一、已有类型的归档和解档
首先来看一个简单的例子:
- //
- // main.m
- // 33_ObjectToFile
- //
- // Created by jiangwei on 14-10-13.
- // Copyright (c) 2014年 jiangwei. All rights reserved.
- //
- #import <Foundation/Foundation.h>
- //归档:将一个对象写到文件中
- int main(int argc, const charchar * argv[]) {
- @autoreleasepool {
- //第一种形式:归档对象
- //对象----》文件
- /*
- NSArray *array = [NSArray arrayWithObjects:@"zhang",@"wangwu",@"lisi",nil];
- NSString *filePath = [NSHomeDirectory() stringByAppendingPathComponent:@"array.src"];
- BOOL success = [NSKeyedArchiver archiveRootObject:array toFile:filePath];
- if(success){
- NSLog(@"保存成功");
- }
- */
- /*解归档
- NSString *filePath = [NSHomeDirectory() stringByAppendingPathComponent:@"array.src"];
- id array = [NSKeyedUnarchiver unarchiveObjectWithFile:filePath];
- NSLog(@"%@",array);
- */
- //第二种方式
- //第一种方式的缺陷是一个对象归档成一个文件
- //但是第二种方式,多个对象可以归档成一个文件
- /*
- NSArray *array = [NSArray arrayWithObjects:@"zhangsan",@"lisi", nil];
- NSMutableData *data = [NSMutableData data];
- NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:data];
- //编码
- [archiver encodeObject:array forKey:@"array"];
- [archiver encodeInt:100 forKey:@"scope"];
- [archiver encodeObject:@"jack" forKey:@"name"];
- //完成编码,将上面的归档数据填充到data中,此时data中已经存储了归档对象的数据
- [archiver finishEncoding];
- [archiver release];
- NSString *filePath = [NSHomeDirectory() stringByAppendingPathComponent:@"array.src"];
- BOOL success = [data writeToFile:filePath atomically:YES];
- if(success){
- NSLog(@"归档成功");
- }
- */
- NSString *filePath = [NSHomeDirectory() stringByAppendingPathComponent:@"array.src"];
- //读取归档数据
- NSData *data = [[NSData alloc] initWithContentsOfFile:filePath];
- //创建解归档对象,对data中的数据进行解归档
- NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:data];
- //解归档
- NSArray *array = [unarchiver decodeObjectForKey:@"array"];
- NSLog(@"%@",array);
- int value = [unarchiver decodeObjectForKey:@"scope"];
- NSLog(@"%d",value);
- }
- return 0;
- }
1、归档
- //第一种形式:归档对象
- //对象----》文件
- NSArray *array = [NSArray arrayWithObjects:@"zhang",@"wangwu",@"lisi",nil];
- NSString *filePath = [NSHomeDirectory() stringByAppendingPathComponent:@"array.src"];
- BOOL success = [NSKeyedArchiver archiveRootObject:array toFile:filePath];
- if(success){
- NSLog(@"保存成功");
- }
我们这里将一个NSArray对象写入到一个文件中。
这里说到了创建一个文件的方法:
- NSString *filePath = [NSHomeDirectory() stringByAppendingPathComponent:@"array.src"];
我们可以打印一下filePath的值:
NSHomeDirectory()返回的就是当前用户路径
我们查看一下array.src的内容:
我们看到内容是乱的,但是我们貌似还是能看到一点,比如wangwu/lisi等字眼,说明在归档的时候并没有深入的加密。
2、解档
- //解归档
- NSString *filePath = [NSHomeDirectory() stringByAppendingPathComponent:@"array.src"];
- id array = [NSKeyedUnarchiver unarchiveObjectWithFile:filePath];
- NSLog(@"%@",array);
解档也是很简单的,就是返回一个对象,不过这里用了id类型的,因为读出来也不确定是哪种类型的。
3、对多个对象进行归档到一个文件
- //第二种方式
- //第一种方式的缺陷是一个对象归档成一个文件
- //但是第二种方式,多个对象可以归档成一个文件
- NSArray *array = [NSArray arrayWithObjects:@"zhangsan",@"lisi", nil nil];
- NSMutableData *data = [NSMutableData data];
- NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:data];
- //编码
- [archiver encodeObject:array forKey:@"array"];
- [archiver encodeInt:100 forKey:@"scope"];
- [archiver encodeObject:@"jack" forKey:@"name"];
- //完成编码,将上面的归档数据填充到data中,此时data中已经存储了归档对象的数据
- [archiver finishEncoding];
- [archiver release];
- NSString *filePath = [NSHomeDirectory() stringByAppendingPathComponent:@"array.src"];
- BOOL success = [data writeToFile:filePath atomically:YES];
- if(success){
- NSLog(@"归档成功");
- }
多个对象归档的话,这里要用到一个类:NSMutableData和NSData,他们两的区别很简单,一个是可变的,一个是不可变的。然后这里还创建了一个归档器:NSKeyedArchiver,这个类负责进行指定类型的编码操作,然后将数据填充到NSMutableData类。归档的时候对每个类型对象用一个key进行对应,这个NSData和NSDirctionary很类似了。
4、对多个对象进行解档操作
- NSString *filePath = [NSHomeDirectory() stringByAppendingPathComponent:@"array.src"];
- //读取归档数据
- NSData *data = [[NSData alloc] initWithContentsOfFile:filePath];
- //创建解归档对象,对data中的数据进行解归档
- NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:data];
- //解归档
- NSArray *array = [unarchiver decodeObjectForKey:@"array"];
- NSLog(@"%@",array);
- int value = [unarchiver decodeObjectForKey:@"scope"];
- NSLog(@"%d",value);
我们可以将文件解档出一个NSData对象,然后可以通过key去获取指定的类型对象
二、自定义类型的归档和解档
上面说到了已有类型的归档和解档,下面来看一下自定义类型的归档和解档操作,在开始的时候也说了,如果自定义的类型可以进行归档和解档的话,必须实现一个协议:NSCoding
不多说了,下面来直接看代码解释:
Person.h
- //
- // Person.h
- // 34_ArchiveProtocol
- //
- // Created by jiangwei on 14-10-13.
- // Copyright (c) 2014年 jiangwei. All rights reserved.
- //
- #import <Foundation/Foundation.h>
- //类只有实现NSCoding协议才能归档
- @interface Person : NSObject<NSCoding>
- @property(nonatomic,copy)NSString *name;
- @property(nonatomic,assign)NSInteger age;
- @property(nonatomic,retain)NSArray *apples;
- - (NSString *)description;
- @end
这里自定义了一个Person类型,实现了NSCoding协议,然后他有三个属性,这里我们看到有新的方法去定义属性,这个后面说到内存管理的时候在详细说明。
Person.m
- //
- // Person.m
- // 34_ArchiveProtocol
- //
- // Created by jiangwei on 14-10-13.
- // Copyright (c) 2014年 jiangwei. All rights reserved.
- //
- #import "Person.h"
- @implementation Person
- //解归档的时候调用
- //也是一个初始化方法
- - (id)initWithCoder:(NSCoder *)aDecoder{
- NSLog(@"initWithCoder");
- self = [super init];
- if(self != nil){
- /*
- _name = [aDecoder decodeObjectForKey:@"name"];
- _age = [aDecoder decodeObjectForKey:@"age"];
- _apples = [aDecoder decodeObjectForKey:@"apples"];
- */
- //一般我们将key定义成宏,这样就不会出错
- _name = [[aDecoder decodeObjectForKey:@"name"] copy];
- self.age = [aDecoder decodeObjectForKey:@"age"];
- self.apples = [aDecoder decodeObjectForKey:@"apples"];
- }
- return self;
- }
- //归档时调用此方法
- - (void)encodeWithCoder:(NSCoder *)aCoder{
- NSLog(@"encodeWithCoder");
- [aCoder encodeObject:_name forKey:@"name"];//一般key和属性名是取一样的
- [aCoder encodeInteger:_age forKey:@"age"];
- [aCoder encodeObject:_apples forKey:@"apples"];
- }
- - (NSString *)description{
- NSString *string = [NSString stringWithFormat:@"name=%@,age=%d,apples=%@",_name,_age,_apples];
- return string;
- }
- @end
在Person.m文件中,我们需要实现协议中的两个方法:
initWithCoder
encodeWithCoder
这两个方法一个是用于归档操作时会调用的方法,还有一个是用于解档操作时会调用的方法
1、解档的时候用到的方法
- - (id)initWithCoder:(NSCoder *)aDecoder{
- NSLog(@"initWithCoder");
- self = [super init];
- if(self != nil){
- /*
- _name = [aDecoder decodeObjectForKey:@"name"];
- _age = [aDecoder decodeObjectForKey:@"age"];
- _apples = [aDecoder decodeObjectForKey:@"apples"];
- */
- //一般我们将key定义成宏,这样就不会出错
- _name = [[aDecoder decodeObjectForKey:@"name"] copy];
- self.age = [aDecoder decodeObjectForKey:@"age"];
- self.apples = [aDecoder decodeObjectForKey:@"apples"];
- }
- return self;
- }
这个是一个初始化的方法,同时他也是一个解档操作时会调用的方法,所以在这里我们既要写一下初始化方法的特定代码,还要写上解档的代码,这里主要看解档的代码
其实很简单,就是对属性重新写一下值,然后对每个属性指定一个key就可以了。这个有点类似于Android中的Parcel
(这里我们看到,在解档name属性的时候,用到了copy的一个方法,这个在后面会说到,有浅拷贝和深拷贝之分)
2、归档的时候用到的方法
- //归档时调用此方法
- - (void)encodeWithCoder:(NSCoder *)aCoder{
- NSLog(@"encodeWithCoder");
- [aCoder encodeObject:_name forKey:@"name"];//一般key和属性名是取一样的
- [aCoder encodeInteger:_age forKey:@"age"];
- [aCoder encodeObject:_apples forKey:@"apples"];
- }
归档和解档的操作正好相反的,但是要注意的是:他们属性的key一定要保持一致
3、重写description方法
- - (NSString *)description{
- NSString *string = [NSString stringWithFormat:@"name=%@,age=%d,apples=%@",_name,_age,_apples];
- return string;
- }
在之前的文章中我说道过,我们在使用NSLog方法打印对象的值的时候,其实是调用对象的description方法,而这个方法是NSObject类中的,我们可以重写他,这样我们就可以打印我们想要的信息了。和Java中的toString方法一样。
下面就来看一下使用方法了
main.m
- //
- // main.m
- // 34_ArchiveProtocol
- //
- // Created by jiangwei on 14-10-13.
- // Copyright (c) 2014年 jiangwei. All rights reserved.
- //
- #import <Foundation/Foundation.h>
- #import "Person.h"
- int main(int argc, const charchar * argv[]) {
- @autoreleasepool {
- Person *p = [[Person alloc] init];
- p.name = @"张三";
- p.age = 20;
- p.apples = @[@"iphone",@"ipad"];
- //归档
- NSString *filePath = [NSHomeDirectory() stringByAppendingPathComponent:@"person.archiver"];
- BOOL success = [NSKeyedArchiver archiveRootObject:p toFile:filePath];
- if(success){
- NSLog(@"归档成功");
- }
- //解归档
- Person *person = [NSKeyedUnarchiver unarchiveObjectWithFile:filePath];
- NSLog(@"%@",person);
- }
- return 0;
- }
我们可以看到,使用起来是很简单的和上面的方式一样,运行结果:
看到了,我们自定义的description方法,打印了我们自己想要的结果~~
总结
这一篇文章我们就说了OC中的归档和解档的相关概念和操作,其实说白了就是将对象写入到文件,和从文件中读取对象。
OC学习篇之---归档和解挡