iOS - 沙盒文件操作指南

迈不过友情╰ 2022-08-29 12:52 290阅读 0赞

# 前言 #

最近在学习数据持久化相关的内容，文件作为 iOS 客户端开发中一种常见的数据保存方式，自然也是应该学习的内容，本文就来简单介绍文件相关的一些知识。

### 文章目录 ###

*  前言
 *  1. 文件基础
 *   *  沙盒路径获取
     *  NSString 路径操作
     *  NSData 类型转换
 *  2. NSFileManager 文件操作
 *   *  2.1 创建文件和目录
     *  2.2 文件剪切和复制
     *  2.3 文件删除
 *  3. NSFileHandle 文件读写
 *   *  3.1 常用方法
 *  参考资料

# 1. 文件基础 #

在 iOS 系统中，所有非系统应用都经过了沙盒化，**每个应用都拥有自己的沙盒（Sandbox）用于存储本应用的文件数据**，不同应用沙盒之间是相互独立的，而且本应用不能访问其他应用的沙盒。

沙盒机制保证了 iOS 应用的安全性，能有效防止 App 收集和篡改其他 App 存储的信息。如果第三方 App 需要访问除自身以外的其他信息，只能通过 iOS 系统明确提供的服务来实现。

应用沙盒的结构如下图所示：  
![sandbox][]  
下面简单介绍一下沙盒各个路径的内容：

*  **/Document 目录**：用于存放程序中的文件数据，应用程序在运行时生成一些需要长久保存的数据，如游戏进程存档，为编辑完的文档等。iTunes 、iCloud 对应用信息备份时，会备份这个目录下的数据，因此会在此目录保存相对重要的数据。
 *  /Library 包含下面两个子目录
    
     *  **/Library/Caches 目录** ：恰如其名，该目录用于存放缓存文件，从网络上下载的文件或数据（如：音乐缓存、图片缓存等）都会保存在该目录下。该目录下的文件不会在应用退出时手动删除，需要程序员手动清除该目录下的数据。iTunes 、iCloud 不会对该目录下的数据进行备份。
     *  **/Library/Preferences 目录**：存放的是基于 NSUserDefaults 的设置数据，文件格式为 `.plist`。设置应用的一些功能会在该目录中查找相应设置的信息，iTunes、iCloud备份时会备份此目录下的数据。该目录由系统自动管理，通常用来储存一些基本的应用配置信息。
 *  **/Temp 目录**：存放应用运行时产生的一些临时数据和文件，当应用程序退出、系统磁盘空间不足、手机重启时，都会自动清除该目录的数据。无需程序员手动清除该目录中的数据，iTunes、iCloud备份时不会备份此目录。

## 沙盒路径获取 ##

我们可以通过下面的方法，获取到上面提及到的沙盒目录。

// 获取沙盒根目录
    NSString *homeDir = NSHomeDirectory();
    
    // 获取 /Document 目录
    NSString *docDir = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
    
    // 获取 /Library 目录
    NSString *libDir = [NSSearchPathForDirectoriesInDomains(NSLibraryDirectory , NSUserDomainMask , YES) lastObject];
    
    // 获取 /Library/Caches 目录
    NSString *cacheDir = [NSSearchPathForDirectoriesInDomains(NSCachesDirectory, NSUserDomainMask, YES) lastObject];
    
    // 获取 /Temp 目录
    NSString *tmpDir = NSTemporaryDirectory();

## NSString 路径操作 ##

要想对文件进行操作，必然会涉及到文件路径的处理。在 NSString 中，也给我们提供了路径操作相关的 API。

/// 路径分解，例如 /Users/Apple/file.txt 会得到 "/", "Users", "Apple", "file.txt"
    - (NSArray *)pathComponents;
    
    // 获取路径的最后部分，例如 /Users/Apple/file.txt 会得到 "file.txt"
    - (NSString *)lastPathComponent;
    
    // 在路径末尾添加路径，会自动处理 "/" 
    - (NSString *)stringByAppendingPathConmponent:(NSString *)str;
    
    // 删除路径的最后部分，例如 /Users/Apple/file.txt 会得到 /Users/Apple/
    - (NSString *)stringByDeletingLastPathCpmponent;
    
    // 为路径添加拓展名，传参的时候不用加 "."
    - (NSString *)stringByAppendingPathExtension:(NSString *)str;
    
    // 删除路径末尾的拓展名
    - (NSString *)stringByDeletingPathExtension;

## NSData 类型转换 ##

我们读取文件时，通常获取到的都是 NSData 类型的对象，下面是 NSData 到其他常用类型的相互转换方法。

// NSString 和 NSData 互转
    NSString *str = @"Veggie";
    NSData *strToData = [str dataUsingEncoding:NSUTF8StringEncoding];
    NSString *dataToStr = [[NSString alloc] initWithData:strToData encoding:NSUTF8StringEncoding];
    
    // int 和 NSData 互转
    int i = 1024;
    NSData *intToData = [NSData dataWithBytes:&i length:sizeof(i)];
    int dataToInt;
    [intToData getBytes:&dataToInt length:sizeof(dataToInt)];
    
    // UIImage 和 NSData 互转
    UIImage *image = [UIImage imageNamed:@"test"];
    NSData *imageToData = UIImagePNGRepresentation(image);
    UIImage *dataToImage = [UIImage imageWithData:imageToData];
    
    // NSArray 和 NSData 互转
    NSArray *arr = @[@"1", @"2", @"3"];
    NSData *arrToData = [NSJSONSerialization dataWithJSONObject:arr options:NSJSONWritingPrettyPrinted error:nil];
    NSArray *dataToArr = [NSJSONSerialization JSONObjectWithData:arrToData options:NSJSONReadingMutableContainers error:nil];
    
    // NSDictionary 和 NSData 互转
    NSDictionary *dic = @{ 
        @"user_name" : @"veggie",
        @"user_age" : @"18"
    };
    NSData *dicToData = [NSJSONSerialization dataWithJSONObject:dic options:NSJSONWritingPrettyPrinted error:nil];
    NSArray *dataToDic = [NSJSONSerialization JSONObjectWithData:dicToData options:NSJSONReadingMutableContainers error:nil];

# 2. NSFileManager 文件操作 #

我们想对沙盒中的目录和文件进行操作时，可以用上系统为我们提供的 NSFileManager 文件管理类。下面就通过封装方法的形式，简单介绍 NSFileManager 的使用。

## 2.1 创建文件和目录 ##

创建目录

- (BOOL)createDir:(NSString *)path { 
        NSAssert(path > 0, @"%s: The length of path should be greater than 0.", __FUNCTION__);
        NSFileManager *fileManager = [NSFileManager defaultManager];
        BOOL isSuccess = YES;
        // 判断目录是否已经存在
        if (![fileManager fileExistsAtPath:path]) { 
        	// 创建文件目录
            NSError *error = nil;
            isSuccess = [fileManager createDirectoryAtPath:path withIntermediateDirectories:YES attributes:nil error:&error];
            if (error) { 
                NSLog(@"Create directory failed: %@",[error localizedDescription]);
            }
        }
        return isSuccess;
    }

创建文件，在创建之前需要确定文件的存储路径是存在的，如果不存在，则现在执行目录创建操作。

- (BOOL)createFile:(NSString *)filePath { 
        NSAssert(filePath > 0, @"%s: The length of filePath should be greater than 0.", __FUNCTION__);
        NSFileManager *fileManager = [NSFileManager defaultManager];
        // 提取出文件存放的目录
        NSString *dir = [filePath stringByDeletingLastPathComponent];
        // 判断目录是否已经存在
        if (![fileManager fileExistsAtPath:dir]) { 
        	// 如果还没有存在，则需要新建
            NSError *error = nil;
            [fileManager createDirectoryAtPath:dir withIntermediateDirectories:YES attributes:nil error:&error];
            if (error) { 
                NSLog(@"Create directory failed: %@",[error localizedDescription]);
                return NO;
            }
        }
        // 创建文件
        return [fileManager createFileAtPath:filePath contents:nil attributes:nil];
    }

## 2.2 文件剪切和复制 ##

这里以一个简单的任务来举例，我们需要将 `/Documents/from` 目录下的所有文件（文件名格式有规律）移动到 `/Documents/to` 目录下，其目录内容如下图所示。  
![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAVmVnZ2llT3J6_size_15_color_FFFFFF_t_70_g_se_x_16]  
我们使用 `NSFileManager` 来实现，代码如下：

NSString *fromPath = @"/Users/user_name/Documents/from";
    NSString *toPath = @"/Users/user_name/Documents/to";
    
    NSFileManager *fileManager = [NSFileManager defaultManager];
    
    for (int i = 0; i < 100; i++) { 
        NSString *fileName = [NSString stringWithFormat:@"veggie-%d.txt", i];
        // 注意：在 from 和 to 路径上都要拼上文件名
        NSString *fileFromPath = [fromPath stringByAppendingPathComponent:fileName];
        NSString *fileToPath = [toPath stringByAppendingPathComponent:fileName];
        
        // 执行移动操作
        NSError *error = nil;
        BOOL isSuccess = [fileManager moveItemAtPath:fileFromPath toPath:fileToPath error:&error];
        if (isSuccess) { 
            NSLog(@"moveFile Success!");
        } else { 
            NSLog(@"moveFile Field：%@",[error localizedDescription]);
        }
    }

复制操作和上面的代码非常详细，用到的是下面这个 API，需要特别注意的是，**参数中 `srcPath` 和 `dstPath` 路径都要拼上文件名**。

- (BOOL)copyItemAtPath:(NSString *)srcPath toPath:(NSString *)dstPath error:(NSError **)error;

## 2.3 文件删除 ##

- (BOOL)deleteFile:(NSString *)filePath { 
        NSError *error = nil;
        NSFileManager *fileManager = [NSFileManager defaultManager];
        BOOL isSuccess = [fileManager removeItemAtPath:filePath error:&error];
        if (error) { 
            NSLog(@"removeFile Field：%@",[error localizedDescription]);
        }
        return isSuccess;
    }

# 3. NSFileHandle 文件读写 #

NSFileHandle 主要用于对文件进行 I/O 操作，它的使用通常包括以下几个步骤：

*  打开文件，获取文件对应的 NSFileHandle 对象
 *  对该文件执行 I/O 操作（读取、写入、插入）
 *  关闭文件

## 3.1 常用方法 ##

// 打开一个文件，准备读取
    + (nullable instancetype)fileHandleForReadingAtPath:(NSString *)path;
    // 打开一个文件，准备写入（会发生覆盖）
    + (nullable instancetype)fileHandleForWritingAtPath:(NSString *)path;
    // 打开一个文件，准备插入内容
    + (nullable instancetype)fileHandleForUpdatingAtPath:(NSString *)path;
    
    // 返回可用的数据
    - (NSData *)availableData; 
    // 从当前的节点读取到文件的末尾
    - (NSData *)readDataToEndOfFile; 
    // 从当前节点开始读取指定的长度数据
    - (NSData *)readDataOfLength:(NSUInteger)length; 
    // 写入数据
    - (void)writeData:(NSData *)data;
    // 获取当前文件的偏移量
    - (unsigned long long)offsetInFile; 
    // 跳到指定文件的偏移量
    - (void)seekToFileOffset:(unsigned long long)offset; 
    // 跳到文件末尾
    - (unsigned long long)seekToEndOfFile; 
    // 将文件的长度设为offset字节
    - (void)truncateFileAtOffset:(unsigned long long)offset; 
    // 关闭文件
    - (void)closeFile;

# 参考资料 #

*  [File System Programming Guide | Apple Developer Documentation][File System Programming Guide _ Apple Developer Documentation]
 *  [NSFileManager | Apple Developer Documentation][NSFileManager _ Apple Developer Documentation]
 *  [NSString | Apple Developer Documentation][NSString _ Apple Developer Documentation]
 *  [NSData | Apple Developer Documentation][NSData _ Apple Developer Documentation]

--------------------

好像又写了一篇没什么用的文章，希望后面在开发中用上了相关技术，可以再次回到这里更新自己的想法。

[sandbox]: /images/20220829/f46ff036c6e7410592845bbe930a63ce.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBAVmVnZ2llT3J6_size_15_color_FFFFFF_t_70_g_se_x_16]: /images/20220829/432579d8357441b3b64a7e09f52ac304.png
[File System Programming Guide _ Apple Developer Documentation]: https://developer.apple.com/library/archive/documentation/FileManagement/Conceptual/FileSystemProgrammingGuide/FileSystemOverview/FileSystemOverview.html
[NSFileManager _ Apple Developer Documentation]: https://developer.apple.com/documentation/foundation/nsfilemanager
[NSString _ Apple Developer Documentation]: https://developer.apple.com/documentation/foundation/nsstring?language=objc
[NSData _ Apple Developer Documentation]: https://developer.apple.com/documentation/foundation/nsdata?language=objc