NSUserDefaults 類別提供了一組與系統預設資料庫互動的程式化介面,用來保存與還原 App 的偏好設定與組態資料。系統允許 App 依使用者喜好調整行為,你可以在程式執行期間隨時從這個資料庫讀取設定。它內建快取,避免每次讀取都要開啟資料庫;需要寫回時呼叫 synchronize 即可。
這個類別提供了方便的讀寫方法:setBool:forKey:、setFloat:forKey:、setInteger:forKey:、setObject:forKey:、setDouble:forKey:、setURL:forKey:。具體用哪一個取決於要存的型別;其中 setObject:forKey: 用於儲存 NSString、NSDate、NSArray、NSDictionary 等複合物件。
NSUserDefaults 是單例,也是執行緒安全的:
NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults]; [userDefaults setBool:self.toggleSwitch.on forKey:kOnOffToggle]; [userDefaults setFloat:self.brightnessSlider.value forKey:kBrightnessLevel];
注意:寫入後資料未必立刻落盤,建議補上一行確保及時保存:
[userDefaults synchronize];
讀取時依型別選擇對應方法:arrayForKey、boolForKey、dateForKey、dictionaryForKey、floatForKey、integerForKey、objectForKey、doubleForKey、URLForKey。
NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults]; self.brightnessSlider.value = [userDefaults floatForKey:kBrightnessLevel]; self.toggleSwitch.on = [userDefaults boolForKey:kOnOffToggle];
NSUserDefaults 最終會把資料存成 plist 屬性列表,因此支援的型別固定為:NSNumber(Integer / Float / Double)、NSString、NSDate、NSArray、NSDictionary 與 BOOL。它適合存放輕量級的本地資料,例如登入畫面的使用者名稱;由於不用自行建立與讀取檔案,使用起來就像讀字串一樣直覺。
ViewController.h 中放幾個 label 用來顯示讀回的值:
#import <UIKit/UIKit.h>
@interface ViewController : UIViewController {
IBOutlet UILabel *txtInteger;
IBOutlet UILabel *txtFloat;
IBOutlet UILabel *txtDouble;
IBOutlet UILabel *txtNSString;
IBOutlet UILabel *txtNSDate;
IBOutlet UILabel *txtNSArray;
IBOutlet UILabel *txtNSDictionary;
}
@end
ViewController.m 中最關鍵的是 saveNSUserDefaults 與 readNSUserDefaults 兩個方法,在 viewDidLoad 中依序呼叫即可看到結果:
#import "ViewController.h"
@implementation ViewController
- (void)viewDidLoad {
[super viewDidLoad];
[self saveNSUserDefaults]; // 寫入各型別資料
[self readNSUserDefaults]; // 讀回各型別資料
}
// 儲存資料到 NSUserDefaults
- (void)saveNSUserDefaults {
NSString *myString = @"enuola";
int myInteger = 100;
float myFloat = 50.0f;
double myDouble = 20.0;
NSDate *myDate = [NSDate date];
NSArray *myArray = [NSArray arrayWithObjects:@"hello", @"world", nil];
NSDictionary *myDictionary = [NSDictionary dictionaryWithObjects:
[NSArray arrayWithObjects:@"enuo", @"20", nil]
forKeys:[NSArray arrayWithObjects:@"name", @"age", nil]];
NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
// 基本型別各有專用方法
[userDefaults setInteger:myInteger forKey:@"myInteger"];
[userDefaults setFloat:myFloat forKey:@"myFloat"];
[userDefaults setDouble:myDouble forKey:@"myDouble"];
// 其餘物件型別統一用 setObject:forKey:
[userDefaults setObject:myString forKey:@"myString"];
[userDefaults setObject:myDate forKey:@"myDate"];
[userDefaults setObject:myArray forKey:@"myArray"];
[userDefaults setObject:myDictionary forKey:@"myDictionary"];
[userDefaults synchronize]; // 建議同步落盤
}
// 從 NSUserDefaults 讀取資料
- (void)readNSUserDefaults {
NSUserDefaults *ud = [NSUserDefaults standardUserDefaults];
NSInteger myInteger = [ud integerForKey:@"myInteger"];
txtInteger.text = [NSString stringWithFormat:@"%d", myInteger];
float myFloat = [ud floatForKey:@"myFloat"];
txtFloat.text = [NSString stringWithFormat:@"%f", myFloat];
double myDouble = [ud doubleForKey:@"myDouble"];
txtDouble.text = [NSString stringWithFormat:@"%f", myDouble];
NSString *myString = [ud stringForKey:@"myString"];
txtNSString.text = myString;
NSDate *myDate = [ud objectForKey:@"myDate"];
NSDateFormatter *df = [[NSDateFormatter alloc] init];
[df setDateFormat:@"yyyy-MM-dd HH:mm:ss"];
txtNSDate.text = [df stringFromDate:myDate];
NSArray *myArray = [ud arrayForKey:@"myArray"];
NSMutableString *arrayString = [NSMutableString string];
for (NSString *str in myArray) {
[arrayString appendFormat:@" %@", str];
}
txtNSArray.text = arrayString;
NSDictionary *myDictionary = [ud dictionaryForKey:@"myDictionary"];
txtNSDictionary.text = [NSString stringWithFormat:@"name:%@, age:%d",
[myDictionary valueForKey:@"name"],
[[myDictionary valueForKey:@"age"] integerValue]];
}
@end
執行後可以看到 xib 上的各個 label 都已經綁上了對應資料。

用上面範例儲存後,可以到模擬器的 Library/Preferences 目錄下找到對應的 plist 檔,位置類似:
/Users/Library/Application Support/iPhone Simulator/4.1/Applications/***...***/Library/Preferences/com.xxx.xxx.plist
這也解釋了為何 Apple 文件會建議:不要直接建立偏好設定檔,一律透過 NSUserDefaults 類別或 CFPreferences API 存取。另外,Documents 目錄會被 iTunes 備份,Library/Preferences 同樣會被備份;而 Library/Caches 則不會。