iOS 提供的資料持久化方案不少:NSUserDefaults、plist 與 sqlite3 資料庫各有適用場景。其中 NSUserDefaults 最輕量,操作直覺,適合存放設定值與小型狀態資料。
NSUserDefaults 只支援六種類型:Bool、Float、NSInteger、Object、Double 與 NSURL。超出這個範圍(例如想存 UIImage 或自訂模型)就必須先轉成 NSData 歸檔,或改用檔案系統與資料庫。
以下把它包成一個類方法式的工具類,讓呼叫端不必到處寫 standardUserDefaults。
#import <Foundation/Foundation.h>
@interface GNSUserDefaults : NSObject
+ (NSUserDefaults *)get_userDefaults;
#pragma mark - 寫入(僅支援六種類型)
+ (void)saveUserDefaults_Bool:(BOOL)objValue objKey:(NSString *)objKey;
+ (void)saveUserDefaults_Float:(float)objValue objKey:(NSString *)objKey;
+ (void)saveUserDefaults_Integer:(NSInteger)objValue objKey:(NSString *)objKey;
+ (void)saveUserDefaults_NSObject:(NSObject *)objValue objKey:(NSString *)objKey;
+ (void)saveUserDefaults_Double:(double)objValue objKey:(NSString *)objKey;
+ (void)saveUserDefaults_NSURL:(NSURL *)objValue objKey:(NSString *)objKey;
#pragma mark - 讀取
+ (BOOL)readUserDefaults_Bool:(NSString *)objKey;
+ (float)readUserDefaults_Float:(NSString *)objKey;
+ (NSInteger)readUserDefaults_Integer:(NSString *)objKey;
+ (id)readUserDefaults_Object:(NSString *)objKey;
+ (double)readUserDefaults_Double:(NSString *)objKey;
+ (NSURL *)readUserDefaults_URl:(NSString *)objKey;
@end
#import "GNSUserDefaults.h"
@implementation GNSUserDefaults
static NSUserDefaults *userDefaults;
+ (NSUserDefaults *)get_userDefaults {
if (!userDefaults) {
userDefaults = [NSUserDefaults standardUserDefaults];
}
return userDefaults;
}
#pragma mark - 寫入
// 注意:以下每個方法都在寫入後呼叫 synchronize 強制落盤
+ (void)saveUserDefaults_Bool:(BOOL)objValue objKey:(NSString *)objKey {
[[GNSUserDefaults get_userDefaults] setBool:objValue forKey:objKey];
[[GNSUserDefaults get_userDefaults] synchronize];
}
+ (void)saveUserDefaults_Float:(float)objValue objKey:(NSString *)objKey {
[[GNSUserDefaults get_userDefaults] setFloat:objValue forKey:objKey];
[[GNSUserDefaults get_userDefaults] synchronize];
}
+ (void)saveUserDefaults_Integer:(NSInteger)objValue objKey:(NSString *)objKey {
[[GNSUserDefaults get_userDefaults] setInteger:objValue forKey:objKey];
[[GNSUserDefaults get_userDefaults] synchronize];
}
+ (void)saveUserDefaults_NSObject:(NSObject *)objValue objKey:(NSString *)objKey {
[[GNSUserDefaults get_userDefaults] setObject:objValue forKey:objKey];
[[GNSUserDefaults get_userDefaults] synchronize];
}
+ (void)saveUserDefaults_Double:(double)objValue objKey:(NSString *)objKey {
[[GNSUserDefaults get_userDefaults] setDouble:objValue forKey:objKey];
[[GNSUserDefaults get_userDefaults] synchronize];
}
+ (void)saveUserDefaults_NSURL:(NSURL *)objValue objKey:(NSString *)objKey {
[[GNSUserDefaults get_userDefaults] setURL:objValue forKey:objKey];
[[GNSUserDefaults get_userDefaults] synchronize];
}
#pragma mark - 讀取
+ (BOOL)readUserDefaults_Bool:(NSString *)objKey {
return [[GNSUserDefaults get_userDefaults] boolForKey:objKey];
}
+ (float)readUserDefaults_Float:(NSString *)objKey {
return [[GNSUserDefaults get_userDefaults] floatForKey:objKey];
}
+ (NSInteger)readUserDefaults_Integer:(NSString *)objKey {
return [[GNSUserDefaults get_userDefaults] integerForKey:objKey];
}
+ (id)readUserDefaults_Object:(NSString *)objKey {
return [[GNSUserDefaults get_userDefaults] objectForKey:objKey];
}
+ (double)readUserDefaults_Double:(NSString *)objKey {
return [[GNSUserDefaults get_userDefaults] doubleForKey:objKey];
}
+ (NSURL *)readUserDefaults_URl:(NSString *)objKey {
return [[GNSUserDefaults get_userDefaults] URLForKey:objKey];
}
@end
移除某個鍵用 removeObjectForKey:;若要清空全部,則用 removePersistentDomainForName: 傳入 bundle identifier。
關於 synchronize:系統本身已會在恰當時機自動落盤,每次寫入都呼叫 synchronize 會造成不必要的 I/O。建議只在「重要狀態轉折點」呼叫,例如使用者登出、支付完成,或 App 即將進入背景時。
另外,NSUserDefaults 從來不是安全的儲存空間。它本質上是一個 plist 檔,越獄裝置或實體測試環境都能直接讀出內容,因此絕不要拿來存密碼、token 或任何敏感憑證,那些該放 Keychain。
最後,key 的命名建議加上統一前綴(例如 com.myapp.isLogin),因為 NSUserDefaults 是 App 全域共享的,一旦與第三方 SDK 撞名就會出現難以追查的互相覆蓋問題。