(最全)iOS 沙盒文件目录、数据持久化的几种方法iOS 沙盒文件目录、数据持久化的几种方法

简介

Demo
所谓的持久化，就是将数据保存到硬盘中，使得在应用程序或机器重启后可以继续访问之前保存的数据。在iOS开发中，有很多数据持久化的方案，接下来介绍以下几种方案：

• plist文件（属性列表）
• preference（偏好设置）
• NSKeyedArchiver（归档）
• Keychain (钥匙串)
• SQLite 3
• FMDB
• WCDB
• CoreData

沙盒

首先需要了解什么是沙盒！每一个APP都有一个存储空间，就是沙盒。APP之间不能相互通信。沙盒根目录结构：.app、Documents、Library、tmp。效果如图：

沙盒目录.png

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

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

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

参数1：指定搜索的目录名称，比如这里用NSDocumentDirectory表明我们要搜索的是Documents目录。
如果我们将其换成NSCachesDirectory就表示我们搜索的是Library/Caches目录。

参数2：搜索主目录的位置，NSUserDomainMask表示搜索的范围限制于当前应用的沙盒目录。
还可以写成NSLocalDomainMask（表示/Library）、NSNetworkDomainMask（表示/Network）等

参数3：是否获取完整的路径，我们知道在iOS中的全写形式是/User/userName，该值为YES即表示写成全写形式，为NO就表示直接写成“~”。
该值为NO:Caches目录路径为~/Library/Caches
该值为YES:Caches目录路径为
/var/mobile/Containers/Data/Application/E7B438D4-0AB3-49D0-9C2C-B84AF67C752B/Library/Caches

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

//常用的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)

};

1、Documents 目录：

您应该将所有的应用程序数据文件写入到这个目录下。这个目录用于存储用户数据。该路径可通过配置实现iTunes共享文件。可被iTunes备份。
此文件夹是默认备份的,备份到iCloud

注:iCloud的备份，会通过Wi-Fi每天自动备份用户iOS设备。

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

2、AppName.app 目录：

这是应用程序的程序包目录，包含应用程序的本身。由于应用程序必须经过签名，所以您在运行时不能对这个目录中的内容进行修改，否则可能会使应用程序无法启动。

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

3、Library 目录：这个目录下有两个子目录：

image.png

• Preferences 目录：包含应用程序的偏好设置文件。您不应该直接创建偏好设置文件，而是应该使用NSUserDefaults类来取得和设置应用程序的偏好.

// 获取Library的目录路径
NSString *libDir = [NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES) lastObject];

• Caches 目录：用于存放应用程序专用的支持文件，保存应用程序再次启动过程中需要的信息。
  可创建子文件夹。可以用来放置您希望被备份但不希望被用户看到的数据。该路径下的文件夹，除Caches以外，都会被iTunes备份。

// 获取Caches目录路径
NSString *cachesDir = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) firstObject];

1.缓存数据应该保存在/Library/Caches目录下.
2.缓存数据在设备低存储空间时可能会被删除，iTunes或iCloud不会对其进行备份。
3.可以保存重新下载或生成的数据，而且没有这些数据也不会妨碍用户离线使用应用的功能。
4.当访问网络时系统自动会把访问的url,以数据库的方式存放在此目录下面.

image

5.Snapshots系统截图文件夹

4、tmp 目录：

这个目录用于存放临时文件，保存应用程序再次启动过程中不需要的信息。该路径下的文件不会被iTunes备份。

// 获取tmp目录路径
NSString *tmpDir =  NSTemporaryDirectory();

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

---

plist文件（属性列表）

plist文件是将某些特定的类，通过XML文件的方式保存在目录中。
可以被序列化的类型只有如下几种：

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

这里我们就用NSDictionary为例,其他的类型和这个方法类似;

/**
 写入数据
 */
-(void)writeToPlist:(NSDictionary *)dict plistName:(NSString *)plistName{
    //存取路径
    NSString *path = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES).firstObject;
    //路径中文件名
    NSString *filePath = [path stringByAppendingPathComponent:plistName];
    //序列化,把数据存入指定目录的plist文件
    [dict writeToFile:filePath atomically:YES];
}
/**
 根据plist文件名读取数据
 */
-(NSDictionary *)readFromPlistWithPlistName:(NSString *)plistName{
    //存取路径
    NSString *path = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES).firstObject;
    //路径中文件名
    NSString *filePath = [path stringByAppendingPathComponent:plistName];
    NSDictionary *resultDict = [NSDictionary dictionaryWithContentsOfFile:filePath];
    return resultDict;
}

preference（偏好设置）

很多iOS应用都支持偏好设置，比如保存用户名、密码、字体等设置。
每个应用都有NSUserDefaults实例，通过它来读取偏好设置。
一般不要在偏好设置中保存其他数据。
偏好设置是key-value的方式存取和读取的。

NSUserDefaults就是默认存放在此文件夹下面,iTunes或iCloud会备份该目录。

//获取Preferences目录路径
NSString *preferencesPath=[[NSSearchPathForDirectoriesInDomains(NSLibraryDirectory, NSUserDomainMask, YES) firstObject] stringByAppendingString:@"/Preferences"];

打印结果：

image

/**
 保存数据
 */
- (IBAction)saveDate:(UIButton *)sender {
    //获得NSUserDefaults文件
    NSUserDefaults *userDefaultes = [NSUserDefaults standardUserDefaults];
    //向偏好设置中写入内容
    [userDefaultes setObject:@"lcf" forKey:@"name"];
    [userDefaultes setInteger:26 forKey:@"age"];
    [userDefaultes setObject:@"boy" forKey:@"sex"];
    //立即同步设置
    [userDefaultes synchronize];
}
/**
 读取数据
 */
- (IBAction)readDate:(UIButton *)sender {
    //获得NSUserDefaults文件
    NSUserDefaults *userDefaultes = [NSUserDefaults standardUserDefaults];
    //读取偏好设置
    NSString *name = [userDefaultes objectForKey:@"name"];
    NSInteger age = [userDefaultes integerForKey:@"age"];
    NSString *sexStr = [userDefaultes objectForKey:@"sex"];
    NSLog(@"\n%@\n%ld\n%@",name,age,sexStr);
}

注意事项：

• 如果没有调用synchronize方法，系统会根据I/O情况不定时刻地保存到文件中。所以如果需要立即写入，就必须调用synchronize方法。
• 偏好设置会将所有数据保存到同一个文件夹，使用同一个key，会把之前存储的数据覆盖。

NSKeyedArchiver（归档）

归档在iOS中是另一种形式的序列化，只要遵循了NSCoding协议的对象都可以通过它来实现序列化。由于大多是类都遵循了NSCoding协议，因此，对于大多数类来说，归档是比较容易实现的。

遵循NSCoding协议,其中有2个方法是必须实现的：

• initWithCoder
• encodeWithCoder

//遵循NSCoding协议
@interface DWSave : NSObject
/**name*/
@property(nonatomic ,copy)NSString *name;
/**age*/
@property(nonatomic ,assign)NSInteger age;
/**sex*/
@property(nonatomic ,assign)BOOL sex;
@end
//以上内容要写在.h文件中

@implementation DWSave
//归档
-(void)encodeWithCoder:(NSCoder *)aCoder{
    [aCoder encodeObject:self.name forKey:@"name"];
    [aCoder encodeInteger:self.age forKey:@"age"];
    [aCoder encodeBool:self.sex forKey:@"sex"];
}
//解档
-(instancetype)initWithCoder:(NSCoder *)aDecoder;{
    if (self = [super init]) {
        self.name = [aDecoder decodeObjectForKey:@"name"];
        self.age = [aDecoder decodeIntegerForKey:@"age"];
        self.sex = [aDecoder decodeBoolForKey:@"sex"];
    }
    return self;
}
@end

NSKeyedArchiver归档

//保存地址
    NSString *path = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES).firstObject;
    //文件名
    NSString *filePath = [path stringByAppendingPathComponent:@"wyp.data"];
    DWSave *save = [[DWSave alloc] init];
    //设置数据
    save.name = @"lcf";
    save.age = 26;
    save.sex = 1;
    [NSKeyedArchiver archiveRootObject:save toFile:filePath];

NSKeyedUnarchiver解档

NSString *path = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES).firstObject;
    NSString *filePath = [path stringByAppendingPathComponent:@"wyp.data"];
    DWSave *save = [NSKeyedUnarchiver unarchiveObjectWithFile:filePath];
    if (save) {
        NSLog(@"\n%@\n%ld\n%d",save.name,save.age,save.sex);    
    }

必须要遵循NSCoding协议
保存文件的扩展名可以自定义
如果需要归档的类是某个自定义类的子类时，就需要在归档和解档之前实现父类的归档和解档方法。
[super encodeWithCoder:aCoder]和[super initWithCoder:aDecoder]方法。

Keychain (钥匙串)

通常情况下，我们使用NSUserDefaults存储数据信息，但是对于一些私密信息，但是对于一下比较私密的信息，如帐号、密码等等，我们就需要使用更为安全的keychain了。keychain保存的信息是保存在沙盒之外的，不会因App的删除而丢失，在用户重新安装了App后依然存在。其实可以把keychain理解成一个Dictionary，所有数据都以key-value的形式存储，可以对这个Dictionary进行add、update、get、delete这四个操作。对一个应用来说，keychain都有两个访问区，私有和公共。

1. Target - Capabilities - Keychain Sharing - ON

   
   
   image.png

   左侧的目录会自动生成Entitlements文件，不需要自己创建了。

2. 引入Security.framework

3. 详细介绍请查看iOS的密码管理系统 Keychain的介绍和使用
   

SQLite 3

表面上SQLite将数据分为以下几种类型：

• integer : 整数
• real : 实数（浮点数）
• text : 文本字符串
• blob : 二进制数据，比如文件，图片之类的

一般用来存储大量的内容并可单一的修改更新某一条缓存信息等。实际上SQLite是无类型的。即不管你在创表时指定的字段类型是什么，存储是依然可以存储任意类型的数据。而且在创表时也可以不指定字段类型。

// 创建数据库
- (void)openDatabase
{
    NSString *filepath = [[VGFileManagerCommon getDocumentPath] stringByAppendingString:@"cache.db"];
    FMDatabase *db = [FMDatabase databaseWithPath:filepath];
    if ([db open])
    {
        self.db = db;
        NSString *sql = @"CREATE TABLE IF NOT EXISTS CACHE \
        (uid INTEGER PRIMARY KEY, \
        url TEXT, \
        title TEXT)";
        if (![self.db executeUpdate:sql])
        {
            NSLog(@"execute sql %@ error %@",sql,self.db.lastError);
        }
    }
    else
    {
        NSLog(@"open database failed %@",filepath);
    }
}

#pragma mark - public

- (NSArray *)fetchCacheModelWithLimit:(NSInteger)limit{
    __block NSArray *result = nil;
    NSString *sql = nil;
    if (limit) {
        sql = @"SELECT *FROM CACHE ORDER BY uid DESC LIMIT ?";
    }
    db_sync_safe(^{
        NSMutableArray *array = [NSMutableArray array];
        FMResultSet *rs = [self.db executeQuery:sql, @(limit)];
        while ([rs next]) {
            VGCacheModel *model = loadToDatabase(rs);
            [array addObject:model];
        }
        [rs close];
        result = array;
    });
    return result;
}


- (void)saveModels:(NSArray *)models{
    db_sync_safe(^{
        if ([models count]) {
            [self.db beginTransaction];
            for (VGCacheModel*model in models) {
                saveToDatabase(self.db, model);
            }
            [self.db commit];
        }
    });
}

- (void)updateModel:(VGCacheModel *)model{
    NSString *sql = @"UPDATE CACHE SET TITLE = ? WHRER uid = ?";
    db_async(^{
        if (![self.db executeUpdate:sql, model.title, model.uid]) {
            NSLog(@"update failed sql %@",sql);
        }
    });
}

#pragma mark - save & load
static inline VGCacheModel * loadToDatabase(FMResultSet *resultSet)
{
    NSInteger uid = [resultSet longLongIntForColumn:@"uid"];
    NSString *URL = [resultSet stringForColumn:@"url"];
    NSString *title = [resultSet stringForColumn:@"title"];
    
    VGCacheModel *model = [[VGCacheModel alloc] init];
    model.uid = uid;
    model.imageURL = URL;
    model.title = title;
    
    return model;
}

static inline void saveToDatabase(FMDatabase *db, VGCacheModel *model)
{
    NSString *sql = @"INSERT OR REPLACE INTO CACHE(uid, url, title) VALUES(?,?,?)";
    if(![db executeUpdate:sql,
        @(model.uid),
        model.imageURL,
        model.title]){
        NSLog(@"update failed sql %@",sql);
    }
}


#pragma mark - Queue
dispatch_queue_t cacheDatabaseQueue()
{
    static dispatch_queue_t queue;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        queue = dispatch_queue_create(databaseQueue, 0);
        dispatch_queue_set_specific(queue, kDatabaseQueueSpecificKey, (void *)kDatabaseQueueSpecificKey, NULL);
    });
    return queue;
}

typedef void(^dispatch_block)(void);
void db_sync_safe(dispatch_block block)
{
    if (dispatch_get_specific(kDatabaseQueueSpecificKey))
    {
        block();
    }
    else
    {
        dispatch_sync(cacheDatabaseQueue(), ^() {
            block();
        });
    }
}

void db_async(dispatch_block block){
    dispatch_async(cacheDatabaseQueue(), ^() {
        block();
    });
}

FMDB

FMDB详解
FMDB的gitHub地址
FMDB-Demo

1.简介

FMDB是iOS平台的SQLite数据库框架，它是以OC的方式封装了SQLite的C语言API，它相对于cocoa自带的C语言框架有如下的优点:

• 使用起来更加面向对象，省去了很多麻烦、冗余的C语言代码
• 对比苹果自带的Core Data框架，更加轻量级和灵活
• 提供了多线程安全的数据库操作方法，有效地防止数据混乱

2.核心类

FMDB有三个主要的类：

• FMDatabase
  一个FMDatabase对象就代表一个单独的SQLite数据库，用来执行SQL语句

• FMResultSet
  使用FMDatabase执行查询后的结果集

• FMDatabaseQueue
  用于在多线程中执行多个查询或更新，它是线程安全的

WCDB

推荐使用WCDB!!
WCDB简介
从FMDB迁移到WCDB
iOS 官方使用教程

CoreData

CoreData的简单使用

推荐工具 woodpecker

参考文章：
iOS沙盒详细介绍
iOS中几种数据持久化方案