JRDB:iOS對FMDB的超好用封裝

原文地址:http://www.cocoachina.com/ios/20160531/16507.html

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

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

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

所以,最后還是選擇了FMDB進行封裝。

項目簡介:

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(安裝)


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

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,321評論 6 543
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,559評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,442評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,835評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,581評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,922評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,931評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,096評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,639評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,374評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,591評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,104評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,789評論 3 349
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,196評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,524評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,322評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,554評論 2 379

推薦閱讀更多精彩內容