從0開始弄一個面向OC資料庫(二)--插入、更新、查詢資料

___發表於2017-12-14

前言

首先,在上一篇文章從0開始弄一個面向OC資料庫(一),我們實現了資料庫的建立、開啟、關閉、通過runtime獲取模型所有成員變數建表功能。本次程式碼解決了一個上個版本程式碼存在的bug,當傳targetId為nil的時候,資料庫語句執行失敗的問題, 其次,本篇文章要實現的功能有:

  • 傳入模型,實現資料庫的插入資料操作
  • 使用sql的API實現查詢,在外層封裝一個方法,傳入模型型別即可查詢資料庫內該表下所有的資料,並封裝成陣列(NSArray <Model * > *)返回。
  • 修改資料庫表內已存在的資料,在實現這個方法時,我們將建立並開啟資料庫、建立表格,插入資料、更新資料封裝成一個方法,我們最終將這個方法整合的邏輯為:
  • 1、判斷資料庫內是否存在對應的表,沒有則建立
  • 2、建立表時會執行開啟資料庫,如果沒有資料庫則建立再開啟
  • 3、判斷對應的表內是否存在主鍵相同的記錄,存在則對該記錄進行更新,不存在則進行插入操作

這個方法的最終形態:如果是一個從零開始的狀態,沒有任何資料庫,這個方法會替我們 建立對應的資料庫,建立對應的表格,插入對應的資料,如果存在對應的資料庫、表、資料,則進行更新

隔斷.jpg

功能實現

1、插入資料操作

插入資料的sql語句可以分析為: insert into 表名(欄位1名稱,欄位2名稱,欄位3名稱) values ('值1','值2','值3') 思路: 1.判斷資料庫內是否有對應表格,沒有則建立(這一步先不做,因為我們目前還沒有實現查詢語句暫時無法判斷,我們先在外面建立一個對應的表格,再執行插入操作) 2.獲取模型的所有成員變數名稱,通過KVC獲取成員變數對應的值。 3.拼接sql插入語句並執行語句 貼上我們的程式碼:

#pragma mark 插入資料
+ (BOOL)insertModel:(id)model uid:(NSString *)uid targetId:(NSString *)targetId {
    // 獲取表名
    Class cls = [model class];
    NSString *tableName = [CWModelTool tableName:cls targetId:targetId];
    // 1.判斷資料庫內是否有對應表格,沒有則建立(這一步先不做,因為我們目前還沒有實現查詢語句,我們先在外面建立一個表格,再執行插入操作)
    // 2.插入資料
    // 獲取類的所有成員變數的名稱與型別
    NSDictionary *nameTypeDict = [CWModelTool classIvarNameAndTypeDic:cls];
    // 獲取所有成員變數的名稱,也就是sql語句欄位名稱
    NSArray *allIvarNames = nameTypeDict.allKeys;
    // 獲取所有成員變數對應的值
    NSMutableArray *allIvarValues = [NSMutableArray array];
    for (NSString *ivarName in allIvarNames) {
        // 獲取對應的值,暫時不考慮自定義模型和oc模型的情況
        id value = [model valueForKeyPath:ivarName];
        [allIvarValues addObject:value];
    }
    // insert into 表名(欄位1,欄位2,欄位3) values ('值1''值2''值3')
    NSString *sql = [NSString stringWithFormat:@"insert into %@(%@) values('%@')",tableName,[allIvarNames componentsJoinedByString:@","],[allIvarValues componentsJoinedByString:@"','"]];
    
    return [CWDatabase execSQL:sql uid:uid];
}
複製程式碼

對這個方法進行單元測試:

- (void)testInsertModel {
    // 建立表格
    BOOL result = [CWSqliteModelTool createSQLTable:[Student class] uid:@"Chavez" targetId:nil];
    XCTAssertTrue(result);
    
    Student *stu = [[Student alloc] init];
    stu.stuId = 10086;
    stu.name = @"Alibaba";
    stu.age = 16;
    stu.height = 165;
    // 插入資料
    BOOL result1 = [CWSqliteModelTool insertModel:stu uid:@"Chavez" targetId:nil];
    XCTAssertTrue(result1);
    
    Student *stu1 = [[Student alloc] init];
    stu1.stuId = 10010;
    stu1.name = @"Tencent";
    stu1.age = 17;
    stu1.height = 182;
    // 插入資料
    BOOL result2 = [CWSqliteModelTool insertModel:stu1 uid:@"Chavez" targetId:nil];
    XCTAssertTrue(result2);
    
    Student *stu2 = [[Student alloc] init];
    stu2.stuId = 10000;
    stu2.name = @"Baidu";
    stu2.age = 18;
    stu2.height = 180;
    // 插入資料
    BOOL result3 = [CWSqliteModelTool insertModel:stu2 uid:@"Chavez" targetId:nil];
    XCTAssertTrue(result3);
}
複製程式碼

建立對應的資料庫以及表格,向資料庫插入3條資料,最終我們看到測試成功,並開啟對應的資料庫表格進行驗證得到下圖,成功!

插入資料成功.png

2、資料庫查詢

面向sql的API我們可以分為兩類,一類為查詢操作,一類為非查詢操作,也就是執行語句,執行語句在之前已經實現了,現在我們來實現查詢操作,首先提供思路:

  • 1.開啟資料庫
  • 2.預執行sql語句
  • 3.繫結資料
  • 4.執行遍歷查詢(在這裡我們會將每一條資料封裝成字典{欄位型別key : 欄位值value ...},然後加入陣列中儲存返回)
  • 5.重置
  • 6.釋放資源,關閉資料庫

sql3為查詢提供了以下兩個方法

// 預執行sql語句、準備語句
SQLITE_API int sqlite3_prepare_v2(
  sqlite3 *db,            /* 資料庫的操作控制程式碼 */
  const char *zSql,       /* sql語句 */
  int nByte,              /* 引數2sql語句取出多少位元組的長度。-1為自動計算 找到\0結束符*/
  sqlite3_stmt **ppStmt,  /* 伴隨指標的地址 */
  const char **pzTail     /* 引數2減去引數3剩餘的sql語句*/
);

// 執行伴隨指標,如果結果為SQLITE_ROW,表示還有下一條資料,伴隨指標指向下一條資料,否則結束迴圈
SQLITE_API int sqlite3_step(sqlite3_stmt*);
複製程式碼

在CWDatabase封裝一個方法,執行查詢操作

+ (NSMutableArray <NSMutableDictionary *>*)querySql:(NSString *)sql uid:(NSString *)uid {
    // 1、開啟資料庫
    if (![self openDB:uid]) {
        return nil;
    }
    // 2、預執行語句
    sqlite3_stmt *ppStmt     = 0x00; //伴隨指標
    if (sqlite3_prepare_v2(cw_database, sql.UTF8String, -1, &ppStmt, nil) != SQLITE_OK) {
        NSLog(@"查詢準備語句編譯失敗");
        return nil;
    }
    // 3、繫結資料,因為我們的sql語句中不帶有?用來賦值,所以不需要進行繫結
    // 4、執行遍歷查詢
    NSMutableArray *rowDicArray = [NSMutableArray array];
    while (sqlite3_step(ppStmt) == SQLITE_ROW) { // SQLITE_ROW表示還有下一條資料
        // 獲取有多少列(也就是一條資料有多少個欄位)
        int columnCount = sqlite3_column_count(ppStmt);
        // 儲存一條資料的所有欄位名與值 的字典
        NSMutableDictionary *rowDict = [NSMutableDictionary dictionary];
        // 遍歷資料庫一條資料所有欄位
        for (int i = 0; i < columnCount; i++) {
            // 獲取欄位名
            NSString *columnName = [NSString stringWithUTF8String:sqlite3_column_name(ppStmt, i)];
            // 獲取欄位名對應的型別
            int type = sqlite3_column_type(ppStmt, i);
            // 獲取對應的值
            id value = nil;
            switch (type) {
                case SQLITE_INTEGER:
                    value = @(sqlite3_column_int(ppStmt, i));
                    break;
                case SQLITE_FLOAT:
                    value = @(sqlite3_column_double(ppStmt, i));
                    
                    break;
                case SQLITE_BLOB: // 二進位制
                    value = CFBridgingRelease(sqlite3_column_blob(ppStmt, i));
                    break;
                case SQLITE_NULL:
                    value = @"";
                    break;
                case SQLITE3_TEXT:
                    value = [NSString stringWithUTF8String:(const char *)sqlite3_column_text(ppStmt, i)];
                    break;
                    
                default:
                    break;
            }
            [rowDict setValue:value forKey:columnName];
        }
        [rowDicArray addObject:rowDict];
    }
    // 5、重製(省略)
    // 6、釋放資源,關閉資料庫
    sqlite3_finalize(ppStmt);
    [self closeDB];
    
    return rowDicArray;
}
複製程式碼

做完了面向sql的查詢之後,我們要將這個方法封裝一下,面向模型。我們在CWSqliteModelTool封裝一個方法

#pragma mark 查詢資料
// 查詢表內所有資料
+ (NSArray *)queryAllModels:(Class)cls uid:(NSString *)uid targetId:(NSString *)targetId {
    
    NSString *tableName = [CWModelTool tableName:cls targetId:targetId];
    
    NSString *sql = [NSString stringWithFormat:@"select * from %@", tableName];
    
    NSArray <NSDictionary *>*results = [CWDatabase querySql:sql uid:uid];
    return [self parseResults:results withClass:cls];
}

// 解析資料
+ (NSArray *)parseResults:(NSArray <NSDictionary *>*)results withClass:(Class)cls  {
    
    NSMutableArray *models = [NSMutableArray array];
    for (NSDictionary *dict in results) {
        id model = [[cls alloc] init];
        // dict型別為{欄位型別 : 欄位值} 遍歷為模型賦值
        [dict enumerateKeysAndObjectsUsingBlock:^(id  _Nonnull key, id  _Nonnull obj, BOOL * _Nonnull stop) {
            id value = obj;
            [model setValue:value forKeyPath:key];
        }];
        
        [models addObject:model];
    }
    return models;
}
複製程式碼

然後我們測試查詢函式

- (void)testQueryModels {
    NSArray *models = [CWSqliteModelTool queryAllModels:[Student class] uid:@"Chavez" targetId:nil];
    NSLog(@"query models : %@",models);
    XCTAssertNotNil(models);
}
複製程式碼

目前Chavez資料庫的Student表一共存在3條我們剛剛插入進去的資料,執行查詢的結果如果與資料庫內的資料對應,則代表成功,最終我們得到如下列印:

// 資料裡有3個模型,每個模型對應的成員變數以及值都對應上了,列印出來的不是Student模型的地址是因為我們重寫了Student模型的description函式
2017-12-10 09:37:22.016582+0800 CWDB[2638:355147] query models : (
    " stuId = 10000 , name = Baidu , age = 18 , height = 180 ,score = 0.000000",
    " stuId = 10010 , name = Tencent , age = 17 , height = 182 ,score = 0.000000",
    " stuId = 10086 , name = Alibaba , age = 16 , height = 165 ,score = 0.000000"
)
複製程式碼

測試結果表示我們的方法完全OK!

3、更新資料

在文章的開頭,我們已經為這個方法做了很多的介紹了,我們要把建立資料庫、建立表格、插入資料、更新資料都整合在這個方法內,先說一下實現的步驟:

  • 1.獲取表名,判斷資料庫是否存在對應的表,不存在則建立
  • 2.根據主鍵,判斷資料庫內是否存在記錄
  • 3.如果資料庫內不存在記錄,進行資料插入操作
  • 4.如果資料庫記憶體在記錄,進行資料更新操作 首先我們來解決步驟1的問題,如何判斷資料庫內是否存在對應的表:我們要引入一個概念**sqlite的系統表sqlite_master,**每一個 SQLite 資料庫都有一個叫 sqlite_master 的表, 它定義資料庫的模式。這個表裡面儲存著當前資料庫中所有表的相關資訊,比如表的名稱、用於建立此表的sql語句、索引、索引所屬的表、建立索引的sql語句等,所以我們只要對sqlite_master執行查詢操作即可,在CWSqliteTableTool內封裝一個方法:
+ (BOOL)isTableExists:(NSString *)tableName uid:(NSString *)uid{
    // 去sqlite_master這個表裡面去查詢建立此索引的sql語句
    NSString *queryCreateSqlStr = [NSString stringWithFormat:@"select sql from sqlite_master where type = 'table' and name = '%@'",tableName];
    
    NSMutableArray *resultArray = [CWDatabase querySql:queryCreateSqlStr uid:uid];
    return resultArray.count > 0;
}
複製程式碼

最後,貼上我們整合出來的方法:

#pragma mark 插入或者更新資料
+ (BOOL)insertOrUpdateModel:(id)model uid:(NSString *)uid targetId:(NSString *)targetId {
    // 獲取表名
    Class cls = [model class];
    NSString *tableName = [CWModelTool tableName:cls targetId:targetId];
    
    // 判斷資料庫是否存在對應的表,不存在則建立
    if (![CWSqliteTableTool isTableExists:tableName uid:uid]) {
        [self createSQLTable:cls uid:uid targetId:targetId];
    }
    
    // 根據主鍵,判斷資料庫內是否存在記錄
    // 判斷物件是否返回主鍵資訊
    if (![cls respondsToSelector:@selector(primaryKey)]) {
        NSLog(@"如果想要操作這個模型,必須要實現+ (NSString *)primaryKey;這個方法,來告訴我主鍵資訊");
        return NO;
    }
    // 獲取主鍵
    NSString *primaryKey = [cls primaryKey];
    if (!primaryKey) {
        NSLog(@"你需要指定一個主鍵來建立資料庫表");
        return NO;
    }
    // 模型中的主鍵的值
    id primaryValue = [model valueForKeyPath:primaryKey];
    //  查詢語句:  NSString *checkSql = @"select * from 表名 where 主鍵 = '主鍵值' ";
    NSString * checkSql = [NSString stringWithFormat:@"select * from %@ where %@ = '%@'",tableName,primaryKey,primaryValue];
    
    // 執行查詢語句,獲取結果
    NSArray *result = [CWDatabase querySql:checkSql uid:uid];
    // 獲取類的所有成員變數的名稱與型別
    NSDictionary *nameTypeDict = [CWModelTool classIvarNameAndTypeDic:cls];
    // 獲取所有成員變數的名稱,也就是sql語句欄位名稱
    NSArray *allIvarNames = nameTypeDict.allKeys;
    // 獲取所有成員變數對應的值
    NSMutableArray *allIvarValues = [NSMutableArray array];
    for (NSString *ivarName in allIvarNames) {
        // 獲取對應的值,暫時不考慮自定義模型和oc模型的情況
        id value = [model valueForKeyPath:ivarName];
        [allIvarValues addObject:value];
    }
    // 欄位1=欄位1值 allIvarNames[i]=allIvarValues[I]
    NSMutableArray *ivarNameValueArray = [NSMutableArray array];
    NSInteger count = allIvarNames.count;
    for (int i = 0; i < count; i++) {
        NSString *name = allIvarNames[I];
        id value = allIvarValues[I];
        NSString *ivarNameValue = [NSString stringWithFormat:@"%@='%@'",name,value];
        [ivarNameValueArray addObject:ivarNameValue];
    }
    
    NSString *execSql = @"";
    if (result.count > 0) { // 表記憶體在記錄,更新
        // update 表名 set 欄位1='欄位1值',欄位2='欄位2的值'...where 主鍵 = '主鍵值'
        execSql = [NSString stringWithFormat:@"update %@ set %@ where %@ = '%@'",tableName,[ivarNameValueArray componentsJoinedByString:@","],primaryKey,primaryValue];
    }else { // 表內不存在記錄,插入
        // insert into 表名(欄位1,欄位2,欄位3) values ('值1''值2''值3')
        execSql = [NSString stringWithFormat:@"insert into %@(%@) values('%@')",tableName,[allIvarNames componentsJoinedByString:@","],[allIvarValues componentsJoinedByString:@"','"]];
    }
    return [CWDatabase execSQL:execSql uid:uid];
}
複製程式碼

然後我們通過單元測試來測試這個方法,首先我們測試在資料不存在的時候的插入操作:

// 向Chavez資料庫的“Student國防科技大學”表內插入兩條資料
- (void)testCreateTableAndInsertModel {
    Student *stu = [[Student alloc] init];
    stu.stuId = 110;
    stu.name = @"中國公安";
    stu.age = 100;
    stu.height = 190;
    BOOL result = [CWSqliteModelTool insertOrUpdateModel:stu uid:@"Chavez" targetId:@"國防科技大學"];
    XCTAssertTrue(result);
    
    Student *stu1 = [[Student alloc] init];
    stu1.stuId = 119;
    stu1.name = @"中國火警";
    stu1.age = 101;
    stu1.height = 200;
    BOOL result1 = [CWSqliteModelTool insertOrUpdateModel:stu1 uid:@"Chavez" targetId:@"國防科技大學"];
    XCTAssertTrue(result1);
}
複製程式碼

我們開啟資料庫軟體,按command+R重新整理軟體,檢視結果如下

image.png
插入資料測試成功,然後我們再為這個方法來寫一個更新資料的單元測試:

// 我們把資料庫裡面stuId為110的中國公安的資料修改,還是呼叫同樣的方法
- (void)testUpdateModel {
    
    Student *stu = [[Student alloc] init];
    stu.stuId = 110;
    stu.name = @"中國公安警察支隊";
    stu.age = 90;
    stu.height = 189;
    
    BOOL result = [CWSqliteModelTool insertOrUpdateModel:stu uid:@"Chavez" targetId:@"國防科技大學"];
    XCTAssertTrue(result);
}
複製程式碼

執行之後將資料庫軟體進行重新整理,得到如下表格,發現stuId為110的資料已經按照我們最新的模型進行了修改,測試通過。

image.png

最終,我們將資料庫的建立、開啟、建表、插入、更新操作都封裝成了一個方法,非常符合我們之前要求的,簡單、簡單、簡單無腦。

如果你想要儲存一條資料到本地資料庫,只需要執行這個方法:

+ (BOOL)insertOrUpdateModel:(id)model uid:(NSString *)uid targetId:(NSString *)targetId;
複製程式碼

如果你想要更新本地資料庫的一條資料,也只需要執行上面的方法,絲毫不需要關心資料庫是如何建立的,資料庫表是如何建立的等。。


如果你想要查詢資料庫某個表裡面的所有資料,只需要執行這個方法:

+ (NSArray *)queryAllModels:(Class)cls uid:(NSString *)uid targetId:(NSString *)targetId;
複製程式碼

後期我們會為查詢增加一些條件,來滿足更多的查詢場景。

4.本篇結束

在此,資料庫的增刪查改我們通過封裝出來的兩個方法,便捷的實現了其中3項,一些擴充的功能選擇在後面再完善吧。 在下一篇文章,我們會實現資料庫的刪除、資料庫遷移,以及再完善一下細節,在更後面的文章,我們會實現模型巢狀物件,陣列、字典潛逃物件的情況以及多執行緒安全的處理。。

github地址 本次的程式碼,tag為1.1.0,你可以在release下找到對應的tag下載下來

最後覺得有用的同學,希望能給本文點個喜歡,給github點個star以資鼓勵,謝謝大家。

PS: 因為我也是一邊封裝,一邊寫文章。效率可能比較低,問題也會有,歡迎大家向我拋issue,有更好的思路也歡迎大家留言!

最後再為大家提供上一篇文章的地址。從0開始弄一個面向OC資料庫(一)

相關文章