您现在的位置: IOS教程網 >> IOS系統 >  >> iOS 訊息 >> iOS 相關資訊

用 Objective-C Runtime 反射自動化 SQLite 資料存取

編輯:iOS 相關資訊

行動應用幾乎都要跟伺服器通訊,也要用 SQLite 保存資料。傳統做法得先手寫建表語法、定義實體類別,再為每個類別寫插入、更新、查詢,重複性極高。Objective-C 的 Runtime 反射機制可以省掉這大部分工作。

先約定規則

  • SQLite 的表名直接使用實體類別名稱。
  • 資料欄位名稱使用實體類別的屬性名稱。
  • 欄位型別統一設為 text——SQLite 是動態型別資料庫,底層儲存本質上都是文字。
  • 實體類別的屬性型別統一設為 NSString。

這樣約定的目的是避免型別轉換帶來的額外麻煩。若要支援各種型別,就得為每種型別寫格式處理的判斷,有興趣可以再往下研究。

擴充 NSObject

先建立一個 NSObject 的分類(Category),命名為 NSObject+Property。

用反射取出所有屬性名稱

- (NSArray *)getPropertyList {
    u_int count;
    objc_property_t *properties = class_copyPropertyList(self.class, &count);
    NSMutableArray *propertyArray = [NSMutableArray arrayWithCapacity:count];

    for (int i = 0; i < count; i++) {
        const char *propertyName = property_getName(properties[i]);
        [propertyArray addObject:[NSString stringWithUTF8String:propertyName]];
    }

    free(properties);   // class_copyPropertyList 回傳的記憶體必須手動釋放
    return propertyArray;
}

free(properties) 這行不能省。任何以 Copy、Create 結尾的 C API 都遵循 Create Rule,呼叫者有責任釋放。

依屬性產生建表語法

- (NSString *)tableSql:(NSString *)tablename {
    NSMutableString *sql = [[NSMutableString alloc] init];
    NSArray *array = [self getPropertyList];

    [sql appendFormat:@"create table %@ (", tablename];
    NSInteger i = 0;
    for (NSString *key in array) {
        if (i > 0) { [sql appendString:@","]; }
        [sql appendFormat:@"%@ text", key];
        i++;
    }
    [sql appendString:@")"];
    return sql;
}

物件轉字典

- (NSDictionary *)convertDictionary {
    NSMutableDictionary *dict = [[NSMutableDictionary alloc] init];

    for (NSString *key in [self getPropertyList]) {
        SEL selector = NSSelectorFromString(key);
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
        id value = [self performSelector:selector];
#pragma clang diagnostic pop

        if (value == nil) { value = [NSNull null]; }
        [dict setObject:value forKey:key];
    }
    return dict;
}

字典還原成物件

- (void)dictionaryForObject:(NSDictionary *)dict {
    for (NSString *key in [dict allKeys]) {
        id value = [dict objectForKey:key];

        if (value == [NSNull null]) { continue; }

        if ([value isKindOfClass:[NSDictionary class]]) {
            id subObj = [self valueForKey:key];
            if (subObj) { [subObj dictionaryForObject:value]; }
        } else {
            [self setValue:value forKeyPath:key];
        }
    }
}

取得類別名稱

- (NSString *)className {
    return [NSString stringWithUTF8String:object_getClassName(self)];
}

DbHelper:負責資料庫操作

插入物件

- (void)insertObject:(id)object {
    NSString *tablename = [object className];
    NSMutableString *sql = [[NSMutableString alloc] init];
    NSArray *array = [object getPropertyList];

    [sql appendFormat:@"insert into %@ (", tablename];
    NSInteger i = 0;
    for (NSString *key in array) {
        if (i > 0) { [sql appendString:@","]; }
        [sql appendFormat:@"%@", key];
        i++;
    }
    [sql appendString:@") values ("];

    NSMutableArray *arrayValue = [NSMutableArray array];
    i = 0;
    for (NSString *key in array) {
        SEL selector = NSSelectorFromString(key);
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"
        id value = [object performSelector:selector];
#pragma clang diagnostic pop

        if (value == nil) { value = @""; }
        [arrayValue addObject:value];

        if (i > 0) { [sql appendString:@","]; }
        [sql appendString:@"?"];
        i++;
    }
    [sql appendString:@")"];

    [_db executeUpdate:sql withArgumentsInArray:arrayValue];
}

這裡用「?」佔位符搭配 withArgumentsInArray:,而不是把值直接拼進字串。參數綁定能避免 SQL injection,也讓 sqlite 有機會複用執行計畫,是必須維持的習慣。

插入字典

與伺服器溝通時通常用 JSON。取得字串後透過 JSONKit 反序列化成 NSDictionary,再寫進資料庫。

- (NSString *)createInsertSqlByDictionary:(NSDictionary *)dict tablename:(NSString *)table {
    NSMutableString *sql = [[NSMutableString alloc] init];
    [sql appendFormat:@"insert into %@ (", table];

    NSInteger i = 0;
    for (NSString *key in dict.allKeys) {
        if (i > 0) { [sql appendString:@","]; }
        [sql appendFormat:@"%@", key];
        i++;
    }
    [sql appendString:@") values ("];

    i = 0;
    for (NSString *key in dict.allKeys) {
        if (i > 0) { [sql appendString:@","]; }
        [sql appendFormat:@":%@", key];
        i++;
    }
    [sql appendString:@")"];
    return sql;
}

- (void)insertBySql:(NSString *)sql dict:(NSDictionary *)dict {
    if (sql && sql.length > 0) {
        [_dbQueue inDatabase:^(FMDatabase *db) {
            [db executeUpdate:sql withParameterDictionary:dict];
        }];
    }
}

查詢並封裝成字典陣列

- (NSArray *)queryDbToDictionaryArray:(NSString *)tablename sql:(NSString *)sql {
    FMResultSet *resultSet = [_db executeQuery:sql];
    NSArray *columnArray = [self fMSetColumnArray:resultSet];
    NSMutableArray *syncArray = [[NSMutableArray alloc] init];

    while ([resultSet next]) {
        NSMutableDictionary *syncData = [[NSMutableDictionary alloc] init];
        for (int i = 0; i < columnArray.count; i++) {
            NSString *columnName = [columnArray objectAtIndex:i];
            NSString *columnValue = [resultSet stringForColumn:columnName];
            if (columnValue == nil) { columnValue = @""; }
            [syncData setObject:columnValue forKey:columnName];
        }
        [syncArray addObject:syncData];
    }

    return [syncArray count] == 0 ? nil : syncArray;
}

查詢並封裝成物件陣列

- (NSArray *)queryDbToObjectArray:(Class)clazz sql:(NSString *)sql {
    FMResultSet *resultSet = [_db executeQuery:sql];
    NSArray *columnArray = [self fMSetColumnArray:resultSet];
    NSMutableArray *syncArray = [[NSMutableArray alloc] init];

    while ([resultSet next]) {
        NSObject *obj = [[clazz alloc] init];
        if (obj == nil) { continue; }

        for (int i = 0; i < columnArray.count; i++) {
            NSString *columnName = [columnArray objectAtIndex:i];
            NSString *columnValue = [resultSet stringForColumn:columnName];
            SEL selector = NSSelectorFromString(columnName);

            if ([obj respondsToSelector:selector]) {
                [obj setValue:columnValue forKeyPath:columnName];
            }
        }
        [syncArray addObject:obj];
    }

    return [syncArray count] == 0 ? nil : syncArray;
}

respondsToSelector: 的檢查是必要的。資料庫欄位與類別屬性不見得完全一致,少了這道防線就會直接 crash。

效能提醒

資料量很大時,這種逐筆反射的方式會有明顯效能代價:每一筆都要做一次 selector 查找與 KVC 設定。實作上建議把 getPropertyList 的結果快取起來(屬性列表在執行期不會變),並用 insert 的 transaction 包覆批次寫入,否則動輒幾千筆的同步會讓主執行緒卡住。

有了這套基礎設施,開發流程就變成:動態建表、從伺服器取得資料直接寫入、顯示時從資料庫撈成物件陣列,省下大量樣板程式碼。

  1. 上一篇文章:
  2. 下一篇文章:
蘋果刷機越獄教程| IOS教程問題解答| IOS技巧綜合| IOS7技巧| IOS8教程
Copyright © IOS教程網 All Rights Reserved