(原理篇)基於SQLite3輕量級封裝,一行代碼實現增刪改查

最近寫的項目中有用到數據庫,寫了很多蛋疼的sql語句,每次都是好幾行代碼,並且每次都是重複的沒有一點技術含量的代碼,雖然也有很多基於sqlite的封裝,不過用起來仍是感受不夠面向對象!
爲了避免再寫重複的代碼,花了幾天時間,基於SQLite3簡單封裝了下,實現了一行代碼解決增刪改查等經常使用的功能!並無太太高深的知識,主要用了runtime和KVC:git

首先咱們建立個你們都熟悉的Person類,並聲明兩個屬性,下面將以類此展開分析github

 

1sql

2數據庫

3json

4數組

@interface Person : NSObjectapp

@property(nonatomiccopyNSString *name;atom

@property(nonatomicassignNSInteger age;spa

@end.net

 

建立表格

相信下面這句創表語句你們都熟悉吧,就不作介紹了

create table if not exists Person (id integer primary key autoincrement,name text,age integer)

然而開發中咱們都是基於模型開發的,基本上都是一個模型對應數據庫的一張表,那麼每一個模型的屬性都不同,那麼咱們又該如何生成相似上面的語句呢? 我想到了runtime,經過runtime獲取一個類的屬性列表,因此有了下面這個方法:

 

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

/// 獲取當前類的全部屬性

+ (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須要的類型

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

/// 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數據類型,而後使用鍵值對的形式將其保存到了一個字典中,好比:

1

@{@"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]];

下面咱們着重介紹下核心方法,其餘全部方法都是基於該方法實現的

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

/// 自定義語句查詢

- (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賦值給對象!

到此基本上全部的功能就都實現了,其餘的諸如更新數據,刪除數據,刪除表格等有提供具體的接口,這裏就不一一介紹了,源碼中有詳細的註釋,同時也有DEMO,有須要的能夠自行下載,
源碼地址:https://github.com/ChrisCaixx/GKDatabase

相關文章
相關標籤/搜索