並不是所有資料都值得開一個資料庫。設定項、登入狀態這類零散的小資料用 NSUserDefaults 最合適;而自訂物件要落地,則需要透過 NSCoding 協定進行歸檔。以下把兩種方式整理清楚。
先讓自訂類別遵循 NSCoding 協定:
@interface Person : NSObject <NSCoding>
@property (nonatomic, assign) NSInteger ID;
@property (nonatomic, copy) NSString *name;
@end
逐項存取:
// 存檔
NSUserDefaults *user = [NSUserDefaults standardUserDefaults];
[user setInteger:ID forKey:@"ID"];
[user setObject:name forKey:@"name"];
[user synchronize];
// 讀取
NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
NSInteger uId = [defaults integerForKey:@"ID"];
NSString *name = [defaults stringForKey:@"name"];
也可以直接存整個物件:
// 存檔
[user setObject:self forKey:@"user"];
[user synchronize];
// 讀取
User *u = [user objectForKey:@"user"];
這裡有個關鍵前提:被存進 NSUserDefaults 的物件必須遵循 NSCoding 協定,因為 NSUserDefaults 底層是透過 plist 序列化,而 plist 只能存放基礎型別與已實作歸檔的物件。直接塞一個沒實作 NSCoding 的自訂類別進去會拋出例外。
關於 synchronize:現代 iOS 已不需要每次寫入都手動呼叫,系統會自動安排落盤時機。頻繁呼叫反而會造成不必要的 I/O。唯一值得保留的場景是 App 即將進入背景或即將被終止前,想確保資料一定寫入。
要使用物件歸檔,物件必須實作 NSCoding 協定的兩個方法:
- (void)encodeWithCoder:(NSCoder *)encoder; // 負責「寫」
- (id)initWithCoder:(NSCoder *)decoder; // 負責「讀」
大部分系統類別都已符合 NSCoding。若同時希望該物件能被複製,建議一併實作 NSCopying 協定的 - (id)copyWithZone:(NSZone *)zone 方法。
@interface User : NSObject <NSCoding>
@property (nonatomic, assign) NSInteger userID;
@property (nonatomic, copy) NSString *name;
@end
@implementation User
// 這兩個方法必須實作,否則呼叫時會 crash
- (void)encodeWithCoder:(NSCoder *)aCoder {
// 在這裡放置需要持久化的屬性
[aCoder encodeObject:@(self.userID) forKey:@"userID"];
[aCoder encodeObject:self.name forKey:@"name"];
}
- (instancetype)initWithCoder:(NSCoder *)aDecoder {
self = [super init];
if (self) {
// 這裡的 key 必須與 encodeWithCoder 完全一致,否則讀不到資料
self.userID = [[aDecoder decodeObjectForKey:@"userID"] integerValue];
self.name = [aDecoder decodeObjectForKey:@"name"];
}
return self;
}
@end
這裡有個最常見的 bug:encode 與 init 兩邊的 key 拼字不一致,導致解檔後屬性全變成 0 或 nil,而且完全不會報錯。建議把 key 定義成常數,兩邊共用同一份定義。
+ (BOOL)save {
NSError *error = nil;
// 確定存儲路徑,一般放在 Document 目錄下
NSString *filePath = [self getFilePath];
NSString *fileName = [self getFileName];
// 注意:createDirectoryAtPath 傳入的是「目錄」路徑
if (![[NSFileManager defaultManager] createDirectoryAtPath:filePath
withIntermediateDirectories:YES
attributes:nil
error:&error]) {
NSLog(@"創建用戶文件目錄失敗");
return NO;
}
NSString *fullPath = [filePath stringByAppendingPathComponent:fileName];
return [NSKeyedArchiver archiveRootObject:self toFile:fullPath];
}
// 讀取
+ (instancetype)load {
NSString *fullPath = [[self getFilePath] stringByAppendingPathComponent:[self getFileName]];
return [NSKeyedUnarchiver unarchiveObjectWithFile:fullPath];
}
使用 NSKeyedArchiver 而非 NSKeyedArchiver 的關鍵在於 "Keyed"——它以 key 為索引儲存,因此當你的類別新增或刪減屬性時,舊資料仍能相容讀取,這比早期的 ARCHIVE 方式健壯得多。
最後提醒:自 iOS 12 起,已有更現代的 NSSecureCoding 協定,它要求解檔時必須指定允許的類別白名單,能防止惡意建構的資料造成安全問題。新專案請優先採用 NSSecureCoding。