05 FMDB源代碼剖析

FMDB是SQLite C語(yǔ)言接口的Objective-C封裝,最近看的幾份代碼,CTPersistance, YYCache, 都是直接使用C語(yǔ)言接口,YTKKeyValueStore倒是使用了FMDB,順帶就把FMDB給看了。

代碼比較簡(jiǎn)單,主要類就

FMDatabase,負(fù)責(zé)管理數(shù)據(jù)庫(kù)連接,并且執(zhí)行SQL語(yǔ)句,并不對(duì)外提供FMStatement類,查詢結(jié)果返回FMResultSet.

FMResultSet當(dāng)然是負(fù)責(zé)查詢結(jié)果的。也沒(méi)有什么特別注意的內(nèi)容。

一個(gè)比較有意思的功能是提供FMDatabaseQueue來(lái)保證數(shù)據(jù)庫(kù)的多線程安全訪問(wèn)。

前兩周看的代碼,做了一些筆記,摘抄如下:

一些功能小結(jié)

1)FMDatabase的緩存stmt語(yǔ)句對(duì)象

2)FMStatement可以當(dāng)做FMDatabase類的私有類,并不對(duì)外提供

3)一個(gè)SQL語(yǔ)句的執(zhí)行過(guò)程

- (FMResultSet*)executeQuery:(NSString*)sql withArgumentsInArray:(NSArray*)arrayArgs orDictionary:(NSDictionary*)dictionaryArgs orVAList:(va_list)args

FMDatabase

講SQL語(yǔ)句執(zhí)行的功能封裝在executeQuery和executeUpdate兩大方法里,內(nèi)部使用FMStatement類封裝sql語(yǔ)句對(duì)象sqlite3_stmt,不過(guò)也只是字符串而已。

- (FMResultSet*)executeQuery:(NSString*)sql withArgumentsInArray:(NSArray*)arrayArgs orDictionary:(NSDictionary*)dictionaryArgs orVAList:(va_list)args

- (BOOL)executeUpdate:(NSString*)sql error:(NSError**)outErr withArgumentsInArray:(NSArray*)arrayArgs orDictionary:(NSDictionary*)dictionaryArgs orVAList:(va_list)args

FMDatabaseQueue

不直接使用FMDatabase對(duì)象,而是使用這個(gè)類,的inDatabase方法來(lái)保證多線程安全。這個(gè)方法里使用的隊(duì)列的dispatch_sync分派方法。就能保證一個(gè)block執(zhí)行完之后,再執(zhí)行下一個(gè)block。

在queue中執(zhí)行的塊時(shí),返回綁定的對(duì)象,如果不是在queue中執(zhí)行的代碼,返回nil

- (void)inDatabase:(void(^)(FMDatabase*db))block {

/* Get the currently executing queue (which should probably be nil, but in theory could be another DB queue

* and then check it against self to make sure we're not about to deadlock. */

FMDatabaseQueue*currentSyncQueue = (__bridgeid)dispatch_get_specific(kDispatchQueueSpecificKey);

assert(currentSyncQueue !=self&&"inDatabase: was called reentrantly on the same queue, which would lead to a deadlock");

FMDBRetain(self);

dispatch_sync(_queue, ^() {

FMDatabase*db = [selfdatabase];

block(db);

if([dbhasOpenResultSets]) {

NSLog(@"Warning: there is at least one open result set around after performing [FMDatabaseQueue inDatabase:]");

#ifdef DEBUG

NSSet*openSetCopy =FMDBReturnAutoreleased([[dbvalueForKey:@"_openResultSets"]copy]);

for(NSValue*rsInWrappedInATastyValueMealinopenSetCopy) {

FMResultSet*rs = (FMResultSet*)[rsInWrappedInATastyValueMealpointerValue];

NSLog(@"query: '%@'", [rsquery]);

}

#endif

}

});

FMDBRelease(self);

}


小知識(shí)點(diǎn)

void?dispatch_queue_set_specific(dispatch_queue_t?queue,?const?void?*key,?void?*context,?dispatch_function_t?destructor);

Description

Sets the key/value data for the specified dispatch queue.

Use this method to associate custom context data with a dispatch queue. Blocks executing on the queue can use thedispatch_get_specificfunction to retrieve this data while they are running.

void * dispatch_get_specific(const void *key);

DescriptionReturns the value for the key associated with the current dispatch queue.

This function is intended to be called from a block executing in a dispatch queue. You use it to obtain context data associated with the queue. Calling this method from code not running in a dispatch queue returnsNULLbecause there is no queue to provide context.

運(yùn)行在隊(duì)列的block,可以通過(guò)dispatch_get_specific方法來(lái)獲取context信息

FMDB的使用

Database Creation (數(shù)據(jù)庫(kù)創(chuàng)建的幾種模式,普通數(shù)據(jù)庫(kù),臨時(shí)數(shù)據(jù)庫(kù)(用完即刪除),內(nèi)存數(shù)據(jù)庫(kù))

AnFMDatabaseis created with a path to a SQLite database file. This path can be one of these three:

A file system path. The file does not have to exist on disk. If it does not exist, it is created for you.

An empty string (@""). An empty database is created at a temporary location. This database is deleted with theFMDatabaseconnection is closed.

NULL. An in-memory database is created. This database will be destroyed with theFMDatabaseconnection is closed.

Multiple Statements and Batch Stuff

You can useFMDatabase's executeStatements:withResultBlock: to do multiple statements in a string:

NSString*sql?=@"create?table?bulktest1?(id?integer?primary?key?autoincrement,?x?text);"

"create?table?bulktest2?(id?integer?primary?key?autoincrement,?y?text);"

"create?table?bulktest3?(id?integer?primary?key?autoincrement,?z?text);"

"insert?into?bulktest1?(x)?values?('XXX');"

"insert?into?bulktest2?(y)?values?('YYY');"

"insert?into?bulktest3?(z)?values?('ZZZ');";

success?=?[dbexecuteStatements:sql];

sql?=@"select?count(*)?as?count?from?bulktest1;"

"select?count(*)?as?count?from?bulktest2;"

"select?count(*)?as?count?from?bulktest3;";

success?=?[self.dbexecuteStatements:sqlwithResultBlock:^int(NSDictionary*dictionary)?{

NSIntegercount?=?[dictionary[@"count"]integerValue];

XCTAssertEqual(count,1,@"expected?one?record?for?dictionary%@",?dictionary);

return0;

}];

Data Sanitization

When providing a SQL statement to FMDB, you should not attempt to "sanitize" any values before insertion. Instead, you should use the standard SQLite binding syntax:

INSERT?INTOmyTableVALUES(?,??,??,??)

Using FMDatabaseQueue and Thread Safety.(多線程安全)

Using a single instance ofFMDatabasefrom multiple threads at once is a bad idea. It has always been OK to make aFMDatabaseobjectper thread. Just don't share a single instance across threads, and definitely not across multiple threads at the same time. Bad things will eventually happen and you'll eventually get something to crash, or maybe get an exception, or maybe meteorites will fall out of the sky and hit your Mac Pro.This would suck.

So don't instantiate a singleFMDatabaseobject and use it across multiple threads.

Instead, useFMDatabaseQueue. Instantiate a singleFMDatabaseQueueand use it across multiple threads. TheFMDatabaseQueueobject will synchronize and coordinate access across the multiple threads. Here's how to use it:

First, make your queue.

FMDatabaseQueue *queue = [FMDatabaseQueuedatabaseQueueWithPath:aPath];

Then use it like so:

[queueinDatabase:^(FMDatabase *db) {? ? [dbexecuteUpdate:@"INSERT INTO myTable VALUES (?)", @1];? ? [dbexecuteUpdate:@"INSERT INTO myTable VALUES (?)", @2];? ? [dbexecuteUpdate:@"INSERT INTO myTable VALUES (?)", @3];? ? FMResultSet *rs = [dbexecuteQuery:@"select * from foo"];while([rsnext]) {? ? ? ? …? ? }}];

An easy way to wrap things up in a transaction can be done like this:

[queueinTransaction:^(FMDatabase?*db,BOOL*rollback)?{

[dbexecuteUpdate:@"INSERT?INTO?myTable?VALUES?(?)",?@1];

[dbexecuteUpdate:@"INSERT?INTO?myTable?VALUES?(?)",?@2];

[dbexecuteUpdate:@"INSERT?INTO?myTable?VALUES?(?)",?@3];

if(whoopsSomethingWrongHappened)?{

*rollback?=YES;

return;

}

//?etc…

[dbexecuteUpdate:@"INSERT?INTO?myTable?VALUES?(?)",?@4];

}];

源碼剖析

對(duì)ARC和非ARC的兼容,OS_OBJECT_USE_OBJC和objc_instancetype的判斷

#if ! __has_feature(objc_arc)

#define FMDBAutorelease(__v) ([__v autorelease]);

#define FMDBReturnAutoreleased FMDBAutorelease

#define FMDBRetain(__v) ([__v retain]);

#define FMDBReturnRetained FMDBRetain

#define FMDBRelease(__v) ([__v release]);

#define FMDBDispatchQueueRelease(__v) (dispatch_release(__v));

#else

// -fobjc-arc

#define FMDBAutorelease(__v)

#define FMDBReturnAutoreleased(__v) (__v)

#define FMDBRetain(__v)

#define FMDBReturnRetained(__v) (__v)

#define FMDBRelease(__v)

// If OS_OBJECT_USE_OBJC=1, then the dispatch objects will be treated like ObjC objects

// and will participate in ARC.

// See the section on "Dispatch Queues and Automatic Reference Counting" in "Grand Central Dispatch (GCD) Reference" for details.

#if OS_OBJECT_USE_OBJC

#define FMDBDispatchQueueRelease(__v)

#else

#define FMDBDispatchQueueRelease(__v) (dispatch_release(__v));

#endif

#endif

#if !__has_feature(objc_instancetype)

#define instancetype id

#endif

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

推薦閱讀更多精彩內(nèi)容