【iOS】iOS持久化

1 持久化目的

1. 快速展示，提升体验
   • 已经加载过的数据，用户下次查看时，不需要再次从网络（磁盘）加载，直接展示给用户
2. 节省用户流量（节省服务器资源）
   • 对于较大的资源数据进行缓存，下次展示无需下载消耗流量
   • 同时降低了服务器的访问次数，节约服务器资源。（图片）
3. 离线使用。
   • 用户浏览过的数据无需联网，可以再次查看。
   • 部分功能使用解除对网络的依赖。（百度离线地图、图书阅读器）
   • 无网络时，允许用户进行操作，等到下次联网时同步到服务端。
4. 记录用户操作
   • 草稿：对于用户需要花费较大成本进行的操作，对用户的每个步骤进行缓存，用户中断操作后，下次用户操作时直接继续上次的操作。
   • 已读内容标记缓存，帮助用户识别哪些已读。
   • 搜索记录缓存

2 数据持久化方式分类

2.1 内存缓存

• 定义
  对于使用频率比较高的数据，从网络或者磁盘加载数据到内存以后，使用后并不马上销毁，下次使用时直接从内存加载。
• 案例
  iOS系统图片加载——[UIImage imageNamed:@"imageName"]
  网络图片加载三方库：SDWebImage
• 实现
  实现内存缓存的技术手段包括苹果官方提供的NSURLCache，NSCache，还有性能和API上比较有优势的开源缓存库YYCache、PINCache等。

2.2 磁盘缓存

• 定义
  将从网络加载的、用户操作产生的数据写入到磁盘，用户下次查看、继续操作时，直接从磁盘加载使用。
• 案例
  用户输入内容草稿缓存（如：评论、文本编辑）
  网络图片加载三方库：SDWebImage
  搜索历史缓存
• 实现
  1. NSUserDefault
     适合小规模数据，弱业务相关数据的缓存。
  2. keychain
Keychain是苹果提供的带有可逆加密的存储机制，普遍用在各种存用户名、密码的需求上。另外，Keychain是系统级存储，还可以被iCloud同步，即使App被删除，Keychain数据依然保留，用户下次安装App，可以直接读取，通常会用来存储用户唯一标识串。所以需要加密、同步iCloud的敏感小数据，一般使用Keychain存取。
  3. 文件存储
     • Plist：一般结构化的数据可以Plist的方式去持久化
     • archive：Archive方式可以存取遵循协议的数据，比较方便的是存取使用的都是对象，不过中间的序列化和反序列化需要花费一定的性能，可以在想要使用对象直接进行磁盘存取时使用。
     • Stream：指文件存储，一般用来存图片、视频文件等数据
  4. 数据库存储
     数据库适合存取一些关系型的数据；可以在有大量的条件查询排序类需求时使用。
     • Core Data：苹果官方封装的ORM(Object Relational Mapping)
     • FMDB：github最受欢迎的iOS sqlite 封装开源库之一
     • WCDB：微信团队在自己使用的sqlite封装基础上的开源实现，具有ORM(Object Relational Mapping)的特性，支持iOS、Android。
     • Realm：由Y Combinator孵化的创业团队开源出来的一款跨平台（iOS、Android）移动数据库。

2.3 应该用哪种缓存方案

根据需求选择：

• 简单数据存储直接写文件、key-value存取即可。
• 需要按照一些条件查找、排序等需求的，可以使用sqlite等关系型存储方式。
• 不希望App删除后清除的小容量数据（用户名、密码、token）存keychain。

3 沙盒机制介绍

iOS中的沙盒机制是一种安全体系。为了保证系统安全，iOS每个应用程序在安装时，会创建属于自己的沙盒文件（存储空间）。应用程序只能访问自身的沙盒文件，不能访问其他应用程序的沙盒文件，当应用程序需要向外部请求或接收数据时，都需要经过权限认证，否则，无法获取到数据。所有的非代码文件都要保存在此，例如属性文件plist、文本文件、图像、图标、媒体资源等。

3.1 沙盒机制与持久化的关系

iOS 中的持久化是指将数据在应用程序退出后仍然保留在存储设备上的能力。而沙盒机制是 iOS 系统为每个应用程序提供的安全性措施，通过将每个应用程序限制在自己的沙盒中，确保应用程序只能访问自己的数据，并不能访问其他应用程序的数据。

持久化和沙盒机制在 iOS 应用程序中是密切相关的，因为应用程序需要在沙盒中对数据进行持久化。iOS 提供了几种方式来实现数据持久化，而所有这些方式都是在应用程序的沙盒内进行的。以下是 iOS 持久化与沙盒机制的关系：

• 文件储存持久化: 在 iOS 应用程序中，可以使用文件系统来持久化数据，例如将数据保存到文件中。iOS 应用程序只能在自己的沙盒目录中创建、读取和写入文件，不能访问其他应用程序的文件。常见的文件系统持久化方式包括使用 NSFileManager 类进行文件操作，或者使用 NSData 或 NSString 类的方法将数据写入文件。
• UserDefaults 持久化: NSUserDefaults 是一种简单的持久化方式，可以用于保存用户的偏好设置、配置信息等。虽然数据是持久化的，但是它们仍然存储在应用程序的沙盒中，并且只能被当前应用程序访问。
• 数据库持久化:它将数据保存到 SQLite 数据库中或其他数据存储。这些也是在应用程序的沙盒内进行数据持久化的方式。
• Keychain 持久化: Keychain 是 iOS 提供的一种安全存储敏感数据的方式，例如密码、密钥等。Keychain 中的数据也是在应用程序的沙盒内进行持久化，并且具有更高的安全性保护，确保只有应用程序本身才能访问这些数据。

总的来说，iOS中的持久化操作都是在应用程序的沙盒内进行的，受到沙盒机制的限制，确保应用程序只能访问自己的数据，保证了应用程序之间的数据隔离和安全性。

3.2 沙盒的目录结构

3.2.1 获取应用程序的沙盒路径:

// 获取沙盒根目录路径
    NSString *path = NSHomeDirectory();

注意： 每次编译代码会生成新的沙盒路径，注意是编译不是启动，所以模拟机或者真机运行，每次运行所得到的沙盒路径都是不一样的，线上版本app真机不会生成新的沙盒路径。

上面的代码得到的就是当前应用程序目录的路径，该目录下就是应用程序的沙盒，在该目录下有4个文件夹：Documents、Library、SystemData、tmp，当前应用程序只能访问该目录下的文件。

3.2.2 访问沙盒目录常用C函数介绍

//文件路径搜索
FOUNDATION_EXPORT NSArray<NSString *> *NSSearchPathForDirectoriesInDomains(NSSearchPathDirectory directory, NSSearchPathDomainMask domainMask, BOOL expandTilde);

该方法返回值为一个数组，在iphone中由于只有一个唯一路径，所以直接取数组第一个元素即可。

该函数的作用是返回指定搜索目录下的路径数组。它接受三个参数：

1. directory：NSSearchPathDirectory 类型的枚举值，用于指定搜索的目录。常见的枚举值包括：

//常用的NSSearchPathDirectory枚举值
typedef NS_ENUM(NSUInteger, NSSearchPathDirectory) {
    
    
    NSApplicationDirectory = 1,             // supported applications (Applications)
    NSDemoApplicationDirectory,             // unsupported applications, demonstration versions (Demos)
    NSAdminApplicationDirectory,            // system and network administration applications (Administration)
    NSLibraryDirectory,                     // various documentation, support, and configuration files, resources (Library)
    NSUserDirectory,                        // user home directories (Users)
    NSDocumentationDirectory,               //  Library 下的(Documentation)模拟器上没有创建
    NSDocumentDirectory,                    // documents (Documents)
};

2. domainMask：NSSearchPathDomainMask 类型的位掩码，用于指定搜索路径的范围。常见的枚举值包括：

typedef NS_OPTIONS(NSUInteger, NSSearchPathDomainMask) {
    
    
    NSUserDomainMask = 1,       // 用户目录 - 基本上就用这个。 
    NSLocalDomainMask = 2,      // 本地
    NSNetworkDomainMask = 4,    // 网络 
    NSSystemDomainMask = 8,     // 系统
    NSAllDomainsMask = 0x0ffff  // 所有 
};

3. expandTilde：BOOL 类型的参数，指定是否展开波浪号~。如果设置为 YES，则路径中的波浪号~将被展开为用户的主目录路径。

该值为NO：Caches目录路径为~/Library/Caches
该值为YES：Caches目录路径为/var/mobile/Containers/Data/Application/E7B438D4-0AB3-49D0-9C2C-B84AF67C752B/Library/Caches

3.2.3 沙盒目录的获取示例

//获取沙盒根路径
NSString *path = NSHomeDirectory();
NSLog(@"沙盒根路径：%@", path);
//Document路径
NSString *docDir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
NSLog(@"Document目录路径：%@", docDir);
// 获取Library的目录路径
NSString *libDir = [NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES) lastObject];
NSLog(@"Libarary目录路径：%@", libDir);
// 获取Caches目录路径
NSString *cachesDir = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) firstObject];
NSLog(@"Cacheas目录路径：%@", cachesDir);
// library Preference
NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
NSLog(@"偏好设置目录路径：%@", defaults);
// 获取tmp目录路径
NSString *tmpDir =  NSTemporaryDirectory();
NSLog(@"tmp目录路径：%@", tmpDir);

输出结果：

3.2.4 沙盒目录介绍

• Documents：保存持久化数据，会备份。一般用来存储需要持久化的数据。
  一般我们在项目中，我们会把一些用户的登录信息以及搜索历史记录等一些关键数据存储到这里。

// 获取Documents目录路径
NSString *docDir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];

此文件夹是默认备份的，备份到iCloud。
注：iCloud的备份，会通过Wi-Fi每天自动备份用户iOS设备。
我们可以在获取到的路径结尾加一个字符串来创建一个文件名：

NSString *filename = [docDir stringByAppendingPathComponent:@"data.txt"];

这样我们的这个filename就是一个完整的.txt类型文件的目录了。

• Library：默认存放设置和其他状态信息，除了caches子目录之外其他目录都会被iclude同步。
  • Application Support：此目录包含应用程序用来运行但应对用户隐藏的文件，如游戏的新关卡等文件。
  • Caches：保存应用运行时生成的需要持久化的数据，一般存储体积大、不需要备份的非重要数据，如网络请求的音视频与图片等的缓存。在 iOS 5.0 及以后版本中，Caches 当系统磁盘空间非常低时，系统可能会在极少数情况下该删除目录（APP 正在运行时不会发生），所以尽量保证该路径的文件在 APP 在重新运行时可以得到重新创建。
  • Cooikes：系统会自动将App中网络请求的cookie保存为文件。
  • Preferences：保存应用的所有偏好设置。UserDefaults 生成的 plist 文件就会保存该目录下。
  • SplashBoard：存储启动屏缓存，缓存文件格式为 ktx，本质上就是图片，如果启动屏不生效的问题可以考虑从删除该路径下相关缓存文件这个角度解决。
• SystemData：存放系统数据，无对外暴露的接口。
• tmp：临时文件夹(系统会不定期删除里面的文件)。

4 持久化数据存储方式

4.1 plist文件（序列化）

plist文件是通过XML文件的方式保存在目录中 以下类型可以被序列化：

NSString;//字符串
NSMutableString;//可变字符串
NSArray;//数组
NSMutableArray;//可变数组
NSDictionary;//字典
NSMutableDictionary;//可变字典
NSData;//二进制数据
NSMutableData;//可变二进制数据
NSNumber;//基本数据
NSDate;//日期

这里我们就用NSDictionary当例子,其他的类型和这个方法类似:

- (void) writeToPlist {
    
    
    // 定义plistName
    NSString *plistName = @"test.plist";
    // 存取路径
    NSString *path = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
    // 打印路径
    NSLog(@"%@", path);
    // 连接路径
    NSString *filePath = [path stringByAppendingPathComponent:plistName];
    
    // 定义字典文件
    NSDictionary *dict = @{
    
    @"SXTTTTT":@"10"};
    
    //序列化
    [dict writeToFile:filePath atomically:YES];
}

atomically是否先写入辅助文件,增加安全性的写入文件方法,一般都是YES。

前往打印出的路径查看，发现确实多了一个test.plist文件。

打开这个文件看看。

可以看到值确实储存到了这个文件内部。

使用dictionaryWithContentsOfFile:类方法可以取出这个值：

    NSDictionary *dict1 = [NSDictionary dictionaryWithContentsOfFile:filePath];
    NSLog(@"%@", dict1);

结果：

4.2 preference:偏好设置

偏好设置（Preferences）是 iOS 开发中一种简单的数据持久化方式，用于保存应用程序的配置信息、用户偏好设置等数据。在 iOS 中，可以使用 NSUserDefaults 类来进行偏好设置的读取和保存。

NSUserDefaults 是一个单例类，用于访问应用程序的偏好设置。它可以存储各种类型的数据，如布尔值、整数、浮点数、字符串、数组、字典等。这些数据将会持久化到应用程序的沙盒中，即使应用程序退出，下次启动时也可以读取这些数据。

NSUserDefaults：简单数据快速读写，不能存储自定义类型。
UserDefaults设置数据时，不是立即写入，而是根据时间戳定时地把缓存中的数据写入本地磁盘。所以调用了set方法之后数据有可能还没有写入磁盘应用程序就终止了。出现以上问题，可以通过调用synchornize方法[defaults synchornize];强制写入。

偏好设置存储的优点：

• 不需要关心文件名，系统会自动帮你生成一个文件名。
• 快速做键值对的存储。

我们来尝试使用使用UserDefaults注册一个账号密码

- (void)writeToUserDefaults {
    
    
    // 获取偏好设置对象
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    
    // 存储数据
    [defaults setObject:@"ouhaijian" forKey:@"name"];
    [defaults setObject:@"666666" forKey:@"password"];
    
    // 同步调用，立刻写到文件中，不写这个方法会异步，有延迟
    [defaults synchronize];
}
- (void)readFromUserDefaults {
    
    
    // 获取偏好设置对象
    NSUserDefaults *defaults = [NSUserDefaults standardUserDefaults];
    
    // 获取数据
    NSString *name = [defaults objectForKey:@"name"];
    NSString *password = [defaults objectForKey:@"password"];
    
    NSLog(@"name:%@", name);
    NSLog(@"password:%@", password);
}

运行结果：

注意，对于设置偏好设置值后，需要调用 synchronize 方法来立即将数据保存到磁盘中，以确保数据持久化。不过，iOS 7 及以上版本，synchronize 方法会自动在合适的时机将数据保存，所以不再是必需的操作。

我们到cd到沙盒中的preference文件目录，可以看到里面多了一个新的文件，这个文件里面储存的就是我们储存的账号。

打开这个文件看看。

4.3 NSKeyedArchiver归档和解档

NSKeyedArchiver(归档)：归档一般都是保存自定义对象的时候，使用归档。因为plist文件不能够保存自定义对象。如果一个字典中保存有自定义对象，如果把这个对象写入到文件当中，它是不会生成 plist文件的。如果对象是NSString、NSDictionary、NSArray、NSData、NSNumber等类型，可以直接用NSKeyedArchiver进行归档和恢复。

但是在我们使用归档之前，我们必须得遵守NSSecureCoding协议才行，老版本只需要遵循NSCoding实现其归档和解档的方法就行，但是iOS13更新之后就不行了，我们就必须的遵守NSSecureCoding协议，NSSecureCoding协议也遵循了原来NSCoding这个协议，不过我们还需要遵循它的一个supportsSecureCoding方法，这样我们才能归档成功。

因为NSSecureCoding协议也遵循了原来NSCoding这个协议，所以他也就有了- (void)encodeWithCoder:(NSCoder *)coder方法和- (id)initWithCoder:(NSCoder *)coder方法：

-(void)encodeWithCoder:(NSCoder *)coder，每次归档对象时，都会调用这个方法。一般在这个方法里面指定如何归档对象中的每个实例变量。可以使用encodeObject:forKey:方法归档实例变量。

-(id)initWithCoder:(NSCoder *)coder，每次从文件中会恢复（解码）对象时，都会调用这个方法。一般在这个方法里面指定如何解码文件中的数据为对象的实例变量，可以使用decodeObject:forKey方法解码实例变量。

例，新建一个SXPerson类：

#import <Foundation/Foundation.h>

@interface SXPerson : NSObject <NSSecureCoding>
@property (nonatomic, strong) NSString *name;
@property (nonatomic, assign) int age;
@end

@implementation SXPerson
- (void)encodeWithCoder:(NSCoder *)coder {
    
    
    [coder encodeObject:self.name forKey:@"name"];
    [coder encodeInt:self.age forKey:@"age"];
}

- (id)initWithCoder:(NSCoder *)coder {
    
    
    if (self = [super init]) {
    
    
        self.name = [coder decodeObjectForKey:@"name"];
        self.age = [coder decodeIntForKey:@"age"];
    }
    return self;
}

+ (BOOL)supportsSecureCoding {
    
    
    return YES;
}
@end

进行归档和解档：

// 归档
- (void)writeUseNSKeyedArchiver {
    
    
    SXPerson *person = [[SXPerson alloc] init];
    person.age = 10;
    person.name = @"蔡徐坤";
    NSError * __autoreleasing *error = NULL;
    
    // 获得Document的全路径
    NSString *docu = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
    // 获得新文件的全路径
    NSString *path = [docu stringByAppendingPathComponent:@"SXPerson.data"];
    // 将对象封装为Data并归档
    NSData *data = [NSKeyedArchiver archivedDataWithRootObject:person requiringSecureCoding:YES error:error];
    if (error) {
    
    
        NSLog(@"writeUseNSKeyedArchiver:%@", *error);
    } else {
    
    
        [data writeToFile:path atomically:YES];
    }
}

// 解档
- (void)readUseNSKeyedArchiver {
    
    
    NSError * __autoreleasing *error = NULL;
    // 获得Document的全路径
    NSString *docu = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
    // 获得新文件的全路径
    NSString *path = [docu stringByAppendingPathComponent:@"SXPerson.data"];
    // 从path路径中获取data数据
    NSData *unData = [NSData dataWithContentsOfFile:path];
    // 创建解档操作的客户端允许的类集合
        // 这个集合应包括自定义对象的属性的类
    NSSet *allowedClassesSet = [NSSet setWithObjects:[NSString class], [SXPerson class], nil];
    SXPerson *person = (SXPerson *)[NSKeyedUnarchiver unarchivedObjectOfClasses:allowedClassesSet fromData:unData error:error];
    // 打印结果
    if (error) {
    
    
        NSLog(@"readUseNSKeyedArchiver:%@", *error);
    } else {
    
    
        NSLog(@"%@-%d", person.name, person.age);
    }
}

创建解档操作的客户端允许的类集合，这个集合应包括自定义对象的属性的类，否则会给出警告。这个警告并不会导致解档操作出错，但是在将来的版本中可能会被禁止。为了避免将来的兼容性问题，建议您在解档时将需要解档的所有类都添加到客户端允许的类集合中。

结果：

我们还可以看到Document目录下多了一个SXStudent.data文件:

可以使用vim打开这个文件看一下，大概能看懂是储存了NSKeyedArchiver归档的一个对象：

最后另外说一点，归档操作有时会被用于实现对象（尤其是自定义对象）的深拷贝操作。通过归档，我们可以将原对象序列化为二进制数据，并在反归档时重新创建出一个全新的对象，包括其内部引用对象。这样，新对象与原对象之间是完全独立的，修改其中一个对象不会影响到另一个对象。

4.4 数据库存储(这部分太多了，以后有机会另学)

• SQLite：
  是目前主流的嵌入式关系型数据库，其最主要的特点就是轻量级、跨平台，当前很多嵌入式操作系统都将其作为数据库首选。
• CoreData：
  CoreData是iOS5之后才出现的一个框架，本质上是对SQLite的一个封装，它提供了对象-关系映射(ORM)的功能，即能够将OC对象转化成数据，保存在SQLite数据库文件中，也能够将保存在数据库中的数据还原成OC对象，在这个过程中不需要手动编写任何SQL语句，CoreData封装了数据库的操作过程，以及数据库中数据和OC对象的转换过程。通过CoreData管理应用程序的数据模型，可以极大程度减少需要编写的代码数量。
• FMDB：
  是一个处理数据存储的第三方框架，框架是对sqlite的封装，整个框架非常轻量级但又不失灵活性，而且更加面向对象。
• SQLite和CoreData的区别：
  CoreData可以在一个对象更新时，其关联的对象也会随着更新，相当于你更新一张表时，其关联的其他表的也会随着更新。
  CoreData供更简单的性能管理机制，可以限制查询记录的总数，这个类会自动更新其缓存。
  多表查询方面，CoreData没有SQL直观，没有类似外连接，左连接等操作。

5 补充

5.1 什么是序列化和反序列化，用来做什么？

• 序列化：把对象转化为字节序列的过程
• 反序列化：把字节序列恢复成对象
• 作用：把对象写到文件或者数据库中，并且读取出来

5.2 程序中的plist文件

plist全名Property List，属性列表文件，它是一种用来存储串行化后的对象的文件，属性列表文件的扩展名为plist ，因此通常被称为plist文件。文件是xml格式的。

这里补充一下程序中的plist文件，及其对应的写入，读取操作。

程序中的plist文件必须先创建，后使用：

源代码：

// 写入程序plist
- (void)setDataToPlist {
    
    
    // 第一参数：文件名
    // 第二参数：文件后缀
    NSString *plist = [[NSBundle mainBundle] pathForResource:@"show" ofType:@"plist"];
    NSDictionary *dict = @{
    
    @"蔡徐坤":@"name", @10:@"age"};
    [dict writeToFile:plist atomically:YES];
}

// 读取程序plist
- (void)getDataFromPlist {
    
    
    NSString *plist = [[NSBundle mainBundle] pathForResource:@"show" ofType:@"plist"];
    NSLog(@"%@", plist);
    NSDictionary *dict = [[NSDictionary alloc] initWithContentsOfFile:plist];
    NSLog(@"%@", dict);
}

运行结果：

虽然我们在项目工程里创建了这个文件，但是数据似乎并不会保存在这个文件里，至少不是这个工程包里的文件。

我们cd到打印出来的目录中：

使用vim看看这个同名文件：

可以看到数据被保存到应用程序的资源束（Resource Bundle）中。

当我们编译项目时，Xcode似乎会将资源文件（包括 .plist 文件）全复制到应用程序的资源束（Resource Bundle）中。这样可以确保在运行时能够找到并正确读取资源文件中的内容。