基於SQLite3輕量級封裝,一行程式碼實現增刪改查
最近寫的專案中有用到資料庫,寫了不少蛋疼的sql語句,每次都是好幾行程式碼,而且每次都是重複的沒有一點技術含量的程式碼,雖然也有不少基於sqlite的封裝,不過用起來還是感覺不夠面向物件!
為了不再寫重複的程式碼,花了幾天時間,基於SQLite3簡單封裝了下,實現了一行程式碼解決增刪改查等常用的功能!並沒有太過高深的知識,主要用了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,通過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 屬性型別
objc_property_t property = properties[i];
// 轉換為Objective C 字串
NSString *name = [NSString stringWithCString:property_getName(property) encoding:NSUTF8StringEncoding];
NSAssert(![name isEqualToString:@"index"], @"禁止在model中使用index作為屬性,否則會引起語法錯誤");
if ([name isEqualToString:@"hash"]) {
break;
}
[tempArrayM addObject:name];
}
free(properties);
return [tempArrayM copy];
}
通過這個方法我們可以獲取一個類的所有屬性列表並將其儲存到陣列中(index是資料庫中保留的關鍵字,所以在這裡用了個斷言),然而僅僅是拿到屬性列表還是不夠的,我們還需要將對應的OC型別轉換為SQL對應的資料型別,相信通過上面獲取屬性名的方法,大家也知道通過runtime能拿到屬性對應的資料型別了,那麼我們可以通過下面方法將其轉換為SQLite需要的型別
/// OC型別轉SQL型別
+ (NSString *)OCConversionTyleToSQLWithString:(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";
}
通過上面方法我們將OC的資料型別轉換為了SQL的資料型別並儲存到了陣列中(上面有兩個自定義的型別,後面使用到的時候再做介紹),通過上面的方法我們成功的拿到了一個模型類的屬性名和對應的SQL資料型別,然後使用鍵值對的形式將其儲存到了一個字典中,比如:
@{@”name” : @”text”,@”age”:”integer”};
獲取到這些之後那麼創表語句就不難了吧,
// 該方法接收一個型別,內部通過遍歷類的屬性,字串拼接獲取完整的創表語句,並在內部執行sql語句,並返回結果
- (BOOL)creatTableWithClassName:(id)className;
介紹完了怎麼創表,那麼我們再來說說怎麼將資料插入到資料庫中:
我們先看一看插入資料的sql語句:insert into Person (name,age) values (‘花菜ChrisCai98’,89);
前面都是固定格式的,同樣我們可以通過字串的拼接獲取完整的創表語句;
在上面我們已經可以拿到Person類的所有屬性列表,那麼我們如何拼接sql語句呢? 在這裡我定義了這麼一個方法
/// 該方法接收一個物件作為引數(模型物件),並返回是否插入成功
- (BOOL)insertDataFromObject:(id)object;
/// 我們可以這樣
Person * p = [[Person alloc]init];
p.name = @"花菜ChrisCai";
p.age = 18;
[[GKDatabaseManager sharedManager] insertDataFromObject:p];
插入資料
通過上面這麼簡單的一句程式碼實現將資料插入到資料庫中,在該方法內部我們通過上面所述的方法獲取Person類的所有屬性列表,那麼我們可以就可以拼接插入語句的前半句了,然後通過KVC的形式完成後半部分賦值的操作;
/// 插入資料
- (BOOL)insertDataFromObject:(id)object {
// 建立可變字串用於拼接sql語句
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)];
// 拼接values
[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"]){ // NSData處理
NSString * jsonString = [[NSString alloc] initWithData:[object valueForKey:key] encoding:(NSUTF8StringEncoding)];
[sqlString appendFormat:@"'%@',",jsonString];
}else {
[sqlString appendFormat:@"%@,",[object valueForKey:key]];
}
}else {// 沒有值就存NULL
[sqlString appendFormat:@"'%@',",[object valueForKey:key]];
}
}];
// 去掉後面的逗號
[sqlString deleteCharactersInRange:NSMakeRange(sqlString.length-1, 1)];
// 新增後面的括號
[sqlString appendFormat:@");"];
// 執行語句
return [self executeSqlString:sqlString];
}
在上面方法中,我們用到了之前提到的自定義的型別,通過該自定的型別我們知道需要儲存的是字典或者陣列,在這裡,我們將陣列和字典轉換為JSON字串的形式存入資料庫中;
到此我們完成了創表和插入向表格中插入資料的操作,下面我們再看看如何從實現一行程式碼從資料庫中將值取出來,在這裡我們提供了6中查詢的介面,
提供的介面如下:
- (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;
// 1.準備查詢
sqlite3_stmt *stmt; // 用於提取資料的變數
int result = sqlite3_prepare_v2(database, sqlString.UTF8String, -1, &stmt, NULL);
// 2.判斷是否準備好
if (SQLITE_OK == result) {
models = [NSMutableArray array];
// 獲取屬性列表名陣列 比如name
NSArray * arr = [GKObjcProperty getUserNeedAttributeListWithClass:[className class]];
// 獲取屬性列表名和sql資料型別 比如 name : text
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個元素為表格主鍵 所以元素從第一個開始
// 使用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];
NSArray * resultArray = [NSJSONSerialization JSONObjectWithData:data options:0 error:nil];
[objc setValue:resultArray forKey:arr[i]];
} else if ([dict[arr[i]] isEqualToString:@"customDict"]) { // 字典處理
NSString * str = [self textForColumn:i + 1 stmt:stmt];
NSData * data = [str dataUsingEncoding:NSUTF8StringEncoding];
NSDictionary * resultDict = [NSJSONSerialization JSONObjectWithData:data options:0 error:nil];
[objc setValue:resultDict forKey:arr[i]];
} else if ([dict[arr[i]] isEqualToString:@"blob"]) { // 二進位制處理
NSString * str = [self textForColumn:i + 1 stmt:stmt];
NSData * data = [str dataUsingEncoding:NSUTF8StringEncoding];
[objc setValue:data forKey:arr[i]];
}
}
[models addObject:objc];
}
}
return [models copy];
}
在該方法內部,我們根據傳遞進來的類建立了一個物件(使用__block是因為在block內部需要修改物件的屬性),通過之前的方法我們拿到了對應的sql型別,和屬性名,這裡就不重複介紹了,通過對應的sql型別執行對應的方法從資料中將資料取出來,並通過KVC的形式給物件賦值,值得一提的是這裡我們通過自定義的欄位(customArr,customDict)可以知道我們取的是陣列或者字典,然後資料庫中的JSON字串轉換為陣列或者字典,然後再利用KVC賦值給物件!