iOS技术

NSUserDefaults详解

2018-05-10  本文已影响0人  浅_若清风

概述：

NSUserDefaults,官网上的定义是一个用户默认数据库的接口，在应用程序的启动过程中，持久地存储键值对。每个应用都有一个（也只有一个）NSUserDefaults对象。向NSUserDefaults类发送standardUserDefaults消息可以得到该对象。使用时需要通过键来存取其保存的对象。此外，当应用第一次使用NSUserDefaults对象时，这个对象会自动地从特定文件读取数据；修改数据后，该对象也会自动地将数据写入文件。

NSUserDefaults支持的类型：

NSUserDefaults是一个单例，它可以用于数据的永久存储，适合存储轻量级的本地数据。通过NSUserDefaults对象存取数据时，使用的键必须是NSString对象，一个键对应一项设置（preference）。存取的对象必须是对象或者基本类型的数值。如果是对象，则必须是可序列化的（serializable）对象。通过NSUserDefaults类，知道NSUserDefaults支持的类型有NSString、NSData、NSNumber、NSDate、NSArray and NSDictionary。值得注意的是，NSUserDefaults 存储的对象全是不可变的（这一点非常关键，弄错的话程序会出bug），例如，如果想要存储一个NSMutableArray对象，则必须先创建一个不可变数组（NSArray）再将它存入NSUserDefaults中去。

键的命名约定：

应用名+设置名称+单词PrefKey

存储路径：

NSUserDefaults对象默认会将数据存入Library/Preferences目录，文件名就是程序包标识（bundle identifier），文件后缀是plist。当应用第一次调用NSUserDefaults类的standardUserDefaults方法时，NSUserDefaults会载入上述文件，让应用可以使用之前保存的所有设置。

NSUserDefaults的域：

UserDefaults数据库中其实是由多个层级的域组成的，当你读取一个键值的数据时，NSUserDefaults从上到下透过域的层级寻找正确的值，不同的域有不同的功能，有些域是可持久的，有些域则不行。默认包含五个Domain，如下：

1、参数域（ argument domain）有最高优先权

2、应用域（application domain）是最重要的域，它存储着你app通过NSUserDefaults set...forKey添加的设置

3、全局域（global domain）则存储着系统的设置

4、语言域（language-specific domains）则包括地区、日期等

5、注册域（registration domain）仅有较低的优先权，只有在应用域没有找到值时才从注册域去寻找

例如，当某个界面是第一次运行时，这时的key值（键）所对应的值还不存在，所以NSUserDefaults对象会使用默认值为0。但是对于某些设置，可能需要临时的、非0的默认值（如"出厂设置"），否则应用将无法正确的运行。一般默认值都是存放于注册域中。默认情况下，应用域是空的，没有键也没有值。当用户第一次修改某个设置时，相应的值会通过指定的键加入应用域。当通过NSUserDefaults对象获取某个设置的值时，该对象先会在应用域查找，如果没有，NSUserDefaults则会在注册域中查找并返回默认值。查询顺序：参数域 -> 应用域 -> 全局域 -> 语言域 ->注册域。

方法：

1、获取标准用户默认对象

standardUserDefaults

返回配置为搜索当前应用程序搜索列表的NSUserDefaults的全局实例

2、创建用户默认对象

- (instancetype)init;

用应用程序和当前用户的默认值初始化用户默认对象

- (nullableinstancetype)initWithSuiteName:(nullableNSString*)suitenameAPI_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0))NS_DESIGNATED_INITIALIZER;用指定数据库名称的默认值初始化用户默认对象

3、获取默认值

- (nullableid)objectForKey:(NSString*)defaultName;

返回与指定键关联的对象

- (nullableNSString*)stringForKey:(NSString*)defaultName;

返回与指定键关联的字符串

- (nullableNSArray*)arrayForKey:(NSString*)defaultName;

返回与指定键关联的数组

- (nullableNSDictionary *)dictionaryForKey:(NSString*)defaultName;

返回与指定键关联的字典对象

- (nullableNSData*)dataForKey:(NSString*)defaultName;

返回与指定键关联的数据对象

- (nullableNSArray *)stringArrayForKey:(NSString*)defaultName;

等效于-objectForKey

- (NSInteger)integerForKey:(NSString*)defaultName;

返回与指定键关联的整数值

- (float)floatForKey:(NSString*)defaultName;

返回与指定键关联的单精度浮点值

- (double)doubleForKey:(NSString*)defaultName;

返回与指定键关联的双精度浮点值

- (BOOL)boolForKey:(NSString*)defaultName;

返回与指定键关联的布尔值

- (nullableNSURL*)URLForKey:(NSString*)defaultNameAPI_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));

返回与指定键关联的URL

dictionaryRepresentation

返回包含搜索列表中域中所有键值对的联合的字典

4、设置默认值

- (void)setObject:(nullableid)value forKey:(NSString*)defaultName;

设置指定的默认键的值，value为要存储的对象，defaultName为指定的键

- (void)setInteger:(NSInteger)value forKey:(NSString*)defaultName;

设置指定的默认键的值，value为要存储的整数值，defaultName为指定的键

- (void)setFloat:(float)value forKey:(NSString*)defaultName;

设置指定的默认键的值，value为要存储的单精度浮点值，defaultName为指定的键

- (void)setDouble:(double)value forKey:(NSString*)defaultName;

设置指定的默认键的值，value为要存储的双精度浮点值，defaultName为指定的键

- (void)setBool:(BOOL)value forKey:(NSString*)defaultName;

设置指定的默认键的值，value为要存储的布尔值，defaultName为指定的键

- (void)setURL:(nullableNSURL*)url forKey:(NSString*)defaultNameAPI_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));

设置指定的默认键的值，url为要存储的URL，defaultName为指定的键

5、移除默认值

- (void)removeObjectForKey:(NSString*)defaultName;

移除指定的默认键的值

6、维护套间

- (void)addSuiteNamed:(NSString*)suiteName;

将指定的域名插入到接收方的搜索列表中

- (void)removeSuiteNamed:(NSString*)suiteName;

从接收器的搜索列表中移除指定的域名

7、注册默认值

- (void)registerDefaults:(NSDictionary *)registrationDictionary;

将指定字典的内容添加到注册域

8、维护持久域

- (NSArray*)persistentDomainNames API_DEPRECATED("Not recommended", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));

返回当前持久域名的数组（不推荐使用）

- (nullableNSDictionary *)persistentDomainForName:(NSString*)domainName;返回指定域默认值的字典表示形式

- (void)setPersistentDomain:(NSDictionary *)domain forName:(NSString*)domainName;

为指定的持久域设置字典

- (void)removePersistentDomainForName:(NSString*)domainName;

从用户的默认值中移除指定的持久域的内容

9、维护易失性域

volatileDomainNames

易失性域名

- (NSDictionary *)volatileDomainForName:(NSString*)domainName;

返回指定的易失性域的字典

- (void)setVolatileDomain:(NSDictionary *)domain forName:(NSString*)domainName;

为指定的易失性域设置字典

- (void)removeVolatileDomainForName:(NSString*)domainName;

从用户的默认值中移除指定的易失性域

10、访问托管环境密钥

- (BOOL)objectIsForcedForKey:(NSString*)key;

返回一个布尔值，该值指示指定密钥是否由管理员管理

- (BOOL)objectIsForcedForKey:(NSString*)key inDomain:(NSString*)domain;

返回一个布尔值，该值指示指定域中的密钥是否由管理员管理

11、域

NSString * const NSGlobalDomain

由所有应用程序所看到的默认值组成的域（全局域）

NSString * const NSArgumentDomain;

从应用程序的参数解析默认值组成的域（参数域）

NSString * const NSRegistrationDomain;

由一组临时缺省值组成的域，其值可以由应用程序设置，以确保搜索始终是成功的（注册域）

12、通知

NSUserDefaultsSizeLimitExceededNotification

当用户默认数据中存储更多数据时

NSUbiquitousUserDefaultsNoCloudAccountNotification

当设置了云默认时，但没有登录iCloud用户

NSUbiquitousUserDefaultsDidChangeAccountsNotification

当用户更改主iCloud帐户时

NSUbiquitousUserDefaultsCompletedInitialSyncNotification

发布时，默认完成下载数据，无论是第一次设备连接到一个iCloud帐户，或当用户切换他们的主要iCloud帐户

NSUserDefaultsDidChangeNotification

在当前进程中更改用户默认值时发布

13、遗弃的方法

+ (void)resetStandardUserDefaults;

释放标准用户默认值并将其设置为零（不推荐使用）

- (nullableid)initWithUser:(NSString*)usernameAPI_DEPRECATED("Use -init instead", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));

用应用程序和当前用户的默认值初始化用户默认对象，相当于- (instancetype)init方法（不推荐使用）

- (BOOL)synchronize;

等待默认数据库的任何挂起的异步更新并返回（不推荐使用）

14、遗弃的键值

日期和时间信息：

FOUNDATION_EXPORT NSString * const NSAMPMDesignation NS_DEPRECATED(10_0, 10_5, NA, NA);

用于指定打印上午和下午指定名称的值的键，它影响使用%P格式说明符的字符串

FOUNDATION_EXPORT NSString * const NSDateFormatString NS_DEPRECATED(10_0, 10_5, NA, NA);

格式化字符串的键，它指定如何使用日期格式说明符打印日期

FOUNDATION_EXPORT NSString * const NSDateTimeOrdering NS_DEPRECATED(10_0, 10_5, NA, NA);

字符串中指定如何在日期字符串中使用模糊数的键

FOUNDATION_EXPORT NSString * const NSEarlierTimeDesignations NS_DEPRECATED(10_0, 10_5, NA, NA);

表示过去时间的字符串数组的键

FOUNDATION_EXPORT NSString * const NSHourNameDesignations NS_DEPRECATED(10_0, 10_5, NA, NA);

识别时间的字符串的键

FOUNDATION_EXPORT NSString * const NSLaterTimeDesignations NS_DEPRECATED(10_0, 10_5, NA, NA);

表示未来时间的字符串数组的键

FOUNDATION_EXPORT NSString * const NSMonthNameArray NS_DEPRECATED(10_0, 10_5, NA, NA);

用于指定月份名称的值的键，它影响使用%B格式说明符的字符串

FOUNDATION_EXPORT NSString * const NSNextDayDesignations NS_DEPRECATED(10_0, 10_5, NA, NA);

表示今天后一天的字符串数组的键

FOUNDATION_EXPORT NSString * const NSNextNextDayDesignations NS_DEPRECATED(10_0, 10_5, NA, NA);

表示后天的字符串数组的键

FOUNDATION_EXPORT NSString * const NSPriorDayDesignations NS_DEPRECATED(10_0, 10_5, NA, NA);

表示今天前一天的字符串数组的键

FOUNDATION_EXPORT NSString * const NSShortDateFormatString NS_DEPRECATED(10_0, 10_5, NA, NA);

用于指定日期缩写的格式字符串的键

FOUNDATION_EXPORT NSString * const NSShortWeekDayNameArray NS_DEPRECATED(10_0, 10_5, NA, NA);

一个字符串数组的键，它指定一周中的缩写，影响使用%A格式说明符的字符串

FOUNDATION_EXPORT NSString * const NSShortMonthNameArray NS_DEPRECATED(10_0, 10_5, NA, NA);

用于指定月份的缩写的字符串数组的键，它影响使用%B格式说明符的字符串

FOUNDATION_EXPORT NSString * const NSShortTimeDateFormatString NS_DEPRECATED(10_0, 10_5, NA, NA);

用于指定时间和日期缩写的格式字符串的键

FOUNDATION_EXPORT NSString * const NSThisDayDesignations NS_DEPRECATED(10_0, 10_5, NA, NA);

一个字符串数组的键，它指定了这一天的名称

FOUNDATION_EXPORT NSString * const NSTimeDateFormatString NS_DEPRECATED(10_0, 10_5, NA, NA);

用于指定如何打印日期的值的键，它影响使用格式说明符%c、%x或%x的字符串

FOUNDATION_EXPORT NSString * const NSTimeFormatString NS_DEPRECATED(10_0, 10_5, NA, NA);

用于指定打印日期的格式字符串的键

FOUNDATION_EXPORT NSString * const NSWeekDayNameArray NS_DEPRECATED(10_0, 10_5, NA, NA);

用于指定星期数名称的字符串数组的键，它影响使用%A格式说明符的字符串

FOUNDATION_EXPORT NSString * const NSYearMonthWeekDesignations NS_DEPRECATED(10_0, 10_5, NA, NA);

一个字符串数组的键，它指定当前区域中的月份、月份和星期的单词

数值信息：

FOUNDATION_EXPORT NSString * const NSCurrencySymbol NS_DEPRECATED(10_0, 10_5, NA, NA);

指定用于表示该语言中货币的符号的字符串

FOUNDATION_EXPORT NSString * const NSDecimalSeparator NS_DEPRECATED(10_0, 10_5, NA, NA);

指定小数分隔符的字符串

FOUNDATION_EXPORT NSString * const NSThousandsSeparator NS_DEPRECATED(10_0, 10_5, NA, NA);

为十进制数的数千个位置指定分隔符的字符串

FOUNDATION_EXPORT NSString * const NSDecimalDigits NS_DEPRECATED(10_0, 10_5, NA, NA);

字符串，它标识除了或代替ASCII数字的小数位数

FOUNDATION_EXPORT NSString * const NSInternationalCurrencyString NS_DEPRECATED(10_0, 10_5, NA, NA);

遵循ISO 4217标准的包含三个字母缩写的字符串

FOUNDATION_EXPORT NSString * const NSPositiveCurrencyFormatString NS_DEPRECATED(10_0, 10_5, NA, NA);

指定货币值时如何打印正数的格式字符串

FOUNDATION_EXPORT NSString * const NSNegativeCurrencyFormatString NS_DEPRECATED(10_0, 10_5, NA, NA);

指定表示货币值时如何打印负数的格式字符串

案例：

//获取NSUserDefaults对象

NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];

//设置指定的默认键的值，TestMapTypePrefKey为指定的键  

1、设置指定的默认键的值

[defaults setObject:字符型 forKey:@"TestMapTypePrefKey"];  

2、整数值存储

[defaults setInteger: 整数值 forKey:@"TestMapTypePrefKey"]; 

3、单精度浮点值存储

[defaults setFloat: 单精度浮点值 forKey:@"TestMapTypePrefKey"];  

4、双精度浮点值存储

[defaults setDouble: 双精度浮点值 forKey:@"TestMapTypePrefKey"];  

5、布尔值存储

[defaults setBool: 布尔值 forKey:@"TestMapTypePrefKey"];  

6、URL存储

[defaults setURL: NSURL值 forKey:@"TestMapTypePrefKey"];

//同步存储(不建议使用)

[[NSUserDefaults standardUserDefaults] synchronize]；

//获取键值

1、返回与指定键关联的对象（ReturnType可以是NSDictionary、NSString等）

ReturnType *defaults = [[NSUserDefaults standardUserDefaults] objectForKey:@"TestMapTypePrefKey"];

2、返回与指定键关联的字符串

NSString *defaults = [[NSUserDefaults standardUserDefaults] stringForKey:@"TestMapTypePrefKey"];

3、返回与指定键关联的数组

NSArray *defaults = [[NSUserDefaults standardUserDefaults] arrayForKey:@"TestMapTypePrefKey"];

4、返回与指定键关联的字典对象

NSDictionary *defaults = [[NSUserDefaults standardUserDefaults] dictionaryForKey:@"TestMapTypePrefKey"];

5、返回与指定键关联的数据对象

NSData *defaults = [[NSUserDefaults standardUserDefaults] dataForKey:@"TestMapTypePrefKey"];

6、返回与指定键关联的整数值

NSInteger defaults = [[NSUserDefaults standardUserDefaults] integerForKey:@"TestMapTypePrefKey"];

7、返回与指定键关联的单精度浮点值

float defaults = [[NSUserDefaults standardUserDefaults] floatForKey:@"TestMapTypePrefKey"];

8、返回与指定键关联的双精度浮点值

double defaults = [[NSUserDefaults standardUserDefaults] doubleForKey:@"TestMapTypePrefKey"];

9、返回与指定键关联的布尔值

BOOL defaults = [[NSUserDefaults standardUserDefaults] boolForKey:@"TestMapTypePrefKey"];

10、返回与指定键关联的URL

NSURL *defaults = [[NSUserDefaults standardUserDefaults] URLForKey:@"TestMapTypePrefKey"];

11、返回包含搜索列表中域中所有键值对的联合的字典

NSDictionary* defaults = [[NSUserDefaults standardUserDefaults] dictionaryRepresentation]; 

//移除键值

[[NSUserDefaults standardUserDefaults] removeObjectForKey:@"TestMapTypePrefKey"];

以上是对NSUserDefaults的一点整理，若有不对，请各位大神指正。

上一篇下一篇

猜你喜欢

热点阅读