FMDB 使用方法

優(yōu)秀的第三方庫(kù)，README 也是很優(yōu)秀的，理解了 README，會(huì)對(duì)使用帶來(lái)很多便利。

ARC 和 MRC

項(xiàng)目中使用 ARC 還是 MRC，對(duì)使用 FMDB 都沒(méi)有任何影響，F(xiàn)MDB 會(huì)在編譯項(xiàng)目時(shí)自動(dòng)匹配。

使用

在 FMDB 中有三個(gè)重要的類(lèi)：

  1. FMDatabase：是一個(gè)提供 SQLite 數(shù)據(jù)庫(kù)的類(lèi)，用于執(zhí)行 SQL 語(yǔ)句。
  2. FMResultSet：用在 FMDatabase 中執(zhí)行查詢(xún)的結(jié)果的類(lèi)。
  3. FMDatabaseQueue：在多線程下查詢(xún)和更新數(shù)據(jù)庫(kù)用到的類(lèi)。

數(shù)據(jù)庫(kù)創(chuàng)建

FMDatabase 是通過(guò)一個(gè) SQLite 數(shù)據(jù)庫(kù)文件路徑創(chuàng)建的，此路徑可以是以下三者之一：

  1. 一個(gè)文件的系統(tǒng)路徑。磁盤(pán)中可以不存在此文件，因?yàn)槿绻淮嬖跁?huì)自動(dòng)為你創(chuàng)建。
  2. 一個(gè)空的字符串 @""。會(huì)在臨時(shí)位置創(chuàng)建一個(gè)空的數(shù)據(jù)庫(kù)，當(dāng) FMDatabase 連接關(guān)閉時(shí)，該數(shù)據(jù)庫(kù)會(huì)被刪除。
  3. NULL。會(huì)在內(nèi)存中創(chuàng)建一個(gè)數(shù)據(jù)庫(kù)，當(dāng) FMDatabase 連接關(guān)閉時(shí)，該數(shù)據(jù)庫(kù)會(huì)被銷(xiāo)毀。
// 創(chuàng)建數(shù)據(jù)庫(kù)示例
FMDatabase *db = [FMDatabase databaseWithPath:@"/tmp/tmp.db"];

打開(kāi)數(shù)據(jù)庫(kù)

數(shù)據(jù)庫(kù)必須是打開(kāi)狀態(tài)，才能與之交互。如果沒(méi)有足夠的資源和權(quán)限來(lái)打開(kāi)\創(chuàng)建數(shù)據(jù)庫(kù)，數(shù)據(jù)庫(kù)會(huì)打開(kāi)失敗。

數(shù)據(jù)庫(kù)更新

SQL 語(yǔ)句中除過(guò) SELECT 語(yǔ)句都可以稱(chēng)之為更新操作。包括 CREATE，UPDATE，INSERT，ALTER，COMMIT，BEGIN，DETACH，DROP，END，EXPLAIN，VACUUM，REPLACE 等。一般只要不是以 SELECT 開(kāi)頭的 SQL 語(yǔ)句，都是更新語(yǔ)句。

執(zhí)行更新語(yǔ)句后會(huì)返回一個(gè) BOOL 值，返回 YES 表示執(zhí)行更新語(yǔ)句成功，返回 NO 表示出現(xiàn)錯(cuò)誤，可以通過(guò)調(diào)用 -lastErrorMessage 和 -lastErrorCode 方法獲取更多錯(cuò)誤信息。

數(shù)據(jù)庫(kù)查詢(xún)

通過(guò)調(diào)用 -executeQuery... 方法之一執(zhí)行 SELECT 語(yǔ)句進(jìn)行數(shù)據(jù)庫(kù)查詢(xún)操作。

執(zhí)行查詢(xún)操作后，如果成功會(huì)返回一個(gè) FMResultSet 對(duì)象，反之會(huì)返回 nil。通過(guò) -lastErrorMessage 和 -lastErrorCode 方法可以確定為什么會(huì)查詢(xún)失敗。

為了遍歷查詢(xún)結(jié)果，需要 while() 循環(huán)，然后逐條記錄查看。在 FMDB 中，可以通過(guò)下面的簡(jiǎn)單方式實(shí)現(xiàn)：

FMResultSet *s = [db executeQuery:@"SELECT * FROM myTable"];
while ([s next]) {
    // 每條記錄的檢索值
}

即使只需要獲取一個(gè)數(shù)據(jù)，也還是必須在訪問(wèn)查詢(xún)結(jié)果前調(diào)用 -[FMResultSet next]。

// 示例
FMResultSet *s = [db executeQuery:@"SELECT COUNT(*) FROM myTable"];
if ([s next]) {
    int totalCount = [s intForColumnIndex:0];
}

FMResultSet 提供了很多方便的方法來(lái)查詢(xún)數(shù)據(jù)：

  • intForColumn:
  • longForColumn:
  • longLongIntForColumn:
  • boolForColumn:
  • doubleForColumn:
  • stringForColumn:
  • dateForColumn:
  • dataForColumn:
  • dataNoCopyForColumn:
  • UTF8StringForColumn:
  • objectForColumn:

這些方法都有一個(gè) {type}ForColumnIndex: 變體，是基于列的位置來(lái)查詢(xún)數(shù)據(jù)。

通常情況下，一個(gè) FMResultSet 沒(méi)有必要手動(dòng) -close，因?yàn)榻Y(jié)果集合 (result set) 被釋放或者源數(shù)據(jù)庫(kù)關(guān)閉會(huì)自動(dòng)關(guān)閉。

關(guān)閉數(shù)據(jù)庫(kù)

當(dāng)對(duì)數(shù)據(jù)庫(kù)進(jìn)行查詢(xún)和更新操作完成后，需要調(diào)用 -close 關(guān)閉數(shù)據(jù)庫(kù) FMDatabase 的連接。

// 示例
[db close];

事務(wù)

FMDatabase 可以通過(guò)調(diào)用方法來(lái)開(kāi)始和提交事務(wù)，也可以通過(guò)執(zhí)行開(kāi)始\結(jié)束事務(wù) (begin\end transaction) 語(yǔ)句。

多語(yǔ)句和批處理

FMDatabase 可以通過(guò) -executeStatements:withResultBlock: 方法在一個(gè)字符串中執(zhí)行多語(yǔ)句。

// 示例
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 = [db executeStatements:sql];

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

success = [self.db executeStatements:sql withResultBlock:^int(NSDictionary *dictionary) {
    NSInteger count = [dictionary[@"count"] integerValue];
    XCTAssertEqual(count, 1, @"expected one record for dictionary %@", dictionary);
    return 0;
}];

數(shù)據(jù)處理

當(dāng)給 FMDB 提供 SQL 語(yǔ)句時(shí)，在插入前不應(yīng)該處理任何數(shù)據(jù)，而應(yīng)該使用標(biāo)準(zhǔn)的 SQLite 的綁定語(yǔ)法。

// 示例
INSERT INTO myTable VALUES (?, ?, ?)

? 問(wèn)號(hào)在 SQLite 中意為即將插入的值的占位符，F(xiàn)MDB 執(zhí)行語(yǔ)句的方法都接受多個(gè)參數(shù) (或者參數(shù)集合，比如 NSArray，NSDictionary，va_list)，它們都會(huì)正確轉(zhuǎn)義。

也可以使用命名參數(shù)語(yǔ)法：

// 示例
INSERT INTO myTable VALUES (:id, :name, :value)

這些參數(shù)必須以冒號(hào)開(kāi)頭，SQLite 自身支持其他字符，但是命名時(shí)字典的鍵內(nèi)部以冒號(hào)開(kāi)頭，就不能在你的字典的鍵中包含冒號(hào)。

// 示例
NSDictionary *argsDict = [NSDictionary dictionaryWithObjectsAndKeys:@"My Name", @"name", nil];
[db executeUpdate:@"INSERT INTO myTable (name) VALUES (:name)" withParameterDictionary:argsDict];

因此，不應(yīng)該寫(xiě)類(lèi)似下面這行一樣的錯(cuò)誤代碼：

// 錯(cuò)誤示例
[db executeUpdate:[NSString stringWithFormat:@"INSERT INTO myTable VALUES (%@)", @"this has \" lots of ' bizarre \" quotes '"]];

而應(yīng)該這樣寫(xiě)：

// 正確示例
[db executeUpdate:@"INSERT INTO myTable VALUES (?)", @"this has \" lots of ' bizarre \" quotes '"];

所有傳遞給 -executeUpdate: 方法的參數(shù)都必須是對(duì)象。下面寫(xiě)法執(zhí)行不會(huì)起作用而且會(huì)引發(fā)崩潰：

// 錯(cuò)誤示例
[db executeUpdate:@"INSERT INTO myTable VALUES (?)", 42];

插入一個(gè)數(shù)的正確方法是把這個(gè)數(shù)字包裝成 NSNumber 對(duì)象：

// 正確示例
[db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:42]];

也可以使用 -execute*WithFormat: 這個(gè)方法將數(shù)字轉(zhuǎn)換成字符串：

// 轉(zhuǎn)換成字符串示例
[db executeUpdateWithFormat:@"INSERT INTO myTable VALUES (@d)", 42];

-execute*WithFormat: 這些方法后面都可以接格式字符串參數(shù)，以下 % 百分號(hào)格式符都是可以識(shí)別的：%@, %c, %s, %d, %D, %i, %u, %U, %hi, %hu, %qi, %qu, %f, %g, %ld, %lu, %lld, %llu。使用其他格式符可能會(huì)出現(xiàn)不可預(yù)知的問(wèn)題。出于某種原因，可能需要在你的 SQL 語(yǔ)句中使用 % 字符，應(yīng)該使用百分號(hào)轉(zhuǎn)義一下 %%。

FMDatabaseQueue 隊(duì)列和線程安全

在多線程中同時(shí)使用 FMDatabase 單例是極其錯(cuò)誤的想法，會(huì)導(dǎo)致每個(gè)線程創(chuàng)建一個(gè) FMDatabase 對(duì)象。不要跨線程使用單例，也不要同時(shí)跨多線程，不然會(huì)奔潰或者異常。
FMDatabase 這個(gè)類(lèi)是線程不安全的，在多線程中使用 FMDatabase 單例是極其錯(cuò)誤的想法。不能在多線程的環(huán)境中對(duì)數(shù)據(jù)庫(kù) FMDatabase 進(jìn)行讀寫(xiě)，會(huì)出現(xiàn)奔潰或者異常，因?yàn)槟悴荒鼙ＷC你讀數(shù)據(jù)的同時(shí)另外一條線程不在寫(xiě)數(shù)據(jù)。

因此不要實(shí)例化一個(gè) FMDatabase 單例來(lái)跨線程使用。

相反，使用 FMDatabaseQueue，F(xiàn)MDatabaseQueue 跨線程使用是同步的，下面是它的使用方法：

第一，創(chuàng)建隊(duì)列。

// 創(chuàng)建 FMdatabaseQueue 示例
FMDatabaseQueue *queue = [FMDatabaseQueue databaseQueueWithPath:aPath];

然后這樣使用：

// 示例
[queue inDatabase:^(FMDatabase *db) {
    [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:1]];
    [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:2]];
    [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:3]];
    
    FMResultSet *rs = [db executeQuery:@"select * from foo"];
    while ([rs next]) {
        ...
    }
}];

把操作放在事務(wù)中也很簡(jiǎn)單，比如：

// 示例
[queue inTransaction:^(FMDatabase *db, BOOL *rollback) {
    [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:1]];
    [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:2]];
    [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:3]];
    
    if (whoopsSomethingWrongHappened) {
        *rollback = YES;
        return;
    }
    // ...
    [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:4]];
}];

FMDatabase 將塊代碼 block 運(yùn)行在一個(gè)串行隊(duì)列上，即使在多線程同時(shí)調(diào)用 FMDatabaseQueue 的方法，它們?nèi)匀贿€是順序執(zhí)行。這種查詢(xún)和更新方式不會(huì)影響其它，是線程安全的。

基于 block 自定義 SQLite 函數(shù)

這是可以的，例子可以在 main.m 中的 makeFunctionNamed: 方法查看。

Swift

在 Swift 項(xiàng)目中也可以使用 FMDB，需要做以下步驟：

  1. 將 FMDB 的 .m 和 .h 全部文件拖進(jìn)你的項(xiàng)目。
  2. 如果 Xcode 提示創(chuàng)建橋接文件，需要點(diǎn)擊創(chuàng)建。如果沒(méi)有提示，且項(xiàng)目中也沒(méi)有橋接文件，需要手動(dòng)添加。點(diǎn)此查看橋接文件更多信息
  3. 在橋接文件中，添加這行代碼：#import "FMDB.h"
  4. 可以從 "src/extra/Swift Extension" 文件夾中拷貝 FMDatabaseVariadic.swift 文件到項(xiàng)目中，就可以使用 executeUpdate 和 executeQuery 多參數(shù)了。

做完上述幾步，就可以使用 FMDatabase 寫(xiě) Swift 代碼了。

// 示例
let documentsFolder = NSSearchPathForDirectoriesInDomains(.DocumentDirectory, .UserDomainMask, true)[0] as String
let path = documentsFolder.stringByAppendingPathComponent("test.sqlite")

let database = FMDatabase(path: path)

if !database.open() {
    println("Unable to open database")
    return
}

if !database.executeUpdate("create table test(x text, y text, z text)", withArgumentsInArray: nil) {
    println("create table failed: \(database.lastErrorMessage())")
}

if !database.executeUpdate("insert into test (x, y, z) values (?, ?, ?)", withArgumentsInArray: ["a", "b", "c"]) {
    println("insert 1 table failed: \(database.lastErrorMessage())")
}

if !database.executeUpdate("insert into test (x, y, z) values (?, ?, ?)", withArgumentsInArray: ["e", "f", "g"]) {
    println("insert 2 table failed: \(database.lastErrorMessage())")
}

if let rs = database.executeQuery("select x, y, z from test", withArgumentsInArray: nil) {
    while rs.next() {
        let x = rs.stringForColumn("x")
        let y = rs.stringForColumn("y")
        let z = rs.stringForColumn("z")
        println("x = \(x); y = \(y); z = \(z)")
    }
} else {
    println("select failed: \(database.lastErrorMessage())")
}

database.close()

本文實(shí)際是對(duì) FMDB 的 README 簡(jiǎn)單翻譯，以方便使用 FMDB。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書(shū)系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容