OC_本地文件的存储

序言：翻阅资料，学习，探究，总结，借鉴，谢谢探路者，我只是个搬运工，不对不妥的地方欢迎指点。
参考、转发资料：

1、存储位置：

• 数据以文件的形式存储的话，建议存储在沙盒的Library/Caches路径下，这个路径下的文件一般存储体积大、不需要备份的非重要数据，比如网络数据缓存

2、存储方式

• json数据类型直接存储。
  这种方式存储的数据会以xml格式存储数据，在查看时不太直接，优点是比较好的对接项目中直接创建文件的形式。例如项目直接创建的plish文件的格式就是这样的。

  
  C012639B-D48E-48D1-919D-E8A97E0F5215.png

• data二进制类型数据存储。（推荐）
  这种方式存储的数据会直接以内容的形式存储，查看时直观

  
  18253C76-C0CA-49BB-AB29-6F39EF2E14C7.png

3、存取方法

/**
 写入数据到文件,默认文件路径：Caches

 @param json json数据
 @param fileName 文件名称
 @param fileDataFormatType 格式类型
 @param successBlcok 成功回调
 @param failBlock 失败回掉
 */
+ (void)fileDataStorageInDefaultPathCachesWithJson:(id)json
                                          FileName:(NSString * )fileName
                                fileDataFormatType:(SJFileDataGainStorageTool_FileDataFormatType)fileDataFormatType
                                      successBlcok:(void(^)(void))successBlcok
                                         failBlock:(void(^)(void))failBlock
{
    //  空数据对象
    if(json == nil && fileName== nil)
    {
        //  写入失败
        if(failBlock)
        {
            failBlock();
        }
        return;
    }
    
    //  获取Caches路径，使用caches是因为路径下的文件不会备份，适合存储缓存数据对象
    NSString *caches = [SJPathGainTool gainCachesPath];
    //  完整存储路径
    NSString *storageFilePath = [caches stringByAppendingPathComponent:fileName];
    
    //  写入数据到文件
    [self fileDataStorageWithJson:json filePath:storageFilePath fileDataFormatType:fileDataFormatType successBlcok:successBlcok failBlock:failBlock];
}


/**
 写入数据到文件

 @param json json数据
 @param filePath 路径
 @param fileDataFormatType 格式类型
 @param successBlcok 成功回调
 @param failBlock 失败回调
 */
+ (void)fileDataStorageWithJson:(id)json
                       filePath:(NSString * )filePath
             fileDataFormatType:(SJFileDataGainStorageTool_FileDataFormatType)fileDataFormatType
                   successBlcok:(void(^)(void))successBlcok
                      failBlock:(void(^)(void))failBlock
{
    
    //  空数据对象
    if(json == nil && filePath== nil)
    {
        //  写入失败
        if(failBlock)
        {
            failBlock();
        }
        return;
    }

    //  写入
    BOOL wirteResult = NO;
    if(fileDataFormatType == SJFileDataGainStorageTool_FileDataFormatType_Default)
    {
        //  二进制数据存储
        
        NSError *error ;
        NSData *jsonData = [NSJSONSerialization dataWithJSONObject:json options:NSJSONWritingPrettyPrinted error:&error ];
        
        if(error == nil)
        {
            wirteResult = [jsonData writeToFile:filePath atomically:YES];
        }
        else
        {
            //  写入失败
            if(failBlock)
            {
                failBlock();
            }
        }
    }
    else
    {
        //  json数据存储
        wirteResult = [json writeToFile:filePath atomically:YES];
    }
    
    if(wirteResult)
    {
        //  写入成功
        if(successBlcok)
        {
            successBlcok();
        }
    }
    else
    {
        //  写入失败
        if(failBlock)
        {
            failBlock();
        }
    }
}


/**
 读取文件中的数据，默认文件路径：Caches
 
 @param fileName 文件名称
 @param fileDataFormatType 格式类型     if  SJFileDataGainStorageTool_FileDataFormatType_Default    jsonType没意义
 @param jsonType json数据类型，array or dic
 @return json数据
 */
+ (id)fileDataGainInDefaultPathCachesWithFileName:(NSString *)fileName
                               fileDataFormatType:(SJFileDataGainStorageTool_FileDataFormatType)fileDataFormatType
                                 fileDataGainType:(SJFileDataGainStorageTool_FileDataJsonType)jsonType
{
    
    if(fileName == nil)
    {
        return nil;
    }
    
    //  获取Caches路径，使用caches是因为路径下的文件不会备份，适合存储缓存数据对象
    NSString *caches = [SJPathGainTool gainCachesPath];
    //  完整存储路径
    NSString *storageFilePath = [caches stringByAppendingPathComponent:fileName];
    
    //  读取文件中的数据
    id json = [self fileDataGainWithFilePath:storageFilePath fileDataFormatType:fileDataFormatType fileDataGainType:jsonType];
    
    return json;
}


/**
 读取文件中的数据
 
 @param filePath 文件路径
 @param fileDataFormatType 格式类型     if  SJFileDataGainStorageTool_FileDataFormatType_Default    jsonType没意义
 @param jsonType json数据类型，array or dic
 @return json数据
 */
+ (id)fileDataGainWithFilePath:(NSString *)filePath
            fileDataFormatType:(SJFileDataGainStorageTool_FileDataFormatType)fileDataFormatType
              fileDataGainType:(SJFileDataGainStorageTool_FileDataJsonType)jsonType
{
    
    if(filePath == nil)
    {
        return nil;
    }
    
    if(fileDataFormatType == SJFileDataGainStorageTool_FileDataFormatType_Default)
    {
        //  文件不带数据头，二进制数据
        NSData *jsonData = [NSData dataWithContentsOfFile:filePath];

        id json = [NSJSONSerialization JSONObjectWithData:jsonData options:NSJSONReadingAllowFragments error:nil];
        
        return json;
    }
    else
    {
        //  存储数据json类型
        if(jsonType == SJFileDataGainStorageTool_FileDataJsonType_ArrayJson)
        {
            //  数组数据
            NSArray *result_array = [NSArray arrayWithContentsOfFile:filePath];
            
            return result_array;
        }
        else if (jsonType == SJFileDataGainStorageTool_FileDataJsonType_DictionaryJson)
        {
            //  字典类型
            NSDictionary *result_dic = [NSDictionary dictionaryWithContentsOfFile:filePath];
            
            return result_dic;
        }
        else
        {
            return nil;
        }
    }
    
}

类文件git地址：
https://gitee.com/OC_SJOriginalDemoClass/FileDataGainStorage.git