【OC数据持久化】：NSUserDefaults

目录
一、NSUserDefaults的基本使用
二、使用NSUserDefaults需注意

一、NSUserDefaults的基本使用

NSUserDefaults专门用来把偏好设置数据存储在Library/Preferences文件夹下，其实NSUserDefaults本质上是一个字典，偏好设置数据就存储在这个字典里，字典又会被存储在Library/Preferences文件夹下的一个plist文件里，也就是说NSUserDefaults这个类其实只是给我们提供了更加方便的方式去存储和读取数据而已。

存储和读取基本数据类型的数据

- (void)setBool:(BOOL)value forKey:(NSString *)defaultName;
- (void)setInteger:(NSInteger)value forKey:(NSString *)defaultName;
- (void)setFloat:(float)value forKey:(NSString *)defaultName;
- (void)setDouble:(double)value forKey:(NSString *)defaultName;

- (BOOL)boolForKey:(NSString *)defaultName;
- (NSInteger)integerForKey:(NSString *)defaultName;
- (float)floatForKey:(NSString *)defaultName;
- (double)doubleForKey:(NSString *)defaultName;

存储和读取系统自带对象类型的数据（NSString、NSArray、NSDictionary、NSData等）

- (void)setObject:(nullable id)value forKey:(NSString *)defaultName;
- (id)objectForKey:(NSString *)defaultName;

存储和读取自定义对象类型的数据

使用NSUserDefaults存储自定义对象类型的数据时，必须先把对象归档为NSData，然后再存进去，读取的时候也必须先读取出NSData，然后再反归档为对象。

举个例子，假设有个Person类。

-----------Person.h-----------

#import <Foundation/Foundation.h>

@interface Person : NSObject

@property (nonatomic, copy) NSString *name;
@property (nonatomic, copy) NSString *sex;
@property (nonatomic, assign) NSInteger age;

@end


-----------Person.m-----------

#import "Person.h"

@implementation Person

@end

我们创建了一个person对象，并且想把它持久化在NSUserDefaults中。

-----------ViewController.m-----------

- (void)viewDidLoad {
    [super viewDidLoad];
    
    Person *person = [[Person alloc] init];
    person.name = @"张三";
    person.sex = @"男";
    person.age = 11;
    [[NSUserDefaults standardUserDefaults] setObject:person forKey:@"person"];
}

运行，崩了，控制台输出'Attempt to insert non-property list object <Person: 0x600001536f20> for key person'，说是我们试图给person这个key赋值一个person对象，但是这个person对象不是一个plist object。现在我们为person对象添加一下归档、反归档。

-----------ViewController.m-----------

- (void)viewDidLoad {
    [super viewDidLoad];
    
    Person *person = [[Person alloc] init];
    person.name = @"张三";
    person.sex = @"男";
    person.age = 11;
    
    // 归档
    NSData *writeData = [NSKeyedArchiver archivedDataWithRootObject:person];
    // 存储
    [[NSUserDefaults standardUserDefaults] setObject:writeData forKey:@"person"];
    
    // 读取
    NSData *readData = [[NSUserDefaults standardUserDefaults] objectForKey:@"person"];
    // 反归档
    Person *man = [NSKeyedUnarchiver unarchiveObjectWithData:readData];
    
    NSLog(@"%@ %@ %ld", man.name, man.sex, man.age);
}

运行，又崩了，控制台输出'-[Person encodeWithCoder:]: unrecognized selector sent to instance 0x600001e810e0'，说是person对象没有实现encodeWithCoder:方法。这是因为在归档的过程中，系统会自动调用对象的encodeWithCoder:方法，这个方法存在于NSCoding协议里，我们要在这个方法里告诉系统对象的哪些属性需要归档并一一encode掉。现在我们为person对象实现一下encodeWithCoder:方法。

-----------Person.m-----------

#import "Person.h"

@interface Person () <NSCoding>

@end

@implementation Person

- (void)encodeWithCoder:(NSCoder *)aCoder {
    [aCoder encodeObject:_name forKey:@"name"];
    [aCoder encodeObject:_sex forKey:@"sex"];
    [aCoder encodeObject:@(_age) forKey:@"age"];
}

@end

运行，又崩了，控制台输出'-[Person initWithCoder:]: unrecognized selector sent to instance 0x600001e810e0'，说是person对象没有实现initWithCoder:方法。这是因为在反归档的过程中，系统会自动调用对象的initWithCoder:方法，这个方法也存在于NSCoding协议里，我们要在这个方法里告诉系统对象的哪些属性需要反归档并一一decode掉。现在我们为person对象实现一下initWithCoder:方法。

-----------Person.m-----------

#import "Person.h"

@interface Person () <NSCoding>

@end

@implementation Person

- (void)encodeWithCoder:(NSCoder *)aCoder {
    [aCoder encodeObject:_name forKey:@"name"];
    [aCoder encodeObject:_sex forKey:@"sex"];
    [aCoder encodeObject:@(_age) forKey:@"age"];
}

- (instancetype)initWithCoder:(NSCoder *)aDecoder {
    if (self = [super init]) {
        _name = [aDecoder decodeObjectForKey:@"name"];
        _sex = [aDecoder decodeObjectForKey:@"sex"];
        _age = [[aDecoder decodeObjectForKey:@"age"] integerValue];
    }
    return self;
}

@end

运行，ok了。

通过上面的例子，我们可能会感觉到使用NSUserDefaults存储自定义对象类型的数据时的归档和反归档操作有些麻烦，麻烦一在于我们要写对象归档为NSData和NSData反归档为对象的代码，麻烦二在于我们要为对象实现NSCoding协议里的encodeWithCoder:和initWithCoder:方法。

因此为了简化开发，针对麻烦一，我们可以考虑给NSUserDefaults添加一个分类为它扩展一对儿存取对象的方法，在方法内部完成对象归档为NSData和NSData反归档为对象的代码；针对麻烦二，我们不可能为项目里每个需要持久化的对象都让它的类遵守NSCoding协议并实现协议里的encodeWithCoder:和initWithCoder:方法，所以我们可以考虑为根类NSObject添加一个分类，在分类里为NSObject扩展遵守NSCoding协议并实现协议里的encodeWithCoder:和initWithCoder:方法，而且在协议方法的实现里我们还要用Runtime获取属性列表来做encode和decode，这将极大地提升我们的开发效率。

二、使用NSUserDefaults需注意

需要注意的是，当我们往NSUserDefaults里存储一个数据的时候，它不是立马就存储进Library/Preferences文件夹下的plist文件里，而是会先存储在NSUserDefaults的cache里，然后每隔一定的时间再统一将cache里的数据统一存储进plist文件，所以我们存取数据就有可能出错。

为了确保NSUserDefaults立马把数据存储进plist文件里，我们在set完数据后最好手动调用一下[[NSUserDefaults standardUserDefaults] synchronize]方法。