iOS开发:NSUserDefaults使用全解
在iOS开发过程中,进行数据本地存储是主要的模块之一,在进行数据存储的时候有多种情况,有些时候需要大型的数据存储,毋容置疑需要用FMDB等数据库存储方法;但是有些时候存储一些轻量级的数据,仅仅是存储一些用户的信息(用户ID、账号、密码、昵称等)简单数据,使用NSUserDefaults是首选,它是一个单例类,通过键值对的方式记录设置,用于数据的本地永久化存储,而且NSUserDefaults使用起来非常简单方便。那么本篇文章就来深入的探讨一下NSUserDefaults的使用。
一、NSUserDefaults的基本概念
简单来说,NSUserDefaults是iOS系统提供的一个单例类,在整个程序中只有一个实例对象,通过类方法standardUserDefaults可以获取NSUserDefaults单例。eg:NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
NSUserDefaults单例是以key-value的形式存储了一系列的偏好设置或者一些设置的记录,key是键名称,value是对应的数据。存/取数据时可以使用方法objectForKey:和setObject:forKey:来把对象存储到相应的plist文件中,或者读取。既然是plist文件,那么对象的类型则必须是plist文件可以存储的类型。
使用NSUserDefaults存储自定义对象需要注意的是,NSUserDefaults只支持以下数据类型的存储:NSString,NSDate,NSNumber(NSInteger、float、double),NSArray,NSDictionary,BOOL. 如果想要存储其他类型的数据,需要转换为前面的类型,才能用NSUserDefaults存储。注意:对相同的Key赋值约等于一次覆盖,要保证每一个Key的唯一性。
可是还需要注意一点:如果把一个自定义的类存到一个NSArray里,然后再存到NSUserDefaults里也是不能操作成功的。NSUserDefaults存储的对象全是不可变的(这一点非常重要),eg:如果我想存储一个NSMutableArray对象,我必须先创建一个不可变数组NSArray,再将它存入NSUserDefaults中去;eg:如果设置一个可变的字符串值作为"StringDefault”你日后检索字符串使用,stringForKey:会是一成不变的。
如果需要存储plist文件不支持的类型,比如图片,可以先将其归档为NSData类型,再存入plist文件,可是需要注意的是:即使对象是NSArray或NSDictionary,他们存储的类型也应该是以上范围所包括的。
二、NSUserDefaults的基本用法
1、NSUserDefaults的保存数据:
NSUserDefaults *userDefaults =[NSUserDefaults standardUserDefaults];
[userDefaults setObject:firstName forKey:@”kUserDefaultNameKey“];
NSInteger age = [defaults integerForKey:@“kUserDefaultAgeKey”]; //这里的NSInteger没有星号,是因为NSInteger是根据系统是64位还是32位来判断自身是long还是int的类型,并且它不是一个标准的Objective-C对象
//UIImage做本地存储的步骤,图片是通过归档为NSData的方式进行存储的
UIImage *image=[[UIImage alloc]initWithContentsOfFile:@"photo.jpg"];
NSData *imageData = UIImageJPEGRepresentation(image, 100);//把UIImage对象转换成NSData
[userDefaults synchronize];//用synchronize方法把数据持久化到standardUserDefaults数据库
2、NSUserDefaults的读取数据:
NSUserDefaults *userDefaults =[NSUserDefaults standardUserDefaults];
NSString *name = [userDefaults objectForKey:@"name"];//根据键值取出name
NSData *imageData = [userDefaults dataForKey:@"image"];
UIImage *Image = [UIImage imageWithData:imageData];//将NSData转换为UIImage
3、NSUserDefaults的清理数据:
![](https://i-blog.csdnimg.cn/blog_migrate/e3c32ed05789d220edf920e5281b8d11.jpeg)
//方法一:
[[NSUserDefaults standardUserDefaults] removeObjectForKey:key];
[[NSUserDefaults standardUserDefaults]synchronize];
//方法二:
// 先将本地存储转化为字典,然后用for in遍历删除即可
NSUserDefaults *userDefaults = [NSUserDefaults standardUserDefaults];
NSDictionary *dictionary = [userDefaults dictionaryRepresentation];
for(NSString *key in [dictionary allKeys]){
[userDefaults removeObjectForKey:key];
[userDefaults synchronize];
}
4、不同类型数据存取不同
NSUserDefaults提供了若干简便方法可以存储某些常用类型的值,eg:
- setBool:forKey:
- setFloat:forKey:
- setInteger:forKey:
- setDouble:forKey:
- setURL:forKey:
三、NSUserDefaults的相关类方法
// 同步对共享对象的任何的更改默认用户和从内存中释放它
resetStandardUserDefaults
// 返回共享默认对象
+ (NSUserDefaults *)standardUserDefaultsaddSuiteNamed:
// 插入到接收器的搜索列表中指定的域名
- (void)addSuiteNamed:( NSString *) suiteName
// 返回布尔值与指定键相关联
- (BOOL)boolForKey:( NSString *) defaultName
// 返回与指定键相关联的数组
- ( NSArray *)arrayForKey:( NSString *) defaultName
// 返回数据对象与指定键相关联
- ( NSData *)dataForKey:( NSString *) defaultName
// 返回Dictionary对象与指定键相关联
- ( NSDictionary *)dictionaryForKey:( NSString *) defaultName
// 返回一个字典,它包含在搜索列表中的域的所有键值对联合( NSData , NSString , NSNumber , NSDate ,NSArray,或者NSDictionary )
- ( NSDictionary *)dictionaryRepresentation
// 消除了在标准应用程序域指定的默认键值
- (void)removeObjectForKey:( NSString *) defaultName
// 删除指定的从用户的默认持久域的内容
- (void)removePersistentDomainForName:( NSString *) domainName
// 设置指定的默认键到指定的布尔值
- (void)setBool:(BOOL) value forKey:( NSString *) defaultName
// 设置为指定的字典持久域
- (void)setPersistentDomain:( NSDictionary *) domain forName:( NSString *) domainName
// 设置指定的默认键到指定的URL值
- (void)setURL:( NSURL *) url forKey:( NSString *) defaultName
// 设置为指定的字典挥发性域
- (void)setVolatileDomain:( NSDictionary *) domain forName:( NSString *) domainName
// 返回与指定键关联的字符串数组
- ( NSArray *)stringArrayForKey:( NSString *) defaultName
// 返回与指定键关联的字符串
- ( NSString *)stringForKey:( NSString *) defaultName
//返回NSURL实例与指定键相关联
- ( NSURL *)URLForKey:( NSString *) defaultName
// 返回double值与指定键相关联
- (double)doubleForKey:( NSString *) defaultName
// 返回浮点值与指定键相关联
- (float)floatForKey:( NSString *) defaultName
// 返回NSUserDefaults对象初始化的用户帐户的默认为指定的
- (id)initWithUser:( NSString *) username
// 返回整数值与指定键关联
- ( NSInteger NSInteger )integerForKey:( NSString *) defaultName
// 判断这个key是否存在
- (BOOL)objectIsForcedForKey:( NSString *) key
// 返回与指定默认的第一个发生关联的对象
- (id)objectForKey:( NSString *) defaultName
四、NSUserDefaults的域
BOOL showTutorialOnLaunch = [[NSUserDefaults standardUserDefaults] boolForKey:@"ShowTutorial"];
这种情况下,当key值@“ShowTutorial”已经设置后就会运行正确,但如果默认数据库没有这个key的默认值时,就返回NO,这或许就不一定是需要的值了,因为系统无法区分NO和no value。
以上解决方式:使用registerDefaults:方法。
首先创建一个包含用户偏好设置信息的DefaultPreferences.plist文件,添加到target中。在运行时,App就可加载这个文件并且把内容传到registerDefaults :
NSURL *defaultPrefsFile = [[NSBundle mainBundle]
URLForResource:@"DefaultPreferences" withExtension:@"plist"];
NSDictionary *defaultPrefs = [NSDictionary dictionaryWithContentsOfURL:defaultPrefsFile];
[[NSUserDefaults standardUserDefaults] registerDefaults:defaultPrefs];
注意:需要在每次启动app并且没有在defaules中读取数据的时候调用以上方法,因为registerDefaults:不能把这些默认数据存储到硬盘上,所以方法application:didFinishLaunchingWithOptions是最合适的位置。
这样做法的原因:默认情况下,应用域是空的,没见键也没有值。当应用第一次设置某项用户偏好设置的值时,相应的值会通过指定的键加入应用域。当通过NSUserDefaults获取某项用户偏好设置的值时,NSUserDefaults会先在应用域中查找,如果找到了值,NSUserDefaults就会返回这个值。如果没找到,NSUserDefaults就会在注册域中查找并返回默认值。
域:
user defaults数据库之中其实是由多个层级的域组成的,当你读取一个键值的数据时,NSUserDefaults从上到下透过域的层级寻找正确的值,不同的域有不同的功能,有些域是可持久的,有些域则不行。
应用域(application domain)是最重要的域,它存储着App通过NSUserDefaults set...forKey添加的设置;
注册域(registration domain)仅有较低的优先权,只有在应用域没有找到值时才从注册域去寻找;
全局域(global domain)是存储着系统的设置;
语言域(language-specific domains)包括地区、日期等;
参数域( argument domain)有最高优先权。