前言：

在自己開發中，每次用到數據庫都會糾結是使用CoreData還是FMDB。CoreData雖然Api簡單，但是調用棧非常復雜，要初始化一個Context需要至少20行代碼。。。

顯然，對於這種這麼惡心的情況，我們的大Github必須有人會跳出來解決這種問題。於是就出現了MagicRecord這個對CoreData的封裝庫。一開始遇到這個庫的時候，好用到幾乎讓我想把所有項目的數據庫都換成CoreData了。兩句話解決CoreData調用棧的初始化，一句話完成數據庫版本升級和自動數據合並更新（雖然我們很少用到）。

然而這並不能解決一個根本性的問題，CoreData中的每個Object都要和一個context進行綁定，導致我們很多業務需求需要創建自己的私有context，然後再需要更新的時候保存到主context中。這又導致了我們在controller中或者在自己的業務類中維護多一個私有context屬性。

所以，最後還是選擇了FMDB進行封裝。

之前自己搞過Java後台，將FMDB進行Hibernate式的封裝，使用runtime解析，不用繼承任何基類（swift中要繼承NSObject），只要實現一個持久化協議並實現方法即可，屏蔽基本的數據庫和表操作。

項目簡介：

JRDB：一個對FMDB進行類Hibernate封裝的iOS庫，支持Objective-C 和 Swift。

Description

• 使用分類的模式，模仿Hibernate，對FMDB進行簡易封裝

• 支持pod 安裝 『pod 'JRDB'』，Podfile需要添加 use_framework!

• 使用協議，不用繼承基類，對任意NSObject可以進行入庫操作

• 支持swift 和 Objective-C

• 支持數據類型：基本數據類型（int，double，等），String，NSData，NSNumber，NSDate

注：Swift的基本數據類型，不支持Option類型，既不支持Int？Int！等，對象類型支持Option類型

Installation（安裝）

use_frameworks!
pod 'JRDB'
@import JRDB;

Usage

Save（保存）

• Objective-C

Person *p = [[Person alloc] init];
p.a_int = 1;
p.b_unsigned_int = 2;
p.c_long = 3;
p.d_long_long = 4;
p.e_unsigned_long = 5;
p.f_unsigned_long_long = 6;
p.g_float = 7.0;
p.h_double = 8.0;
p.i_string = @"9";
p.j_number = @10;
p.k_data = [NSData data];
p.l_date = [NSDate date];
[p jr_save];

• Swift

Swift中需要入庫的類需要繼承NSObject（使用到runtime）

The Object that you want to persistent should inherit from NSObject

let p = Person()
p.name = "name"
p.age = 10
p.birthday = NSDate()
p.jr_save()

Update（更新）

Person *p = [Person jr_findAll].firstObject;
p.name = @"abc";
[p jr_update columns:nil];

column: 需要更新的字段名，傳入空為全量更新

Delete（刪除）

Person *p = [Person jr_findAll].firstObject;
[p jr_delete];

Select（查找）

• 常規查找

Person *p = [Person jr_findByPrimaryKey:@"111"];
NSArray *list = [Person jr_findAll];
NSArray *list1 = [Person jr_findAllOrderBy:@"_age" isDesc:YES];

• 條件查詢

NSArray *condis = @[
     [JRQueryCondition condition:@"_l_date < ?" args:@[[NSDate date]] type:JRQueryConditionTypeAnd],
     [JRQueryCondition condition:@"_a_int > ?" args:@[@9] type:JRQueryConditionTypeAnd],];
NSArray *arr = [Person jr_findByConditions:condis
                      groupBy:@"_room"
                      orderBy:@"_age"
                      limit:@" limit 0,13 "
                      isDesc:YES];

• SQL

NSString *sql = @"select * from Person where age = ?";
NSArray *list = [Person jr_executeSql:sql args:@[@10]];

Other（其他）

協議：JRPersistent

@protocol JRPersistent @required
- (void)setID:(NSString * _Nullable)ID;
- (NSString * _Nullable)ID;
@optional
/**
 *  返回不用入庫的對象字段數組
 *  The full property names that you want to ignore for persistent
 *  @return array
 */
+ (NSArray * _Nullable)jr_excludePropertyNames;
/**
 *  返回自定義主鍵字段
 *  @return 字段全名
 */
+ (NSString * _Nullable)jr_customPrimarykey;
/**
 *  返回自定義主鍵值
 *  @return 主鍵值
 */
- (id _Nullable)jr_customPrimarykeyValue;
@end

主鍵

默認每個Object的主鍵為ID， UUID字符串。

可以實現 jr_customPrimarykey 以及 jr_customPrimarykeyValue 方法，自定義主鍵。

默認NSObject分類實現

@interface NSObject (JRDB) (...methods)
@end
JRDBMgr
@interface JRDBMgr : NSObject
@property (nonatomic, strong) FMDatabase *defaultDB;
+ (instancetype)shareInstance;
+ (FMDatabase *)defaultDB;
- (FMDatabase *)createDBWithPath:(NSString *)path;
- (void)deleteDBWithPath:(NSString *)path;
/**
 *  在這裡注冊的類，使用本框架的數據庫將全部建有這些表
 *  @param clazz 類名
 */
- (void)registerClazzForUpdateTable:(Class)clazz;
- (NSArray *)registedClazz;
/**
 * 更新默認數據庫的表（或者新建沒有的表）
 * 更新的表需要在本類先注冊
 */
- (void)updateDefaultDB;
- (void)updateDB:(FMDatabase *)db;
@end

JRDBMgr持有一個默認數據庫（~/Documents/jrdb/jrdb.sqlite），任何不指定數據庫的操作，都在此數據庫進行操作。默認數據庫可以自行設置。

Method

- (void)registerClazzForUpdateTable:(Class)clazz;

在JRDBMgr中注冊的類，可以使用

-(void)updateDB:(FMDatabase *)db

進行統一更新或者創建表。

Table Operation（表操作）

Create（建表）

// FMDatabase+JRDB 方法
[[JRDBMgr defaultDB] createTable4Clazz:[Person class]];
[Person jr_createTable];
// 刪除原有的表，重新創建
[[JRDBMgr defaultDB] truncateTable4Clazz:[Person class]];
[Person jr_truncateTable];
//保存時，若發現沒有表，將自動創建
[person jr_save];
Update 【更新表】
[[JRDBMgr defaultDB] updateTable4Clazz:[Person class]];
[Person jr_updateTable];

更新表時，只會添加不存在的字段，不會修改字段屬性，不會刪除字段，若有需要，需要自行寫sql語句進行修改

Drop（刪表）

[[JRDBMgr defaultDB] dropTable4Clazz:[Person class]];
[Person jr_dropTable];

Thread Operation（線程操作）

多線程操作使用FMDB自帶的 FMDatabaseQueue

[person jr_saveWithComplete:^(BOOL success) {
    NSLog(@"%d", success);
}];

任何帶complete block的操作，都將放入到FMDatabaseQueue進行順序執行

注：所有需要立刻返回結果，或者影響其他操作的數據庫操作，都建議放在主線程進行更新，大批量更新以及多線程操作數據庫時，請使用帶complete block的操作。

MoreUsage

• 查看FMDatabase+JRDB.h

項目地址：https://github.com/scubers/JRDB（覺得可以的話就麻煩星一下呗~~~）

第一次寫這種東西，可能已經Github上已經有了很多類似的東西，如果有不足之處還請指教。