
前言:
每次開發遇到數據庫,我都會糾結到底用 CoreData 還是 FMDB。CoreData 的 API 看似簡單,可調用棧卻異常繁瑣——光是初始化一個 Context 就得寫上二十來行代碼。
面對這麼糟心的狀況,勤奮的開源社區自然有人站出來。於是有了 MagicRecord 這款 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 的基本數據類型不支持 Optional,即不支援 Int?、Int! 等;對象類型則支持 Optional。
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 為需要更新的字段名,傳 nil 表示全量更新。
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 + (NSArray * _Nullable)jr_excludePropertyNames; + (NSString * _Nullable)jr_customPrimarykey; - (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; - (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 (覺得不錯的話,歡迎點個 star~)
這是我第一次寫這類東西,GitHub 上或許已有不少類似實現,若有不足之處,還望多多指教。