最近寫(xiě)的項(xiàng)目中有用到數(shù)據(jù)庫(kù),寫(xiě)了不少蛋疼的sql語(yǔ)句,每次都是好幾行代碼,而且每次都是重復(fù)的沒(méi)有一點(diǎn)技術(shù)含量的代碼,雖然也有不少基于sqlite的封裝,不過(guò)用起來(lái)還是感覺(jué)不夠面向?qū)ο?
為了不再寫(xiě)重復(fù)的代碼,花了幾天時(shí)間,基于SQLite3簡(jiǎn)單封裝了下,實(shí)現(xiàn)了一行代碼解決增刪改查等常用的功能!并沒(méi)有太過(guò)高深的知識(shí),主要用了runtime和KVC:
首先我們創(chuàng)建個(gè)大家都熟悉的Person類(lèi),并聲明兩個(gè)屬性,下面將以類(lèi)此展開(kāi)分析
@interface Person : NSObject
@property(nonatomic, copy) NSString *name;
@property(nonatomic, assign) NSInteger age;
@end
創(chuàng)建表格
相信下面這句創(chuàng)表語(yǔ)句大家都熟悉吧,就不做介紹了
create table if not exists Person (id integer primary key autoincrement,name text,age integer)
然而開(kāi)發(fā)中我們都是基于模型開(kāi)發(fā)的,基本上都是一個(gè)模型對(duì)應(yīng)數(shù)據(jù)庫(kù)的一張表,那么每個(gè)模型的屬性都不一樣,那么我們又該如何生成類(lèi)似上面的語(yǔ)句呢? 我想到了runtime,通過(guò)runtime獲取一個(gè)類(lèi)的屬性列表,所以有了下面這個(gè)方法:
/// 獲取當(dāng)前類(lèi)的所有屬性
+ (NSArray *)getAttributeListWithClass:(id)className {
// 記錄屬性個(gè)數(shù)
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 屬性類(lèi)型
objc_property_t property = properties[i];
// 轉(zhuǎn)換為Objective C 字符串
NSString *name = [NSString stringWithCString:property_getName(property) encoding:NSUTF8StringEncoding];
NSAssert(![name isEqualToString:@"index"], @"禁止在model中使用index作為屬性,否則會(huì)引起語(yǔ)法錯(cuò)誤");
if ([name isEqualToString:@"hash"]) {
break;
}
[tempArrayM addObject:name];
}
free(properties);
return [tempArrayM copy];
}
通過(guò)這個(gè)方法我們可以獲取一個(gè)類(lèi)的所有屬性列表并將其保存到數(shù)組中(index是數(shù)據(jù)庫(kù)中保留的關(guān)鍵字,所以在這里用了個(gè)斷言),然而僅僅是拿到屬性列表還是不夠的,我們還需要將對(duì)應(yīng)的OC類(lèi)型轉(zhuǎn)換為SQL對(duì)應(yīng)的數(shù)據(jù)類(lèi)型,相信通過(guò)上面獲取屬性名的方法,大家也知道通過(guò)runtime能拿到屬性對(duì)應(yīng)的數(shù)據(jù)類(lèi)型了,那么我們可以通過(guò)下面方法將其轉(zhuǎn)換為SQLite需要的類(lèi)型
/// OC類(lèi)型轉(zhuǎn)SQL類(lèi)型
+ (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";
}
// 自定義數(shù)組標(biāo)記
if ([String isEqualToString:@"NSArray"] || [String isEqualToString:@"NSMutableArray"]) {
return @"customArr";
}
// 自定義字典標(biāo)記
if ([String isEqualToString:@"NSDictionary"] || [String isEqualToString:@"NSMutableDictionary"]) {
return @"customDict";
}
return @"text";
}
通過(guò)上面方法我們將OC的數(shù)據(jù)類(lèi)型轉(zhuǎn)換為了SQL的數(shù)據(jù)類(lèi)型并保存到了數(shù)組中(上面有兩個(gè)自定義的類(lèi)型,后面使用到的時(shí)候再做介紹),通過(guò)上面的方法我們成功的拿到了一個(gè)模型類(lèi)的屬性名和對(duì)應(yīng)的SQL數(shù)據(jù)類(lèi)型,然后使用鍵值對(duì)的形式將其保存到了一個(gè)字典中,比如:
@{@"name" : @"text",@"age":"integer"};
獲取到這些之后那么創(chuàng)表語(yǔ)句就不難了吧,
// 該方法接收一個(gè)類(lèi)型,內(nèi)部通過(guò)遍歷類(lèi)的屬性,字符串拼接獲取完整的創(chuàng)表語(yǔ)句,并在內(nèi)部執(zhí)行sql語(yǔ)句,并返回結(jié)果
- (BOOL)creatTableWithClassName:(id)className;
介紹完了怎么創(chuàng)表,那么我們?cè)賮?lái)說(shuō)說(shuō)怎么將數(shù)據(jù)插入到數(shù)據(jù)庫(kù)中:
我們先看一看插入數(shù)據(jù)的sql語(yǔ)句:insert into Person (name,age) values ('花菜ChrisCai98',89);
前面都是固定格式的,同樣我們可以通過(guò)字符串的拼接獲取完整的創(chuàng)表語(yǔ)句;
在上面我們已經(jīng)可以拿到Person類(lèi)的所有屬性列表,那么我們?nèi)绾纹唇觭ql語(yǔ)句呢? 在這里我定義了這么一個(gè)方法
/// 該方法接收一個(gè)對(duì)象作為參數(shù)(模型對(duì)象),并返回是否插入成功
- (BOOL)insertDataFromObject:(id)object;
/// 我們可以這樣
Person * p = [[Person alloc]init];
p.name = @"花菜ChrisCai";
p.age = 18;
[[GKDatabaseManager sharedManager] insertDataFromObject:p];
插入數(shù)據(jù)
通過(guò)上面這么簡(jiǎn)單的一句代碼實(shí)現(xiàn)將數(shù)據(jù)插入到數(shù)據(jù)庫(kù)中,在該方法內(nèi)部我們通過(guò)上面所述的方法獲取Person類(lèi)的所有屬性列表,那么我們可以就可以拼接插入語(yǔ)句的前半句了,然后通過(guò)KVC的形式完成后半部分賦值的操作;
/// 插入數(shù)據(jù)
- (BOOL)insertDataFromObject:(id)object {
// 創(chuàng)建可變字符串用于拼接sql語(yǔ)句
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];
}];
// 去掉后面的逗號(hào)
[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"]) { // 數(shù)組字典轉(zhuǎn)處理
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 {// 沒(méi)有值就存NULL
[sqlString appendFormat:@"'%@',",[object valueForKey:key]];
}
}];
// 去掉后面的逗號(hào)
[sqlString deleteCharactersInRange:NSMakeRange(sqlString.length-1, 1)];
// 添加后面的括號(hào)
[sqlString appendFormat:@");"];
// 執(zhí)行語(yǔ)句
return [self executeSqlString:sqlString];
}
在上面方法中,我們用到了之前提到的自定義的類(lèi)型,通過(guò)該自定的類(lèi)型我們知道需要存儲(chǔ)的是字典或者數(shù)組,在這里,我們將數(shù)組和字典轉(zhuǎn)換為JSON字符串的形式存入數(shù)據(jù)庫(kù)中;
到此我們完成了創(chuàng)表和插入向表格中插入數(shù)據(jù)的操作,下面我們?cè)倏纯慈绾螐膶?shí)現(xiàn)一行代碼從數(shù)據(jù)庫(kù)中將值取出來(lái),在這里我們提供了6中查詢(xún)的接口,
- 提供的接口如下:
- (NSArray *)selecteDataWithClass:(id)className;// 根據(jù)類(lèi)名查詢(xún)對(duì)應(yīng)表格內(nèi)所有數(shù)據(jù)
- (NSInteger)getTotalRowsFormClass:(id)className; // 獲取表的總行數(shù)
- (id)selecteFormClass:(id)className index:(NSInteger)index;// 獲取指定行數(shù)據(jù)
- (NSArray *)selectObject:(Class)className key:(id)key operate:(NSString *)operate value:(id)value;// 指定條件查詢(xún)
- (NSArray *)selecteDataWithSqlString:(NSString *)sqlString class:(id)className;// 自定義語(yǔ)句查詢(xún)
- (NSArray *)selectObject:(Class)className propertyName:(NSString *)propertyName type:(GKDatabaseSelectLocation)type content:(NSString *)content;// 模糊查詢(xún)
通過(guò)第一個(gè)方法(該方法接收一個(gè)類(lèi)名作為參數(shù))就能簡(jiǎn)單的實(shí)現(xiàn)一行代碼查詢(xún)表格中的數(shù)據(jù)了
NSArray * persons = [[GKDatabaseManager sharedManager] selecteDataWithClass:[Person class]];
下面我們著重介紹下核心方法,其他所有方法都是基于該方法實(shí)現(xiàn)的
/// 自定義語(yǔ)句查詢(xún)
- (NSArray *)selecteDataWithSqlString:(NSString *)sqlString class:(id)className {
// 創(chuàng)建模型數(shù)組
NSMutableArray *models = nil;
// 1.準(zhǔn)備查詢(xún)
sqlite3_stmt *stmt; // 用于提取數(shù)據(jù)的變量
int result = sqlite3_prepare_v2(database, sqlString.UTF8String, -1, &stmt, NULL);
// 2.判斷是否準(zhǔn)備好
if (SQLITE_OK == result) {
models = [NSMutableArray array];
// 獲取屬性列表名數(shù)組 比如name
NSArray * arr = [GKObjcProperty getUserNeedAttributeListWithClass:[className class]];
// 獲取屬性列表名和sql數(shù)據(jù)類(lèi)型 比如 name : text
NSDictionary * dict = [GKObjcProperty getSQLProperties:[className class]];
// 準(zhǔn)備好了
while (SQLITE_ROW == sqlite3_step(stmt)) { // 提取到一條數(shù)據(jù)
__block id objc = [[[className class] alloc]init];
for ( int i = 0; i < arr.count; i++) {
// 默認(rèn)第0個(gè)元素為表格主鍵 所以元素從第一個(gè)開(kāi)始
// 使用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"]) { // 數(shù)組處理
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"]) { // 二進(jìn)制處理
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];
}
在該方法內(nèi)部,我們根據(jù)傳遞進(jìn)來(lái)的類(lèi)創(chuàng)建了一個(gè)對(duì)象(使用__block是因?yàn)樵赽lock內(nèi)部需要修改對(duì)象的屬性),通過(guò)之前的方法我們拿到了對(duì)應(yīng)的sql類(lèi)型,和屬性名,這里就不重復(fù)介紹了,通過(guò)對(duì)應(yīng)的sql類(lèi)型執(zhí)行對(duì)應(yīng)的方法從數(shù)據(jù)中將數(shù)據(jù)取出來(lái),并通過(guò)KVC的形式給對(duì)象賦值,值得一提的是這里我們通過(guò)自定義的字段(customArr,customDict)可以知道我們?nèi)〉氖菙?shù)組或者字典,然后數(shù)據(jù)庫(kù)中的JSON字符串轉(zhuǎn)換為數(shù)組或者字典,然后再利用KVC賦值給對(duì)象!
到此基本上所有的功能就都實(shí)現(xiàn)了,其他的諸如更新數(shù)據(jù),刪除數(shù)據(jù),刪除表格等有提供具體的接口,這里就不一一介紹了,源碼中有詳細(xì)的注釋,同時(shí)也有DEMO,有需要的可以自行下載,
以上均為個(gè)人這段時(shí)間的總結(jié),如有不對(duì)的地方,可以在下面評(píng)論
也可以通過(guò)QQ:4593679聯(lián)系我,如覺(jué)得好用記得star一下哦~,謝謝!!!
源碼地址:https://github.com/ChrisCaixx/GKDatabase
