
寫專案的時候要用到資料庫,於是又開始寫那些每次都要重複一遍的 SQL 樣板程式。網路上現成的 SQLite 封裝不少,但多數仍帶著濃厚的「函式呼叫」味道,不夠貼近物件導向的使用習慣。於是花幾天時間做了一個輕量封裝,目標很明確:讓增刪改查回到一行程式碼。
核心只用了兩個技術——Runtime 與 KVC。
先建立一個熟悉的 Person 類,後續都以它為例:
@interface Person : NSObject @property (nonatomic, copy) NSString *name; @property (nonatomic, assign) NSInteger age; @end
這句大家都不陌生:
create table if not exists Person (id integer primary key autoincrement, name text, age integer)
但實際開發中我們是基於模型在寫程式,基本上一個模型對應一張表,而每個模型的屬性都不一樣。要怎麼自動生成對應的建表語句?答案是 Runtime——它能取得一個類的完整屬性列表。
/// 取得當前類的所有屬性
+ (NSArray *)getAttributeListWithClass:(id)className {
unsigned int count;
objc_property_t *properties = class_copyPropertyList([className class], &count);
NSMutableArray *tempArrayM = [NSMutableArray array];
for (int i = 0; i < count; i++) {
objc_property_t property = properties[i];
NSString *name = [NSString stringWithCString:property_getName(property)
encoding:NSUTF8StringEncoding];
// index 是資料庫保留字,會造成語法錯誤
NSAssert(![name isEqualToString:@"index"],
@"禁止在 model 中使用 index 作為屬性");
if ([name isEqualToString:@"hash"]) {
break;
}
[tempArrayM addObject:name];
}
free(properties);
return [tempArrayM copy];
}
這裡有兩個細節。hash 是每個 NSObject 都有的屬性,必須在遍歷時中斷,否則會被誤當成表格欄位;index 則是 SQL 保留關鍵字,用斷言提前攔下來,比等到執行 SQL 才報錯友善得多。
拿到屬性名稱還不夠,還需要把 Objective-C 的型別對應到 SQLite 的型別:
/// OC 型別轉 SQL 型別
+ (NSString *)OCConversionTypeToSQLWithString:(NSString *)string {
if ([string isEqualToString:@"long"] ||
[string isEqualToString:@"int"] ||
[string isEqualToString:@"BOOL"]) {
return @"integer";
}
if ([string isEqualToString:@"NSData"]) {
return @"blob";
}
if ([string isEqualToString:@"double"] ||
[string isEqualToString:@"float"]) {
return @"real";
}
// 自定義標記
if ([string isEqualToString:@"NSArray"] ||
[string isEqualToString:@"NSMutableArray"]) {
return @"customArr";
}
if ([string isEqualToString:@"NSDictionary"] ||
[string isEqualToString:@"NSMutableDictionary"]) {
return @"customDict";
}
return @"text";
}
這裡有兩個自定義型別 customArr 與 customDict,稍後會說明用途。把屬性名與 SQL 型別配對存成字典,結果就像這樣:
@{@"name": @"text", @"age": @"integer"}
有了這些,建表語句就只是字串拼接的事:
// 傳入類別,內部遍歷屬性並組出完整建表語句後執行 - (BOOL)creatTableWithClassName:(id)className;
先看 SQL 語句本體:
insert into Person (name, age) values ('花菜ChrisCai98', 89);
前半段是固定格式,可以靠字串拼接完成;而屬性列表我們已經拿得到。於是只需要一個方法:
/// 傳入模型物件,回傳是否插入成功 - (BOOL)insertDataFromObject:(id)object;
使用方式:
Person *p = [[Person alloc] init]; p.name = @"花菜ChrisCai"; p.age = 18; [[GKDatabaseManager sharedManager] insertDataFromObject:p];
一行完成插入。內部實作如下:
- (BOOL)insertDataFromObject:(id)object {
NSMutableString *sqlString =
[NSMutableString stringWithFormat:@"insert into %@ (",
NSStringFromClass([object class])];
[[GKObjcProperty getUserNeedAttributeListWithClass:[object class]]
enumerateObjectsUsingBlock:^(id _Nonnull obj, NSUInteger idx, BOOL *_Nonnull stop) {
[sqlString appendFormat:@"%@,", obj];
}];
[sqlString deleteCharactersInRange:NSMakeRange(sqlString.length - 1, 1)];
[sqlString appendString:@") values ("];
[[GKObjcProperty getSQLProperties:[object class]]
enumerateKeysAndObjectsUsingBlock:^(id _Nonnull key, id _Nonnull obj, BOOL *_Nonnull stop) {
if ([object valueForKey:key]) {
if ([obj isEqualToString:@"text"]) {
[sqlString appendFormat:@"'%@',", [object valueForKey:key]];
} else if ([obj isEqualToString:@"customArr"] ||
[obj isEqualToString:@"customDict"]) {
NSData *data = [NSJSONSerialization dataWithJSONObject:[object valueForKey:key]
options:0 error:nil];
NSString *jsonString = [[NSString alloc] initWithData:data
encoding:NSUTF8StringEncoding];
[sqlString appendFormat:@"'%@',", jsonString];
} else if ([obj isEqualToString:@"blob"]) {
NSString *jsonString = [[NSString alloc]
initWithData:[object valueForKey:key]
encoding:NSUTF8StringEncoding];
[sqlString appendFormat:@"'%@',", jsonString];
} else {
[sqlString appendFormat:@"%@,", [object valueForKey:key]];
}
} else {
[sqlString appendFormat:@"'%@',", [object valueForKey:key]];
}
}];
[sqlString deleteCharactersInRange:NSMakeRange(sqlString.length - 1, 1)];
[sqlString appendFormat:@");"];
return [self executeSqlString:sqlString];
}
這裡就用上了自定義型別:當型別是 customArr 或 customDict 時,代表要存的是陣列或字典,因此先序列化成 JSON 字串再寫入。
查詢介面提供了六種,涵蓋常見場景:
- (NSArray *)selecteDataWithClass:(id)className; // 查詢整張表
- (NSInteger)getTotalRowsFormClass:(id)className; // 取得總行數
- (id)selecteFormClass:(id)className index:(NSInteger)index; // 指定行
- (NSArray *)selectObject:(Class)className
key:(id)key
operate:(NSString *)operate
value:(id)value; // 條件查詢
- (NSArray *)selecteDataWithSqlString:(NSString *)sqlString
class:(id)className; // 自訂語句
- (NSArray *)selectObject:(Class)className
propertyName:(NSString *)propertyName
type:(GKDatabaseSelectLocation)type
content:(NSString *)content; // 模糊查詢
最簡單的用法:
NSArray *persons = [[GKDatabaseManager sharedManager] selecteDataWithClass:[Person class]];
其餘方法都建立在這個核心方法之上:
- (NSArray *)selecteDataWithSqlString:(NSString *)sqlString class:(id)className {
NSMutableArray *models = nil;
sqlite3_stmt *stmt;
int result = sqlite3_prepare_v2(database, sqlString.UTF8String, -1, &stmt, NULL);
if (SQLITE_OK == result) {
models = [NSMutableArray array];
NSArray *arr = [GKObjcProperty getUserNeedAttributeListWithClass:[className class]];
NSDictionary *dict = [GKObjcProperty getSQLProperties:[className class]];
while (SQLITE_ROW == sqlite3_step(stmt)) {
__block id objc = [[[className class] alloc] init];
for (int i = 0; i < arr.count; i++) {
// 第 0 欄是主鍵,故從第 1 欄開始,以 KVC 賦值
if ([dict[arr[i]] isEqualToString:@"text"]) {
[objc setValue:[NSString stringWithFormat:@"%@",
[self textForColumn:i + 1 stmt:stmt]]
forKey:arr[i]];
} else if ([dict[arr[i]] isEqualToString:@"real"]) {
[objc setValue:[NSString stringWithFormat:@"%f",
[self doubleForColumn:i + 1 stmt:stmt]]
forKey:arr[i]];
} else if ([dict[arr[i]] isEqualToString:@"integer"]) {
[objc setValue:[NSString stringWithFormat:@"%i",
[self intForColumn:i + 1 stmt:stmt]]
forKey:arr[i]];
} else if ([dict[arr[i]] isEqualToString:@"customArr"]) {
NSString *str = [self textForColumn:i + 1 stmt:stmt];
NSData *data = [str dataUsingEncoding:NSUTF8StringEncoding];
[objc setValue:[NSJSONSerialization JSONObjectWithData:data
options:0 error:nil]
forKey:arr[i]];
} else if ([dict[arr[i]] isEqualToString:@"customDict"]) {
NSString *str = [self textForColumn:i + 1 stmt:stmt];
NSData *data = [str dataUsingEncoding:NSUTF8StringEncoding];
[objc setValue:[NSJSONSerialization JSONObjectWithData:data
options:0 error:nil]
forKey:arr[i]];
} else if ([dict[arr[i]] isEqualToString:@"blob"]) {
NSString *str = [self textForColumn:i + 1 stmt:stmt];
[objc setValue:[str dataUsingEncoding:NSUTF8StringEncoding]
forKey:arr[i]];
}
}
[models addObject:objc];
}
}
sqlite3_finalize(stmt);
return [models copy];
}
這裡用 __block 是因為需要在 block 內修改物件的屬性。依 SQL 型別呼叫對應的取值方法,再以 KVC 賦值給模型。遇到自定義型別時,把資料庫中的 JSON 字串反序列化回陣列或字典後再賦值,就完成了型別的往返轉換。
更新、刪除、刪表等方法也都提供了對應介面,註解與 demo 都在原始碼中。
原始碼:https://github.com/ChrisCaixx/GKDatabase
這個設計的優點很明顯:新增一個資料表幾乎不必寫 SQL,模型屬性一改,表格結構自動跟上。但它也有必須留意的取捨:
sqlite3_bind_ 系列做參數綁定。對於資料量不大、結構相對穩定的本機快取場景,這樣的封裝確實能省下大量樣板程式。但若是使用者可輸入大量資料的正式環境,建議改用 Core Data、FMDB 或 GRDB 這類成熟方案,把安全性與遷移處理交給它們。