歸檔是 iOS 中用來持久化文件的一種常見手段。在面向對象的語言裡,歸檔的實質就是把對象寫進文件。以下把 iOS 開發中常用的三種歸檔方式做個總結。
指對字符串、數組這類簡單對象直接歸檔,使用 archiveRootObject:toFile::
[NSKeyedArchiver archiveRootObject:array toFile:path];
其中 array 是要歸檔的對象,path 是目標文件路徑。也就是說,使用前得先準備好這兩樣東西。
數組的創建(實戰中通常歸檔的是已有數據,這裡只是示範):
NSArray *array = @[@"1", @"2", @"3"];
路徑必須指向沙盒,但不用手動去創建文件——歸檔語句會根據路徑與文件名自動創建:
NSString *path = [NSString stringWithFormat:@"%@/Documents/myfile.mp3", NSHomeDirectory()];
這樣歸檔的對象,可以用 NSKeyedUnarchiver 解檔。完整流程:
// 準備數據
NSArray *array = @[@"1", @"2", @"3"];
// 拼接沙盒路徑
NSString *path = [NSString stringWithFormat:@"%@/Documents/myfile.mp3", NSHomeDirectory()];
// 歸檔
[NSKeyedArchiver archiveRootObject:array toFile:path];
// 解檔
NSArray *array1 = [NSKeyedUnarchiver unarchiveObjectWithFile:path];
NSLog(@"%@", array1);
這種方式先準備一個可變的 data 對象,再用 NSKeyedArchiver 的實例把各種類型的數據編碼進去,核心方法是 encodeObject:forKey: 這一族。
// 目標路徑
NSString *pathdata = [NSString stringWithFormat:@"%@/Documents/a.mp3", NSHomeDirectory()];
// 準備容器
NSMutableData *datanow = [[NSMutableData alloc] init];
// 建立歸檔實例
NSKeyedArchiver *keyarch = [[NSKeyedArchiver alloc] initForWritingWithMutableData:datanow];
[keyarch encodeObject:@"hahha" forKey:@"one"];
[keyarch encodeInteger:133 forKey:@"two"];
[keyarch finishEncoding]; // 編碼結束必須調用
[datanow writeToFile:pathdata atomically:YES];
// 解檔
NSData *dataout = [NSData dataWithContentsOfFile:pathdata];
NSKeyedUnarchiver *unarch = [[NSKeyedUnarchiver alloc] initForReadingWithData:dataout];
NSString *stringone = [unarch decodeObjectForKey:@"one"];
NSInteger x = [unarch decodeIntegerForKey:@"two"];
NSLog(@"%@,%ld", stringone, (long)x);
如果一個對象有很多屬性,逐个歸檔再逐个解檔會非常繁瑣。更好的做法是把整個對象的屬性一次性寫進文件,讀出來時也是整個對象還原,之後想取哪個屬性直接用。
前提是自定義類要遵守 NSCoding 協議。這裡定義一個 User 類,含 name 和 age 兩個屬性。
User.h
#import <Foundation/Foundation.h>
@interface User : NSObject <NSCoding>
@property (nonatomic, strong) NSString *name;
@property (nonatomic, strong) NSString *age;
@end
User.m:需要重寫歸檔、解檔兩個方法,順手把 description 也重寫一下,方便調試。
#import "User.h"
@implementation User
// 歸檔:說明各個屬性如何寫入
- (void)encodeWithCoder:(NSCoder *)aCoder {
[aCoder encodeObject:self.age forKey:@"age"];
[aCoder encodeObject:self.name forKey:@"name"];
}
// 解檔:說明如何從歸檔中還原出一個新對象
- (instancetype)initWithCoder:(NSCoder *)aDecoder {
self = [super init];
if (self) {
self.age = [aDecoder decodeObjectForKey:@"age"];
self.name = [aDecoder decodeObjectForKey:@"name"];
}
return self;
}
// 打印對象時直接輸出兩個屬性
- (NSString *)description {
return [NSString stringWithFormat:@"%@ %@", self.name, self.age];
}
@end
重寫 description 之後,用 NSLog 打印 User 對象時就會走這個方法。
調用處:
// 創建對象並賦值
User *myUser = [[User alloc] init];
myUser.age = @"234";
myUser.name = @"bearapp.me";
// 歸檔路徑
NSString *pathdata = [NSString stringWithFormat:@"%@/Documents/myUser.mp3", NSHomeDirectory()];
// 歸檔
[NSKeyedArchiver archiveRootObject:myUser toFile:pathdata];
// 解檔
User *userout = [NSKeyedUnarchiver unarchiveObjectWithFile:pathdata];
NSLog(@"%@", userout);
因為重寫了 description,打印結果會是兩個屬性的拼接:
2016-04-13 14:28:17.195 自定義歸檔[44181:2130618] bearapp.me 234
finishEncoding;NSCoding,用第三種,後續維護最省事。另外提醒一句:文件擴展名可以任意指定,.mp3、.data 都不影響實際內容;若自定義類有父類,歸檔與解檔時記得先調用父類的實現。