專案裡原本大量使用原生 sqlite3 API,用起來實在稱不上愉快——要自己管理 statement 的生命週期、手動 bind 參數、逐欄取值,API 設計很不友善。後來看到有人推薦 FMDB,試用之後果然順手很多,記錄一下。
FMDB 是 wraps SQLite 的 Objective-C 封裝,把 SQL 操作分成 update 與 query 兩大類,所以 API 名字不是 executeUpdate: 就是 executeQuery:。安裝最方便的方式是用 CocoaPods。
-(void)clearDeleteRecordForTable:(NSString *)tableName withRecords:(NSMutableArray *)deleteIds {
NSString *dbFilePath = [YLSGlobalUtils getDatabaseFilePath];
FMDatabase *db = [FMDatabase databaseWithPath:dbFilePath];
NSString *sql = @"delete from tb_deleteRecord where table_name = ? and id = ?";
[db open];
for (NSString *deleteId in deleteIds) {
[db executeUpdate:sql, tableName, deleteId];
}
[db close];
}
-(NSMutableArray *)queryDeleteData:(NSString *)tableName {
NSMutableArray *result = [NSMutableArray new];
NSString *dbFilePath = [YLSGlobalUtils getDatabaseFilePath];
FMDatabase *db = [FMDatabase databaseWithPath:dbFilePath];
[db open];
FMResultSet *rs = [db executeQuery:@"select id from tb_deleteRecord where upper(table_name) = upper(?)",
tableName];
while ([rs next]) {
[result addObject:[rs objectForColumnName:@"id"]];
}
[db close];
return result;
}
過去寫原生 sqlite3 時,習慣用 %@ 搭配 stringWithFormat: 拼字串,而 FMDB 明確反對這種做法:
// 不要這樣寫
[db executeUpdate:[NSString stringWithFormat:@"INSERT INTO myTable VALUES (%@)",
@"this has \" lots of ' bizarre \" quotes '"]];
// 應該這樣寫
[db executeUpdate:@"INSERT INTO myTable VALUES (?)",
@"this has \" lots of ' bizarre \" quotes '"];
占位符請用 ? 或 :name。這一點我很喜歡,因為以前寫過的無數 bug 都是忘記在 SQL 裡補引號造成的:
@"select * from table where name = %@" // 錯,執行時會報錯 @"select * from table where name = '%@'" // 對,但很容易漏寫
改用 ? 之後,引號由框架處理,這類低級錯誤大幅減少;而且參數值自動被當成值而非 SQL 片段,也能避免拼接字串帶來的注入風險。
objectForColumnName: 這類方法已經比原生 API 好用,而更方便的是 resultDictionary——直接把一整列轉成 NSDictionary:
-(NSMutableArray *)queryUpdateData:(NSString *)tableName {
NSMutableArray *result = [NSMutableArray new];
NSString *dbFilePath = [YLSGlobalUtils getDatabaseFilePath];
FMDatabase *db = [FMDatabase databaseWithPath:dbFilePath];
[db open];
long now = [[NSDate date] timeIntervalSince1970];
FMResultSet *rs = [db executeQuery:@"select * from %@ where modify_date between ? and ? "
"and (create_date not between ? and ?)",
tableName, latestBackupTime, now, latestBackupTime, now];
while ([rs next]) {
[result addObject:[rs resultDictionary]];
}
[db close];
return result;
}
整體來說 FMDB 的 API 直觀、遷移成本低,把原本散落的 sqlite3 呼叫換成 FMDatabase/FMResultSet 就能收工。唯一要注意的是上面提到的占位符習慣必須一起改掉,否則會拿到一堆 runtime 錯誤。強烈推薦試一下。