前言

还记得大学刚开始学习数据库的时候，天真地认为世界上所有的存储都需要用数据库来完成。后来毕业后，正值 NOSQL 流行之时，那时我在网易参与了网易微博的开发，我们当时使用了有道自己做的 “BigTable”— OMAP 来存储微博数据，那个时候才发现，其实 Key-Value 这种简单的存储也能搞定类似微博这类不太复杂的存储逻辑。

相比 MYSQL，当数据量超过千万后，NOSQL 的优势就体现出来了：对于海量数据，NOSQL 在存取速度上没有任何影响，另外，天生的多备份和分布式，也使得数据安全和扩容变得异常容易。

iOS 端的尝试

后来我从后台转做 iOS 端的开发，我就尝试了在 iOS 端直接使用 Key-Value 式的存储。经过在粉笔网、猿题库、小猿搜题三个客户端中的尝试后，我发现 Key-Value 式的存储不仅完全能够满足大多数移动端开发的需求，而且非常适合移动端使用。主要原因是：移动端存储的数据量不会很大：

• 如果是单机的应用（例如效率工具 Clear），用户自己创建的数据最多也就是上万余条。
• 如果是有服务端的应用（例如网易新闻，微博），那移动端通常不会保存全量的数据，每次只会从服务器获取数据，本地只是做一些内容的缓存而已，所以也不会有很大的数据量。

如果数据量不大，那么在 iOS 端使用最简单直接的 Key-Value 存储就能带来开发上的效率优势。它能保证：

1. Model 层的代码编写简单，易于测试。
2. 由于 Value 是 JSON 格式，所以在做 Model 字段更改时，易于扩展和兼容。

实现方案

在存储引擎上，2 年前我选择直接使用 Sqlite 作为存储引擎，相当于每个数据库表只有 Key，Value 两个字段。后来，随着 LevelDB 的流行，业界也有一些应用采用了 LevelDB 来做 iOS 端的 Key-Value 存储引擎，例如开源的 ViewFinder。

因为 LevelDB 本身并不是为移动端设计的，我担心它过于占用内存，我自己也没有看到业界有在移动端针对 LevelDB 做很详细的测试，连 LevelDB 的 iOS 端移植都不是官方做的。加上我自己写的基于 Sqlite 的 Key-Value 存储用着也没有什么问题，所以我也就一直没有更换成 LevelDB。

开源

经过两年的使用和测试，我认为它非常好用，而且代码也非常简单，只有不到 400 行。所以现在开源分享给大家，这个项目叫做 YTKKeyValueStore，项目在 这里。以下是一个简单的使用示例：

YTKKeyValueStore *store = [[YTKKeyValueStore alloc] initDBWithName:@"test.db"];
NSString *tableName = @"user_table";
[store createTableWithName:tableName];
// 保存
NSString *key = @"1";
NSDictionary *user = @{@"id": @1, @"name": @"tangqiao", @"age": @30};
[store putObject:user withId:key intoTable:tableName];
// 查询
NSDictionary *queryUser = [store getObjectById:key fromTable:tableName];
NSLog(@"query data result: %@", queryUser);

集成说明

使用本项目，你需要将开源代码中的 YTKKeyValueStore.h 和 YTKKeyValueStore.m 添加到你的工程中，并且在工程设置的 Link Binary With Libraries 中，增加 libsqlite3.dylib，如下图所示：

由于时间关系，当前还未提供 Cocoapods 方式集成。

使用说明

所有的接口都封装在 YTKKeyValueStore 类中。以下是一些常用方法说明。

打开（或创建）数据库

通过 initDBWithName 方法，即可在程序的 Document 目录中打开指定的数据库文件。如果该文件不存在，则会创建一个新的数据库。

// 打开名为test.db的数据库，如果该文件不存在，则创新一个新的。
YTKKeyValueStore *store = [[YTKKeyValueStore alloc] initDBWithName:@"test.db"];

创建数据库表

通过 createTableWithName 方法，我们可以在打开的数据库中创建表，如果表名已经存在，则会忽略该操作。如下所示：

YTKKeyValueStore *store = [[YTKKeyValueStore alloc] initDBWithName:@"test.db"];
NSString *tableName = @"user_table";
// 创建名为user_table的表，如果已存在，则忽略该操作
[store createTableWithName:tableName];

读写数据

YTKKeyValueStore 类提供 key-value 的存储接口，存入的所有数据需要提供 key 以及其对应的 value，读取的时候需要提供 key 来获得相应的 value。

YTKKeyValueStore 类支持的 value 类型包括：NSString, NSNumber, NSDictionary 和 NSArray，为此提供了以下接口：

- (void)putString:(NSString *)string withId:(NSString *)stringId intoTable:(NSString *)tableName;
- (void)putNumber:(NSNumber *)number withId:(NSString *)numberId intoTable:(NSString *)tableName;
- (void)putObject:(id)object withId:(NSString *)objectId intoTable:(NSString *)tableName;

与此对应，有以下 value 为 NSString, NSNumber, NSDictionary 和 NSArray 的读取接口：

- (NSString *)getStringById:(NSString *)stringId fromTable:(NSString *)tableName;
- (NSNumber *)getNumberById:(NSString *)numberId fromTable:(NSString *)tableName;
- (id)getObjectById:(NSString *)objectId fromTable:(NSString *)tableName;

删除数据接口

YTKKeyValueStore 提供了以下接口用于删除数据。

// 清除数据表中所有数据
- (void)clearTable:(NSString *)tableName;

// 删除指定key的数据
- (void)deleteObjectById:(NSString *)objectId fromTable:(NSString *)tableName;

// 批量删除一组key数组的数据
- (void)deleteObjectsByIdArray:(NSArray *)objectIdArray fromTable:(NSString *)tableName;

// 批量删除所有带指定前缀的数据
- (void)deleteObjectsByIdPrefix:(NSString *)objectIdPrefix fromTable:(NSString *)tableName;

更多接口

YTKKeyValueStore 还提供了以下接口来获取表示内部存储的 key-value 对象。

// 获得指定key的数据
- (YTKKeyValueItem *)getYTKKeyValueItemById:(NSString *)objectId fromTable:(NSString *)tableName;
// 获得所有数据
- (NSArray *)getAllItemsFromTable:(NSString *)tableName;

由于 YTKKeyValueItem 类带有 createdTime 字段，可以获得该条数据的插入（或更新）时间，以便上层做复杂的处理（例如用来做缓存过期逻辑）。

协议

YTKKeyValueStore 授权在 MIT 协议下使用。请查阅 LICENSE 文件以获取更多信息。

其它

两年前编写了不少测试用例，但后来丢失了，因此现在的新项目中还没有测试用例。由于时间原因，更详细的使用说明将在稍后更新到项目中。