iOS基础 - NSFileManager | 沙盒 | 归档和解档

▶ 沙盒

我们知道存储在内存中的数据，当程序关闭或内存释放，数据就会丢失，这种数据只是临时的

数据持久化的本质：数据保存成文件，存储在程序的沙盒中

沙盒机制

A. 每个应用程序位于文件系统的严格限制部分，就是说每个应用程序只能在该程序所创建的文件系统中读取文件

B. 每个应用程序在 iOS 系统内都放在了统一的文件夹目录下，沙盒的本质就是一个文件夹，名字是随机分配的

C. 沙盒构成

    Document                     存储用户数据、需要备份的信息

    Library/Caches              存储缓存文件、程序专用的支持文件

    Library/Preferences        存储应用程序的偏好设置文件

    .app                              程序包。iOS 8 后 app 不再存储在沙盒中，有单独的文件夹专门存储所有程序的 app包

    tmp                               临时文件，比如下载的 zip 包、解压后的再删除

▶ NSFileManager

NSFileManager 可创建文件夹并对文件进行创建、移动、复制、删除操作，判断文件是否存在等等。通过 detaultManager 创建单例对象后使用

#import "ViewController.h"
@interface ViewController ()
@property(nonatomic,strong) NSFileManager *fileManager; // 文件管理器

@end

@implementation ViewController

- (void)viewDidLoad{
    [super viewDidLoad];
    self.fileManager = [[NSFileManager alloc] init];
}


-(void)touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event{
    
    // 沙盒主路径
    NSString *document = NSHomeDirectory();
    NSLog(@"document===%@",document);
    
    NSArray *array = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES);
    // Document文件夹
    NSString *filePath = array.firstObject;
    NSLog(@"filePath===%@",filePath);
    
    
    // 该方法会自动在前一个路径 filePath 的后面加上 /
    // 如果后面的一个路径 filePath1 的文件名里有 / 则会将 / 去除
    NSString *filePathAAA = [filePath stringByAppendingPathComponent:@"AAA"];
    
    // 在指定的目录下创建文件夹，如果该文件夹存在，则不创建
    // IntermediateDirectories：是否创建中间文件夹，YES 会创建中间文件夹，NO 不会创建中间
    // attributes：文件夹的属性
    [self.fileManager createDirectoryAtPath:filePathAAA withIntermediateDirectories:YES attributes:nil error:nil];
    
    
    // 将要读入的内容
    NSString *content = @"青春如同奔流的江河";
    // 在将字符串进行 data 转换时，如果是中文字符，使用 NSASCIIStringEncoding 编码则不会写入到文件
    // 因为此时生成的 contentData 是 nil
    // 可以使用 NSUnicodeStringEncoding 或者 NSUTF8StringEncoding 编码
    NSData *contentData = [content dataUsingEncoding:NSUnicodeStringEncoding];
    
    
    // 不创建 test1 和 test2 两文件夹
    NSString *test1Path = [filePathAAA stringByAppendingPathComponent:[NSString stringWithFormat:@"test1"]];
    NSString *test2Path = [filePathAAA stringByAppendingPathComponent:[NSString stringWithFormat:@"test2"]];
    
    // 如果路径不存在，则不会写入二进制文件
    if ([contentData writeToFile:test2Path atomically:NO]) {
        
        NSLog(@"不会把内容写入到 test2文件 中");
    }
    
    // 文件是否存在
    if (![self.fileManager fileExistsAtPath:test1Path]) {
        
        // 判断该文件名存在，包括后缀名：比如 testA 和 testA.html是两个文件。如果存在先将这个文件删除，然后再创建
        // 如果文件名不存在，则直接创建
        [self.fileManager createFileAtPath:test1Path contents:contentData attributes:nil];
        
        // 复制文件
        NSError *error;
        [self.fileManager copyItemAtPath:test1Path toPath:test2Path error:&error];
        // 取得文件里的内容
        NSData *someData = [self.fileManager contentsAtPath:test1Path];
        
    }else{
        //删除文件
        [self.fileManager removeItemAtPath:test1Path error:nil];
    }
    
    // 创建 DDD 文件夹 且里面包含 ddd 文件夹
    NSString *filePathDDD = [[filePath stringByAppendingPathComponent:@"DDD"] stringByAppendingPathComponent:@"ddd"];
    [self.fileManager createDirectoryAtPath:filePathDDD withIntermediateDirectories:YES attributes:nil error:nil];
    
    // 不会创建 MMM 文件夹，且其中的 mmm 文件夹也不会被创建
    NSString *filePathB = [[filePath stringByAppendingPathComponent:@"MMM"] stringByAppendingPathComponent:@"mmm"];
    [self.fileManager createDirectoryAtPath:filePathB withIntermediateDirectories:NO attributes:nil error:nil];
    
    //----------------------------- 文件属性 -----------------------------
    NSDictionary *attrDic = [self.fileManager attributesOfItemAtPath:test1Path error:nil];
    NSLog(@"test1文件属性信息：%@",attrDic);
    
    // 获取文件创建时间
    NSDate *date = [attrDic objectForKey:NSFileCreationDate];
    
    // 修改创建时间无效
    NSMutableDictionary *changeAttrDic = [NSMutableDictionary dictionaryWithDictionary:attrDic];
    // [changeAttrDic removeAllObjects];// 想要修改文件的创建时间，需先删除以前的文本属性，否则修改无效
    [changeAttrDic setObject:[NSDate dateWithTimeIntervalSinceNow:600] forKey:NSFileCreationDate];
    [self.fileManager setAttributes:changeAttrDic ofItemAtPath:test1Path error:nil];
    attrDic = [self.fileManager attributesOfItemAtPath:test1Path error:nil];
    NSLog(@"更改创建时间：%@",attrDic);
    
    // 获得子文件或文件夹的名字
    NSArray *subArray = [self.fileManager subpathsAtPath:filePath];
    NSLog(@"subArray===%@",subArray);
}

@end

NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask,YES) 方法参数说明

NSHomeDirectory 　　　  沙盒主路径

NSDocumentDirectory　　Document文件夹 

NSLibraryDirectory　　     Library文件夹

NSCachesDirectory　       Caches文件夹

NSTemporaryDirectory      tmp文件夹

▶ 将简单对象写入文件

简单对象只能是 NSString、NSArray、NSDictionary、NSData 四种对象

#import "ViewController.h"
@interface ViewController ()
@property(nonatomic,strong) NSFileManager *fileManager; // 文件管理器

@end

@implementation ViewController

- (void)viewDidLoad{
    [super viewDidLoad];
}


-(void)touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event{
    
    // 获取所有 documents 的文件夹
    NSArray *documentList = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask,YES);
    NSLog(@"documentList===%@",documentList);
    // 将最后一个作为文件的存储目录
    NSString *documentPath = documentList.lastObject;
    NSLog(@"%@",documentPath);
    
    //--------------将 字符串对象 写入文件------------
    // 构造字符串文件的存储路径
    NSString *strPath = [documentPath stringByAppendingString:@"/text.txt"];
    NSString *foo_str = @"this for test";
    [foo_str writeToFile:strPath atomically:YES encoding:NSUTF8StringEncoding error:nil];
    // 读取
    NSLog(@"%@",[[NSString string] initWithContentsOfFile:strPath encoding:NSUTF8StringEncoding error:nil]) ;
    
    //--------------将 数组对象 写入文件--------------
    NSString *arrayPath = [documentPath stringByAppendingString:@"/array.plist"];
    NSArray *foo_array = @[@"1",@"2",@"3",@"4",@"5"];
    [foo_array writeToFile:arrayPath atomically:YES];
    NSLog(@"%@",[[NSArray array] initWithContentsOfFile:arrayPath]);
    
    //--------------将 字典对象 写入文件--------------
    NSString *dicPath = [documentPath stringByAppendingString:@"/dic.plist"];
    NSDictionary *foo_dic = @{@"1":@"f",@"2":@"s",@"3":@"t"};
    [foo_dic writeToFile:dicPath atomically:YES];
    NSLog(@"%@",[[NSDictionary dictionary] initWithContentsOfFile:dicPath]);
    
    //    //--------------- 将 Data对象 写入文件 ---------------
    //    // Data 对象写入文件：二进制对象可能存储的是图像、字符串等等
    //    NSString *dataPath = [documentPath stringByAppendingString:@"/data.da"];
    //    [foo_data writeToFile:dataPath atomically:YES];
}

@end

▶ 将复杂对象写入文件

复杂对象无法通过 writeToFile: 方法进行数据持久化，只能通过先将复杂对象转化成 NSData，然后通过 writeToFile: 写入文件后保存

归档：将复杂对象转换成 NSData 数据

解档（反归档），就是将 NSData 数据转换成复杂对象

一个类如果要进行归档：必须接受 NSCoding 协议且实现协议中必须实现的方法！下面我们对 Person 进行归档/解档

// - Person.h

#import <Foundation/Foundation.h>
@interface Person : NSObject<NSCoding>// 接受 NSCoding协议
@property(nonatomic,copy)NSString *name;
@property(nonatomic,copy)NSString *sex;
@property(nonatomic,assign)NSInteger age;
@end

// - Person.m

#import "Person.h"
#define NAME_KEY @"name"// 解压数据需要的参数
#define SEX_KEY  @"sex"
#define AGE_KEY  @"age"
@implementation Person

// 归档时自动调用
- (void)encodeWithCoder:(NSCoder *)aCoder{

    // 把每一个实例变量转化成字节流
    [aCoder encodeObject:self.name forKey:NAME_KEY];
    [aCoder encodeObject:self.sex forKey:SEX_KEY];
    [aCoder encodeInteger:self.age forKey:AGE_KEY];
}

// 解档时自动调用
- (id)initWithCoder:(NSCoder *)aDecoder{
    self = [super init];
    if (self) {
        self.name = [aDecoder decodeObjectForKey:NAME_KEY];
        self.sex = [aDecoder decodeObjectForKey:SEX_KEY];
        self.age = [aDecoder decodeIntegerForKey:AGE_KEY];
    }
    return self;
}


@end

// - ViewController.m

#import "ViewController.h"
#import "Person.h"
#define SCREEN_BOUNDS [[UIScreen mainScreen] bounds]
#define SCREEN_SIZE   SCREEN_BOUNDS.size
#define SCREEN_HEIGHT SCREEN_SIZE.height
#define SCREEN_WIDTH  SCREEN_SIZE.width
@interface ViewController ()

@property (strong, nonatomic)UITextField *nameTF;
@property (strong, nonatomic)UITextField *ageTF;
@property (strong, nonatomic)UITextField *sexTF;
@property (strong, nonatomic)UITextField *showInfoTF;  // 解档后文本

@property (strong, nonatomic)UIButton *achiverButton;  // 归档Btn
@property (strong, nonatomic)UIButton *unAchiverButton;// 解档Btn

@property(nonatomic,strong)NSMutableArray *dataArray;

@property (strong, nonatomic)NSKeyedArchiver   *keyedArchiver;  // 归档器
@property (strong, nonatomic)NSKeyedUnarchiver *keyedUnarchiver; // 解档器

@end

@implementation ViewController

- (void)viewDidLoad {
    [super viewDidLoad];
    self.view.backgroundColor = [UIColor cyanColor];
    
    // 姓名
    _nameTF = [[UITextField alloc] initWithFrame:CGRectMake(60, 90, SCREEN_WIDTH-120, 40)];
    _nameTF.placeholder = @"姓名";
    _nameTF.backgroundColor = [UIColor whiteColor];
    [self.view addSubview:_nameTF];
    
    // 性别
    _sexTF = [[UITextField alloc] initWithFrame:CGRectMake(60, 170, SCREEN_WIDTH-120, 40)];
    _sexTF.backgroundColor = [UIColor whiteColor];
    _sexTF.placeholder = @"性别";
    [self.view addSubview:_sexTF];
    
    // 年龄
    _ageTF = [[UITextField alloc] initWithFrame:CGRectMake(60, 250, SCREEN_WIDTH-120, 40)];
    _ageTF.backgroundColor = [UIColor whiteColor];
    _ageTF.placeholder = @"年龄";
    [self.view addSubview:_ageTF];
    
    // 归档
    _achiverButton = [UIButton buttonWithType:UIButtonTypeCustom];
    [_achiverButton setBackgroundColor:[UIColor redColor]];
    [_achiverButton setTitle:@"归档" forState:UIControlStateNormal];
    [_achiverButton addTarget:self action:@selector(MakeSomething:) forControlEvents:UIControlEventTouchUpInside];
    _achiverButton.frame = CGRectMake((SCREEN_WIDTH-50)*0.5, 340, 50, 50);
    _achiverButton.layer.masksToBounds = YES;
    _achiverButton.layer.cornerRadius = 25.0f;
    [self.view addSubview:_achiverButton];
    
    // 解档
    _unAchiverButton = [UIButton buttonWithType:UIButtonTypeCustom];
    [_unAchiverButton setBackgroundColor:[UIColor redColor]];
    [_unAchiverButton setTitle:@"解档" forState:UIControlStateNormal];
    [_unAchiverButton addTarget:self action:@selector(MakeSomething:) forControlEvents:UIControlEventTouchUpInside];
    _unAchiverButton.frame = CGRectMake((SCREEN_WIDTH-100)*0.5, 420, 100, 50);
    _unAchiverButton.layer.masksToBounds = YES;
    _unAchiverButton.layer.cornerRadius = 25.0f;
    [self.view addSubview:_unAchiverButton];
    
    // 显示解档信息
    _showInfoTF = [[UITextField alloc] initWithFrame:CGRectMake(20, 520, SCREEN_WIDTH-40, 40)];
    _showInfoTF.backgroundColor = [UIColor whiteColor];
    [self.view addSubview:_showInfoTF];
}

- (NSKeyedUnarchiver *)keyedUnarchiver{
    
    if(!_keyedUnarchiver){
        _keyedUnarchiver = [NSKeyedUnarchiver alloc];
    }
    return _keyedUnarchiver;
}


- (NSKeyedArchiver *)keyedArchiver{
    
    if(!_keyedArchiver){
        _keyedArchiver = [NSKeyedArchiver alloc];
    }
    return _keyedArchiver;
}
// 获取文件路径
- (NSString *)personFilePath{
    
    NSString *documents = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) firstObject];
    NSString *filePath = [documents stringByAppendingPathComponent:@"PersonFile"];
    NSLog(@"__%@__",filePath);
    return filePath;
}

// 键盘回收
-(void)touchesBegan:(NSSet *)touches withEvent:(UIEvent *)event{
    [self.view endEditing:YES];
}

// 解档/归档
-(void)MakeSomething:(UIButton *)bt{
    
    // 归档
    if (bt == _achiverButton) {
        Person *person = [[Person alloc] init];
        person.name = _nameTF.text;// 进行赋值
        person.sex = _sexTF.text;
        person.age = [_ageTF.text integerValue];
        
        NSMutableData *data = [NSMutableData dataWithCapacity:1];
        NSKeyedArchiver *psARCH = [self.keyedArchiver initForWritingWithMutableData:data];
        [psARCH encodeObject:person forKey:@"personKey"];
        // 结束归档
        [psARCH finishEncoding];
        // 写入磁盘
        [data writeToFile:[self personFilePath] atomically:YES];
        
        // 解档
    }else{
        
        NSData *data = [NSData dataWithContentsOfFile:[self personFilePath]];
        // 根据 data 生成解档器
        NSKeyedUnarchiver *psUNCH = [self.keyedUnarchiver initForReadingWithData:data];
        // 根据 key 值从 data 中解档出 person对象
        Person *person = [psUNCH decodeObjectForKey:@"personKey"];
        _showInfoTF.text = [NSString stringWithFormat:@"%@,%@,%ld",person.name,person.sex,person.age];
        
    }
}

@end

运行效果：将 Person 的姓名、性别、年龄归档后，通过点击解档按钮将信息展示在文本框中