物件封存(archive)是把記憶體中的物件持久化;還原(unarchive)則是把持久化的資料讀回記憶體。Objective-C 的實作大致可以從兩個維度分類:
以下逐一用程式碼示範。
void SingleSystemObject()
{
NSArray *arr = [NSArray arrayWithObjects:@1, @"你好", @3, nil];
NSString *filePath = [NSHomeDirectory() stringByAppendingPathComponent:@"array.txt"];
// 封存
BOOL success = [NSKeyedArchiver archiveRootObject:arr toFile:filePath];
if (success) {
NSLog(@"封存成功");
}
// 還原
NSArray *arr2 = [NSKeyedUnarchiver unarchiveObjectWithFile:filePath];
for (NSString *str in arr2) {
NSLog(@"%@", str);
}
}
void MultiSystemObject()
{
NSArray *arr = [NSArray arrayWithObjects:@1, @2, @"中文", nil];
NSInteger integer = 10;
BOOL archiverBool = YES;
/*---------- 封存 ----------*/
NSMutableData *data = [NSMutableData data];
NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:data];
// key 是還原時的識別碼,可任意命名;encode 有多個重載,但並非所有系統物件都有
[archiver encodeObject:arr forKey:@"arr"];
[archiver encodeInteger:integer forKey:@"integer"];
[archiver encodeBool:archiverBool forKey:@"archiverBool"];
[archiver finishEncoding];
NSString *filepath = [NSHomeDirectory() stringByAppendingPathComponent:@"1.txt"];
BOOL success = [data writeToFile:filepath atomically:YES];
if (success) {
NSLog(@"封存成功");
}
/*---------- 還原 ----------*/
NSData *data2 = [NSData dataWithContentsOfFile:filepath];
NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:data2];
// 依封存時的型別與 key 對應還原
NSArray *arr2 = [unarchiver decodeObjectForKey:@"arr"];
NSInteger integer2 = [unarchiver decodeIntegerForKey:@"integer"];
BOOL unarchiveBool = [unarchiver decodeBoolForKey:@"archiveBool"];
NSLog(@"%@", arr2);
NSLog(@"%ld", (long)integer2);
NSLog(@"%d", unarchiveBool);
}
自訂類別要能被封存,必須採用 NSCoding 協定,並實作兩個方法:
- (void)encodeWithCoder:(NSCoder *)aCoder // 封編碼 - (id)initWithCoder:(NSCoder *)aDecoder // 封解碼
做法與多個系統物件相同:把每個成員變數依型別編碼並指定 key,還原時依 key 對應型別解碼並賦值,最後回傳物件。
Person.m:
@interface Person : NSObject <NSCoding>
@property (copy, nonatomic) NSString *name;
@property (assign, nonatomic) NSInteger age;
@end
@implementation Person
- (void)encodeWithCoder:(NSCoder *)aCoder {
[aCoder encodeObject:self.name forKey:@"name"];
[aCoder encodeInteger:self.age forKey:@"age"];
}
- (id)initWithCoder:(NSCoder *)aDecoder {
self = [super init];
if (self) {
self.name = [aDecoder decodeObjectForKey:@"name"];
self.age = [aDecoder decodeIntegerForKey:@"age"];
}
return self;
}
- (NSString *)description {
return [NSString stringWithFormat:@"name = %@, age = %ld",
self.name, (long)self.age];
}
@end
封存與還原:
void UserDefinedObject()
{
Person *p = [[Person alloc] init];
p.name = @"yangys";
p.age = 10;
NSString *filepath = [NSHomeDirectory() stringByAppendingPathComponent:@"person.txt"];
BOOL success = [NSKeyedArchiver archiveRootObject:p toFile:filepath];
if (success) {
NSLog(@"封存成功");
}
Person *person = [NSKeyedUnarchiver unarchiveObjectWithFile:filepath];
NSLog(@"%@", person);
}
多個自訂物件的封存與還原,寫法與「多個系統物件」完全相同。
最後值得強調的是:系統物件之中,也只有採用了 NSCoding 或其子協定的那些才能被封存與還原。此外,若自訂類別的成員包含其他自訂物件,那些成員類別同樣必須實作 NSCoding,否則會在執行期報錯。