勤之时 - 数据持久层的实现

应用很早就上线了，欢迎大家下载使用：http://itunes.apple.com/app/id1206687109
源码已经公开，大家可以去https://github.com/Inspirelife96/ILDiligence下载。 喜欢的话Fork或者给个Star，非常感谢。
下面是这一系列的全部帖子：
想法和原型
勤之时 - 架构与工程组织结构
勤之时 - 数据持久层的实现
勤之时 - 网络层的实现
勤之时 - 业务逻辑层
勤之时 - Info.plist的改动
勤之时 - 表示层（一）
勤之时 - 表示层（二）
勤之时 - 表示层（三）
勤之时 - 表示层（四）
勤之时 - 表示层（五）

关于数据持久层的设计，首先推荐一篇大神的文章iOS应用架构谈 本地持久化方案及动态部署

我们一点点来看, 首先根据需求决定持久化方案
那么需求是什么？
【勤之时】有一个任务列表，每个任务有自己的一些配置，并可以增，删任务，和修改任务配置。另外一个比较重要的是，任务执行状况的统计分析，这意味着每次执行任务时，需要记录下来。此外，还有每日图片分享，这个图片以及图片介绍是每日从网上下载的，若没有网络的情况下，则用前一次的图片及内容。

持久层需求.png

综上所述，有3个需要持久化的内容

• 任务列表及其配置， 若以数据库表结构来描述一个任务（Task Data Table），如下 ）（需要增，删，改，查）

字段名	属性	描述
id	string	任务ID，主键，也可以为数字类型
name	string	任务名字
color	string	任务配色
diligenceTime	number	专注时长
isRestMode	bool	是否为休息模式
restTime	number	休息时长
isFocusMode	bool	是否为沉浸模式
musicName	string	背景音乐
isMusicEnabled	bool	背景音乐是否打开
isAlertEnabled	bool	是否打开任务提醒
alertTime	date	任务提醒时间

• 任务列表及其配置， 若以数据库表结构来描述一个专注（Diligence Data Table），如下 （需要增，删，查）

字段名	属性	描述
id	string	任务ID，外键，与Task Data Table 的id关联
startDate	date	专注开始时间
endDate	date	专注结束时间
breakTimes	number	中断次数
diligenceTime	number	专注时长

• 每日图片及故事， 若以数据库表结构来表述 （Todays Story），如下，（仅需保留最近一次的值即可）。

字段名	属性	描述
dateToday	date	主键，日期
title	string	描述
attribute	string	来源
para1	string	今日背景图故事
image	data	专注时长

有哪些方案？

下面内容摘抄自大神的文章
在有需要持久化需求的时候，我们有非常多的方案可供选择：NSUserDefault、KeyChain、File，以及基于数据库的无数子方案。因此，当有需要持久化的需求的时候，我们首先考虑的是应该采用什么手段去进行持久化。

• NSUserDefault
  一般来说，小规模数据，弱业务相关数据，都可以放到NSUserDefault里面，内容比较多的数据，强业务相关的数据就不太适合NSUserDefault了。

• keychain
  Keychain是苹果提供的带有可逆加密的存储机制，普遍用在各种存密码的需求上。另外，由于App卸载只要系统不重装，Keychain中的数据依旧能够得到保留，以及可被iCloud同步的特性，大家都会在这里存储用户唯一标识串。所以有需要加密、需要存iCloud的敏感小数据，一般都会放在Keychain。

• 文件存储
  文件存储包括了Plist、archive、Stream等方式，一般结构化的数据或者需要方便查询的数据，都会以Plist的方式去持久化。Archive方式适合存储平时不太经常使用但很大量的数据，或者读取之后希望直接对象化的数据，因为Archive会将对象及其对象关系序列化，以至于读取数据的时候需要Decode很花时间，Decode的过程可以是解压，也可以是对象化，这个可以根据具体<NSCoding>中的实现来决定。Stream就是一般的文件存储了，一般用来存存图片啊啥的，适用于比较经常使用，然而数据量又不算非常大的那种。

• 数据库存储
  数据库存储的话，花样就比较多了。苹果自带了一个Core Data，当然业界也有无数替代方案可选，不过真正用在iOS领域的除了Core Data外，就是FMDB比较多了。数据库方案主要是为了便于增删改查，当数据有状态和类别的时候最好还是采用数据库方案比较好，而且尤其是当这些状态和类别都是强业务相关的时候，就更加要采用数据库方案了。因为你不可能通过文件系统遍历文件去甄别你需要获取的属于某个状态或类别的数据，这么做成本就太大了。当然，特别大量的数据也不适合直接存储数据库，比如图片或者文章这样的数据，一般来说，都是数据库存一个文件名，然后这个文件名指向的是某个图片或者文章的文件。如果真的要做全文索引这种需求，建议最好还是挂个API丢到服务端去做。

从需求上看，需求1，2需要对两张表进行增删改查，而且规则并不复杂，数据量也不会很大，且并不需要加密，所以这里考虑用文件存储，以Plist的方式去持久化。
Task Data Table 以 字典的形式 （task id -> task data dictionary）存储在Document文件夹下的taskData.plist。
Diligence Data Table 以字典的形式 （task id -> diligence data dictionary）存储在Document文件夹下的diligenceData.plist。

需求3仅需要保留最近一次的结果，但里面有一个图片数据，鉴于他有且仅有一个图片数据，这里还是继续使用Plist文件，存储在Document文件夹下的storyData.plist。

和数据库形式的持久层不同，Plist这里仅提供了读取和保存的功能。其他的例如增，删，改的功能，上移到业务逻辑层去实现了。

最终代码, 以ILDTaskDataPersistence为例，其他的请参考Github里的ILDPersistenceLayer工程(https://github.com/Inspirelife96/ILDiligence)

ILDTaskDataPersistence Class

//  ILDTaskDataPersistence.h


#import <Foundation/Foundation.h>

@interface ILDTaskDataPersistence : NSObject

+ (NSDictionary *)readTaskData;
+ (void)saveTaskData:(NSDictionary *)taskDataNSDictionary;

@end

//  ILDTaskDataPersistence.m


#import "ILDTaskDataPersistence.h"
#import "ILDPersistenceFilePathHelper.h"

NSString *const kTaskDataPersistanceFile = @"taskData.plist";

@implementation ILDTaskDataPersistence

+ (NSDictionary *)readTaskData {
    NSString *taskDataFilePath = [ILDPersistenceFilePathHelper persistenceFilePath:kTaskDataPersistanceFile];
    NSDictionary *taskDataDictionary = [NSDictionary dictionaryWithContentsOfFile:taskDataFilePath];
    if (!taskDataDictionary) {
        NSString *defaultTaskDataFilePath = [[NSBundle mainBundle] pathForResource:kTaskDataPersistanceFile ofType:nil];
        taskDataDictionary = [NSDictionary dictionaryWithContentsOfFile:defaultTaskDataFilePath];
        [ILDTaskDataPersistence saveTaskData:taskDataDictionary];
    }
    
    return taskDataDictionary;
}

+ (void)saveTaskData:(NSDictionary *)taskDataNSDictionary {
    NSString *taskDataFilePath = [ILDPersistenceFilePathHelper persistenceFilePath:kTaskDataPersistanceFile];
    [taskDataNSDictionary writeToFile:taskDataFilePath atomically:YES];
}

@end