iOS數據持久化存儲之歸檔NSKeyedArchiver

歸檔是一種很常用的文件儲存方法，幾乎任何類型的對象都能夠被歸檔儲存（實際上是一種文件保存的形式），收集了網上的一些資料並結合自己的一些經驗，總結如下。

一、使用archiveRootObject進行簡單的歸檔

 

使用NSKeyedArichiver進行歸檔、NSKeyedUnarchiver進行接檔，這種方式會在寫入、讀出數據之前對數據進行序列化、反序列化操作。

歸檔：

 　　 //1.獲取文件路徑　　

　　NSString *docPath=[NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0]; 　　

　　//2、添加儲存的文件名

　　NSString *path  = [docPath stringByAppendingPathComponent:@"data.archiver"];　　  

　　//3、將一個對象保存到文件中

　　BOOL flag = [NSKeyedArchiver archiveRootObject:@”歸檔” toFile:path]; 　　 

這種方式可以對字符串、數字等進行歸檔，當然也可以對NSArray與NSDictionary進行歸檔。返回值Flag標志着是否歸檔成功，YES為成功，NO為失敗。

接檔：

　　

　　//1.獲取文件路徑

　　NSString *docPath=[NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];

　　NSString *path=[docPath stringByAppendingPathComponent:@"person.yangyang"]; NSLog(@"path=%@",path);

　　//2.從文件中讀取對象

　　[NSKeyedUnarchiver unarchiveObjectWithFile:path]  

 

使用NSKeyedUnarchiver進行接檔（反序列化）。

這種歸檔的方式存在一個缺點：只能把一個對象歸檔進一個文件中，那么怎么對多個對象進行歸檔呢？

 

二、對多個對象的歸檔

同樣是使用NSKeyedArchiver進行歸檔，不同的是同時歸檔多個對象，這里我們舉例放入了一個CGPoint點、字符串、整數（當然很多類型都可以的，例如UIImage、float等等），使用encodeXXX方法進行歸檔，最后通過writeToFile方法寫入文件。

歸檔：寫入數據

　　//准備數據  

　　CGPoint point = CGPointMake(1.0, 2.0);  

　　NSString *info = @"坐標原點";  

　　NSInteger value = 10;  

　　NSString *docPath=[NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0];

　　NSString *multiHomePath = [docPath stringByAppendingPathComponent:@"multi.archiver"];  

　　NSMutableData *data = [[NSMutableData alloc] init];  

　　NSKeyedArchiver *archvier = [[NSKeyedArchiver alloc] initForWritingWithMutableData:data];  

　　//對多個對象進行歸檔  

　　[archvier encodeCGPoint:point forKey:@"kPoint"];  

　　[archvier encodeObject:info forKey:@"kInfo"];  

　　[archvier encodeInteger:value forKey:@"kValue"];  

　　[archvier finishEncoding];  

　　[data writeToFile:multiHomePath atomically:YES];  

 

 

接檔：從路徑中獲得數據構造NSKeyedUnarchiver實例，使用decodeXXXForKey方法獲得文件中的對象。

　　NSMutableData *dataR = [[NSMutableData alloc] initWithContentsOfFile:multiHomePath];  

　　NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc]initForReadingWithData:dateR];  

　　CGPoint pointR = [unarchiver decodeCGPointForKey:@"kPoint"];  

　　NSString *infoR = [unarchiver decodeObjectForKey:@"kInfo"];  

　　NSInteger valueR = [unarchiver decodeIntegerForKey:@"kValue"];  

　　[unarchiver finishDecoding];  

　　NSLog(@"%f,%f,%@,%d",pointR.x,pointR.y,infoR,valueR);  

 

可以看出對多個對象進行歸檔還是挺方便的，這里又出現一個問題，這里的對象都是基本類型數據，那么怎么對自己定義類生成的實例對象進行歸檔呢？

  

三、對自定義對象進行歸檔

自定義對象，應用范圍很廣，因為它對應着MVC中的Model層，即實體類。在程序中，我們會在Model層定義很多的entity，例如User，Teacher。。

那么對自定義對象的歸檔顯得重要的多，因為很多情況下我們需要在Home鍵之后保存數據，在程序恢復時重新加載，那么，歸檔便是一個好的選擇。

首先我們需要，自定義一個實體類。

//  YYViewController.m


#import "YYViewController.h"
#import "YYPerson.h"

@interface YYViewController ()
- (IBAction)saveBtnOnclick:(id)sender;
- (IBAction)readBtnOnclick:(id)sender;

@end

@implementation YYViewController

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


- (IBAction)saveBtnOnclick:(id)sender {
    //1.創建對象
    YYPerson *p=[[YYPerson alloc]init];
    p.name=@"圓圓";
    p.age=23;
    p.height=1.7;
    
    //2.獲取文件路徑
    NSString *docPath=[NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES)lastObject];
    NSString *path=[docPath stringByAppendingPathComponent:@"person.yangyang"];
    NSLog(@"path=%@",path);
    
    //3.將自定義的對象保存到文件中
    [NSKeyedArchiver archiveRootObject:p toFile:path];
    
}

- (IBAction)readBtnOnclick:(id)sender {
    //1.獲取文件路徑
    NSString *docPath=[NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES)lastObject];
    NSString *path=[docPath stringByAppendingPathComponent:@"person.yangyang"];
    NSLog(@"path=%@",path);
    
    //2.從文件中讀取對象
    YYPerson *p=[NSKeyedUnarchiver unarchiveObjectWithFile:path];
    NSLog(@"%@,%d,%.1f",p.name,p.age,p.height);
}
@end

 

 

//  YYPerson.h

#import <Foundation/Foundation.h>

// 如果想將一個自定義對象保存到文件中必須實現NSCoding協議
@interface YYPerson : NSObject<NSCoding>

//姓名
@property(nonatomic,copy)NSString *name;
//年齡
@property(nonatomic,assign)int age;
//身高
@property(nonatomic,assign)double height;
@end

 

//  YYPerson.m

#import "YYPerson.h"

@implementation YYPerson

// 當將一個自定義對象保存到文件的時候就會調用該方法
// 在該方法中說明如何存儲自定義對象的屬性
// 也就說在該方法中說清楚存儲自定義對象的哪些屬性
-(void)encodeWithCoder:(NSCoder *)aCoder
{
    NSLog(@"調用了encodeWithCoder:方法");
    [aCoder encodeObject:self.name forKey:@"name"];
    [aCoder encodeInteger:self.age forKey:@"age"];
    [aCoder encodeDouble:self.height forKey:@"height"];
}

// 當從文件中讀取一個對象的時候就會調用該方法
// 在該方法中說明如何讀取保存在文件中的對象
// 也就是說在該方法中說清楚怎么讀取文件中的對象
-(id)initWithCoder:(NSCoder *)aDecoder
{
    NSLog(@"調用了initWithCoder:方法");
    //注意：在構造方法中需要先初始化父類的方法
    if (self=[super init]) {
        self.name=[aDecoder decodeObjectForKey:@"name"];
        self.age=[aDecoder decodeIntegerForKey:@"age"];
        self.height=[aDecoder decodeDoubleForKey:@"height"];
    }
    return self;
}
@end

 

基於歸檔創建一個用於本地數據存儲的類如下：

 

#import <Foundation/Foundation.h>

@interface LocalArchiverManager : NSObject

/**單例模式，獲取請求管理類
 *\param        param:   無
 *\returns      return:     無
 */
+ (LocalArchiverManager *)shareManagement;

/**清除本地的序列化的文件
 *\param        param:   無
 *\returns      return:     無
 */
- (void)clearArchiverData;

/**保存緩存數據
 *\param        obj:   數據源
 *\param        key:     接口的名稱
 *\returns      無
 */
- (void)saveDataArchiver:(id)obj andAPIKey:(NSString *)key;

/**回去緩存數據
 *\param        obj:   api的key
 *\returns      id:     返回的數據源
 */
- (id)archiverQueryAPIKey:(NSString *)key;
@end

 

LocalArchiverManager.m 文件

#import "LocalArchiverManager.h"

static LocalArchiverManager *m_localArchiverMana;
#define Document [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) objectAtIndex:0]
#define ArchiverFile    [Document stringByAppendingPathComponent:@"Archiver"]

@interface LocalArchiverManager()

@property(nonatomic,retain)NSFileManager *fileManager;

@end

@implementation LocalArchiverManager+ (LocalArchiverManager *)shareManagement
{
    static dispatch_once_t onceTocken;
    dispatch_once(&onceTocken, ^
    {
        m_localArchiverMana = [[LocalArchiverManager alloc] init];
    });
    return m_localArchiverMana;
}

- (id)init
{
    self = [super init];
    if(self)
    {
       self.fileManager = [NSFileManager defaultManager];
    }
    return self;
}


#pragma mark private methods

- (BOOL)checkPathIsExist:(NSString *)path
{
    return [_fileManager fileExistsAtPath:path isDirectory:nil];
}

- (void)createArchiverFile
{
    if (![self checkPathIsExist:ArchiverFile])
    {
        [self addNewFolder:ArchiverFile];
    }
}


//新建目錄,path為目錄路徑(包含目錄名)
- (void)addNewFolder:(NSString *)path
{
    [_fileManager createDirectoryAtPath:path
             withIntermediateDirectories:YES
                              attributes:nil
                                   error:nil];
}

#pragma mark -
#pragma mark public methods

- (void)clearArchiverData
{
    NSError *error;
    if([m_fileManager removeItemAtPath:ArchiverFile error:&error])
    {
    
    }else{
        DLOG(@"清除本地序列化的文件失敗....:%@",error);
    }
}

- (void)saveDataArchiver:(id)obj andAPIKey:(NSString *)key
{
    NSMutableData *data = [[NSMutableData alloc] init];
    NSKeyedArchiver *archiver = [[NSKeyedArchiver alloc] initForWritingWithMutableData:data];
    [archiver encodeObject:obj forKey:key];
    [archiver finishEncoding];
    [self createArchiverFile];
    key = [key stringByReplacingOccurrencesOfString:@"/" withString:@"_"];
    NSString *path = [ArchiverFile stringByAppendingPathComponent:[NSString stringWithFormat:@"%@.text",key]];　　　
  　BOOL isSuc = [data writeToFile:path atomically:YES];
if(!isSuc) {
        DLOG(@"本地序列化失敗key....:%@",key);
    }
}
- (id)archiverQueryAPIKey:(NSString *)key
{
    NSString *str = [key stringByReplacingOccurrencesOfString:@"/" withString:@"_"];
    NSString *path = [ArchiverFile stringByAppendingPathComponent:[NSString stringWithFormat:@"%@.text",str]];
    NSMutableData *data = [[NSMutableData alloc] initWithContentsOfFile:path];
    NSKeyedUnarchiver *unarchiver = [[NSKeyedUnarchiver alloc] initForReadingWithData:data];
    id content = [unarchiver decodeObjectForKey:key];
    [unarchiver finishDecoding];
    DLOG(@"content.....:%@",content);
    return content;
}