使用 NSPropertyListSerialization 持久化字典与数组

NSPropertyListSerialization

The NSPropertyListSerialization class provides methods that convert property list objects to and from several serialized formats. Property list objects include NSData, NSString, NSArray, NSDictionary, NSDate, and NSNumber objects. These objects are toll-free bridged with their respective Core Foundation types (CFData, CFString, and so on). For more about toll-free bridging, see “Interchangeable Data Types”.

NSPropertyListSerialization这个类提供了一些方法,专门用来转换不同组织形式的list对象.list对象包括了NSData, NSString, NSArray, NSDictionary, NSDate, 以及 NSNumber.这些对象与衍生出他们的祖先对象有着一些联系,对于toll-free bridging,请看“Interchangeable Data Types”.

大家都应该使用过NSCoding协议来持久化一个对象,但你试着用NSCoding协议来持久化一个字典或者数组试一下.

问:为什么要持久化一个字典或者数组呢?

持久化一个字典或者数组,可以使用方法writeToFile:atomically:来写文件,但是有一个问题,这个只能写成plist文件,别人是可以通过明文来观看的,我可不喜欢别人能看清楚我存储了一些什么数据,你也是一样对吧.为什么要持久化一个字典或者数组呢?在需要存储的数据比较少时,此时又不需要数据库那种麻烦的查表方式来更改数据,更不需要CoreData这种大炮来打蚊子,所以,将数据存储于一个字典或者数组中便于维护以及轻量级,但是存储后成了plist文件,别人可以看到怎么办?那就把它存储成加密的NSData吧.

注:使用NSCoding协议是可以实现存储字典的,但是,那代码量你可以上网搜索一下解决方案,让人望而却步,本人在这里推荐使用下面的一个类NSPropertyListSerialization来处理字典或者数组的本地加密持久化,省掉你无数的代码.

使用非常简单,如下图所示:

注意:生成的NSData要记得进行加密后存储,提出出NSData时也需要进行解密操作后提取出来,推荐使用Des加密,看看有多简单.

附录:

经过本人一小时奋战,将NSPropertyListSerialization进行简易封装,附带源码以及使用教程,隐藏了NSPropertyListSerialization实现细节.

ListObjectOperation.h + ListObjectOperation.m

//
//  ListObjectOperation.m
//
//  Copyright (c) 2014年 Y.X. All rights reserved.
//

#import <Foundation/Foundation.h>

/**
 创建简单的文件路径
 
 @param filePath 简单的文件路径,如 @"/Documents/Y.X."
 
 @return 完整的沙盒文件路径
 */
NS_INLINE NSString * simpleFilePath(NSString *filePath)
{
    /*
     /Documents
     /Library/Caches
     /Library/Preferences
     /tmp
     */
    return [NSHomeDirectory() stringByAppendingString:filePath];
}

@interface ListObjectOperation : NSObject

/**
 将字典转换为NSData后进行存储
 
 @param dictionary 字典
 @param path 存储的路径
 
 @return none
 */
+ (void)storeDictionary:(NSDictionary *)dictionary toPath:(NSString *)path;

/**
 同步进行本地NSData以及字典同时操作
 
 @param path 字典NSData的路径
 @param flag 是否存储
 @param dictionary block中的字典,如果flag为YES,则修改的list值会被保存,flag为NO,则修改的值不会同步保存
 
 @return none
 */
+ (void)syncDictionaryWithDataPath:(NSString *)path
                              save:(BOOL)flag
                        dictionary:(void (^)(NSMutableDictionary *list))dictionary;

@end

//
//  ListObjectOperation.m
//
//  Copyright (c) 2014年 Y.X. All rights reserved.
//

#import "ListObjectOperation.h"

NS_INLINE NSData * dataFromFileUrlPath(NSString *path)
{
    return [NSData dataWithContentsOfURL:[NSURL fileURLWithPath:path]];
}

@implementation ListObjectOperation

+ (void)storeDictionary:(NSDictionary *)dictionary toPath:(NSString *)path
{
    NSData *data = [[self class] dataWithListObject:dictionary];
    [data writeToFile:path
           atomically:YES];
}

+ (void)syncDictionaryWithDataPath:(NSString *)path
                              save:(BOOL)flag
                        dictionary:(void (^)(NSMutableDictionary *list))dictionary
{
    // 获取字典
    NSDictionary *dic = [[self class] listObjectWithdata:dataFromFileUrlPath(path)];
    
    // 转化为可变字典
    NSMutableDictionary *changeDic = [NSMutableDictionary dictionaryWithDictionary:dic];
    
    if (flag == YES)
    {
        // 传入到字典中
        dictionary(changeDic);
     
        // 生成二进制文件
        NSData *data = [[self class] dataWithListObject:changeDic];
        
        // 进行存储(覆盖了之前的文件)
        [data writeToFile:path
               atomically:YES];
    }
    else
    {
        // 传入到字典中
        dictionary(changeDic);
    }
}

+ (NSData *)dataWithListObject:(id)listObject
{
    return [NSPropertyListSerialization dataWithPropertyList:listObject
                                                      format:NSPropertyListBinaryFormat_v1_0
                                                     options:0
                                                       error:nil];
}

+ (id)listObjectWithdata:(NSData *)data
{
    return [NSPropertyListSerialization propertyListWithData:data
                                                     options:0
                                                      format:NULL
                                                       error:nil];
}

@end

第一步:进行存储操作(请君先执行一遍程序,生成一个二进制文件 .YouXianMing 存储在沙盒的 /Document文件夹下)

第二步:同步修改字典以及存储二进制文件(请君再一次运行程序)

第三步:验证是否存储进去了

担心效率吗?不用担心,才2ms而已.实际上我测试了同时修改和存储,也就3ms,轻量级存储实在是太简单了^_^.