針對JQFMDB(二次封裝FMDB)的解讀

　　FMDB 是針對 Sqlite 的封裝，極其好用。但是為了更一步的簡單使用，有必要對 FMDB 再進行一次封裝，減去手寫數據庫語句的煩惱。JQFMDB 基本就是為了達到這個功能而生。

/**
 (主鍵id,自動創建) 返回最后插入的primary key id
 @param tableName 表的名稱
 */
- (NSInteger)lastInsertPrimaryKeyId:(NSString *)tableName;

　　首先是主鍵，JQFMDB 會默認在創建表的時候添加一個名為: pkid 的主鍵。這個方法返回當前最大的主鍵：

- (NSInteger)lastInsertPrimaryKeyId:(NSString *)tableName
{
    NSString *sqlstr = [NSString stringWithFormat:@"SELECT * FROM %@ where pkid = (SELECT max(pkid) FROM %@)", tableName, tableName];
    FMResultSet *set = [_db executeQuery:sqlstr];
    while ([set next])
    {
        return [set longLongIntForColumn:@"pkid"];
    }
    return 0;
}

/**
 單例方法創建數據庫, 如果使用shareDatabase創建,則默認在NSDocumentDirectory下創建JQFMDB.sqlite, 但只要使用這三個方法任意一個創建成功, 之后即可使用三個中任意一個方法獲得同一個實例,參數可隨意或nil

        dbName 數據庫的名稱 如: @"Users.sqlite", 如果dbName = nil,則默認dbName=@"JQFMDB.sqlite"
        dbPath 數據庫的路徑, 如果dbPath = nil, 則路徑默認為NSDocumentDirectory
 */
+ (instancetype)shareDatabase;
+ (instancetype)shareDatabase:(NSString *)dbName;
+ (instancetype)shareDatabase:(NSString *)dbName path:(NSString *)dbPath;

　　這里的單例只是用了一個靜態的 JQFMDB 變量。這里的 JQFMDB 有三個屬性:

@property (nonatomic, strong)NSString *dbPath;
@property (nonatomic, strong)FMDatabaseQueue *dbQueue;
@property (nonatomic, strong)FMDatabase *db;

　　在創建 JQFMDB 單例對象的時候會給 _dbPath 和 _db 賦值。並重寫了 _dbQueue 的 get 方法，根據 _dbPath 創建 _dbQueue。然后用了一句:

self.db = [fmdb valueForKey:@"_db"];

　　把 _db 進行了重新賦值，這里的 fmdb 是根據 _dbPath 創建的 FMDatabaseQueue 變量：

FMDatabaseQueue *fmdb = [FMDatabaseQueue databaseQueueWithPath:_dbPath];

　　且在單例方法實現的結尾用 open 判斷數據庫是否創建成功:

    if (![jqdb.db open]) {
        NSLog(@"database can not open !");
        return nil;
    };

/**
 非單例方法創建數據庫
 
 @param dbName 數據庫的名稱 如: @"Users.sqlite"
        dbPath 數據庫的路徑, 如果dbPath = nil, 則路徑默認為NSDocumentDirectory
 */
- (instancetype)initWithDBName:(NSString *)dbName;
- (instancetype)initWithDBName:(NSString *)dbName path:(NSString *)dbPath;

　　常規的創建數據庫對象。

/**
 創建表 通過傳入的model或dictionary(如果是字典注意類型要寫對),雖然都可以不過還是推薦以下都用model

 @param tableName 表的名稱
 @param parameters 設置表的字段,可以傳model(runtime自動生成字段)或字典(格式:@{@"name":@"TEXT"})
 @return 是否創建成功
 */
- (BOOL)jq_createTable:(NSString *)tableName dicOrModel:(id)parameters;

/**
 同上,
 @param nameArr 不允許model或dic里的屬性/key生成表的字段,如:nameArr = @[@"name"],則不允許名為name的屬性/key 生成表的字段
 
 */
- (BOOL)jq_createTable:(NSString *)tableName dicOrModel:(id)parameters excludeName:(NSArray *)nameArr;

　　這里是建表，方法二 里面有個 nameArr 的數組參數，主要用來記錄不希望被添加進表里的字段名。

　　主要看 parameters 參數，這個 id 類型的參數可以是一個 model 對象或者一個字典或者一個 [model Class] 的字符串。當是一個字典的時候：字典的 key 就是表的字段名，對應的 value 就是該字段的類型，如: "TEXT" 等。

　　當 parameters  是一個 model 對象或者 [model Class] 的時候，主要使用 runtime 來遍歷模型類的各個屬性和屬性對應的類型：

- (NSDictionary *)modelToDictionary:(Class)cls excludePropertyName:(NSArray *)nameArr
{
    NSMutableDictionary *mDic = [NSMutableDictionary dictionaryWithCapacity:0];
    unsigned int outCount;
    objc_property_t *properties = class_copyPropertyList(cls, &outCount);
    for (int i = 0; i < outCount; i++) {
        
        NSString *name = [NSString stringWithCString:property_getName(properties[i]) encoding:NSUTF8StringEncoding];
        if ([nameArr containsObject:name]) continue;
        
        NSString *type = [NSString stringWithCString:property_getAttributes(properties[i]) encoding:NSUTF8StringEncoding];
        
        id value = [self propertTypeConvert:type];
        if (value) {
            [mDic setObject:value forKey:name];
        }
        
    }
    free(properties);
    
    return mDic;
}

- (NSString *)propertTypeConvert:(NSString *)typeStr
{
    NSString *resultStr = nil;
    if ([typeStr hasPrefix:@"T@\"NSString\""]) {
        resultStr = SQL_TEXT;
    } else if ([typeStr hasPrefix:@"T@\"NSData\""]) {
        resultStr = SQL_BLOB;
    } else if ([typeStr hasPrefix:@"Ti"]||[typeStr hasPrefix:@"TI"]||[typeStr hasPrefix:@"Ts"]||[typeStr hasPrefix:@"TS"]||[typeStr hasPrefix:@"T@\"NSNumber\""]||[typeStr hasPrefix:@"TB"]||[typeStr hasPrefix:@"Tq"]||[typeStr hasPrefix:@"TQ"]) {
        resultStr = SQL_INTEGER;
    } else if ([typeStr hasPrefix:@"Tf"] || [typeStr hasPrefix:@"Td"]){
        resultStr= SQL_REAL;
    }
    
    return resultStr;
}

　　當拿到存放數據表的字段名和字段類型的 dic 的時候就開始，編寫數據庫語句執行數據庫語句創建表:

    NSMutableString *fieldStr = [[NSMutableString alloc] initWithFormat:@"CREATE TABLE %@ (pkid  INTEGER PRIMARY KEY,", tableName];
    
    int keyCount = 0;
    for (NSString *key in dic) {
        
        keyCount++;
        if ((nameArr && [nameArr containsObject:key]) || [key isEqualToString:@"pkid"]) {
            continue;
        }
        if (keyCount == dic.count) {
            [fieldStr appendFormat:@" %@ %@)", key, dic[key]];
            break;
        }
        
        [fieldStr appendFormat:@" %@ %@,", key, dic[key]];
    }
    
    BOOL creatFlag;
    creatFlag = [_db executeUpdate:fieldStr];

/**
 增加: 向表中插入數據

 @param tableName 表的名稱
 @param parameters 要插入的數據,可以是model或dictionary(格式:@{@"name":@"小李"})
 @return 是否插入成功
 */
- (BOOL)jq_insertTable:(NSString *)tableName dicOrModel:(id)parameters;

- (NSArray *)getColumnArr:(NSString *)tableName db:(FMDatabase *)db
{    
    NSMutableArray *mArr = [NSMutableArray arrayWithCapacity:0];
    
    FMResultSet *resultSet = [db getTableSchema:tableName];
    
    while ([resultSet next]) {
        [mArr addObject:[resultSet stringForColumn:@"name"]];
    }
    
    return mArr;
}

　　首先拿到表里面的所有的字段名字放進數組里面。

- (NSDictionary *)getModelPropertyKeyValue:(id)model tableName:(NSString *)tableName clomnArr:(NSArray *)clomnArr
{
    NSMutableDictionary *mDic = [NSMutableDictionary dictionaryWithCapacity:0];
    unsigned int outCount;
    objc_property_t *properties = class_copyPropertyList([model class], &outCount);
    
    for (int i = 0; i < outCount; i++) {
        
        NSString *name = [NSString stringWithCString:property_getName(properties[i]) encoding:NSUTF8StringEncoding];
        if (![clomnArr containsObject:name]) {
            continue;
        }
        
        id value = [model valueForKey:name];
        if (value) {
            [mDic setObject:value forKey:name];
        }
    }
    free(properties);
    
    return mDic;
}

　　當傳入的是模型的時候，拿到模型的 key 和 value 值，這里的模型和上面的創建表的模型是有區別的，這里的模型是對屬性賦過值的，創建表的模型是不賦值的，建表時主要是使用模型的屬性名和屬性類型去和數據表的字段對應創建。這里傳的模型則是為了拿到屬性名並且拿到屬性值給表里的字段賦值。

　　當拿到屬性名和屬性值時候，就是編寫數據庫語句執行數據庫語句，向表中插入數據。

/**
 刪除: 根據條件刪除表中數據

 @param tableName 表的名稱
 @param format 條件語句, 如:@"where name = '小李'"
 @return 是否刪除成功
 */
- (BOOL)jq_deleteTable:(NSString *)tableName whereFormat:(NSString *)format, ...;

　　刪除表中的數據。

#define va_start(ap, param) __builtin_va_start(ap, param)

　　va_start，函數名稱，讀取可變參數的過程其實就是在堆棧中，使用指針,遍歷堆棧段中的參數列表,從低地址到高地址一個一個地把參數內容讀出來的過程·

#define va_end(ap)          __builtin_va_end(ap)

　　主要是這里的 format 參數:

　　示例:

[NSString stringWithFormat:@"where device_id = '%@'", model.device_id]

　　即刪除數據表中 device_id 等於 model.device_id 的那條數據。

- (BOOL)jq_deleteTable:(NSString *)tableName whereFormat:(NSString *)format, ...
{
    va_list args;
    va_start(args, format);
    NSString *where = format?[[NSString alloc] initWithFormat:format locale:[NSLocale currentLocale] arguments:args]:format;
    va_end(args);
    BOOL flag;
    NSMutableString *finalStr = [[NSMutableString alloc] initWithFormat:@"delete from %@  %@", tableName,where];
    flag = [_db executeUpdate:finalStr];
    
    return flag;
}

/**
 更改: 根據條件更改表中數據

 @param tableName 表的名稱
 @param parameters 要更改的數據,可以是model或dictionary(格式:@{@"name":@"張三"})
 @param format 條件語句, 如:@"where name = '小李'"
 @return 是否更改成功
 */
- (BOOL)jq_updateTable:(NSString *)tableName dicOrModel:(id)parameters whereFormat:(NSString *)format, ...;

/**
 查找: 根據條件查找表中數據

 @param tableName 表的名稱
 @param parameters 每條查找結果放入model(可以是[Person class] or @"Person" or Person實例)或dictionary中
 @param format 條件語句, 如:@"where name = '小李'",
 @return 將結果存入array,數組中的元素的類型為parameters的類型
 */
- (NSArray *)jq_lookupTable:(NSString *)tableName dicOrModel:(id)parameters whereFormat:(NSString *)format, ...;

/**
 批量插入或更改

 @param dicOrModelArray 要insert/update數據的數組,也可以將model和dictionary混合裝入array
 @return 返回的數組存儲未插入成功的下標,數組中元素類型為NSNumber
 */
- (NSArray *)jq_insertTable:(NSString *)tableName dicOrModelArray:(NSArray *)dicOrModelArray;

// `刪除表
- (BOOL)jq_deleteTable:(NSString *)tableName;

- (BOOL)jq_deleteTable:(NSString *)tableName
{
    
    NSString *sqlstr = [NSString stringWithFormat:@"DROP TABLE %@", tableName];
    if (![_db executeUpdate:sqlstr])
    {
        return NO;
    }
    return YES;
}

// `清空表
- (BOOL)jq_deleteAllDataFromTable:(NSString *)tableName;

- (BOOL)jq_deleteAllDataFromTable:(NSString *)tableName
{
    
    NSString *sqlstr = [NSString stringWithFormat:@"DELETE FROM %@", tableName];
    if (![_db executeUpdate:sqlstr])
    {
        return NO;
    }
    
    return YES;
}

// `是否存在表
- (BOOL)jq_isExistTable:(NSString *)tableName;

- (BOOL)jq_isExistTable:(NSString *)tableName
{
    
    FMResultSet *set = [_db executeQuery:@"SELECT count(*) as 'count' FROM sqlite_master WHERE type ='table' and name = ?", tableName];
    while ([set next])
    {
        NSInteger count = [set intForColumn:@"count"];
        if (count == 0) {
            return NO;
        } else {
            return YES;
        }
    }
    return NO;
}

// `表中共有多少條數據
- (int)jq_tableItemCount:(NSString *)tableName;

- (int)jq_tableItemCount:(NSString *)tableName
{
    
    NSString *sqlstr = [NSString stringWithFormat:@"SELECT count(*) as 'count' FROM %@", tableName];
    FMResultSet *set = [_db executeQuery:sqlstr];
    while ([set next])
    {
        return [set intForColumn:@"count"];
    }
    return 0;
}

// `關閉數據庫
- (void)close;
// `打開數據庫 (每次shareDatabase系列操作時已經open,當調用close后若進行db操作需重新open或調用shareDatabase)
- (void)open;

/**
 增加新字段, 在建表后還想新增字段,可以在原建表model或新model中新增對應屬性,然后傳入即可新增該字段,該操作已在事務中執行
 
 @param tableName 表的名稱
 @param parameters 如果傳Model:數據庫新增字段為建表時model所沒有的屬性,如果傳dictionary格式為@{@"newname":@"TEXT"}
 @param nameArr 不允許生成字段的屬性名的數組
 @return 是否成功
 */
- (BOOL)jq_alterTable:(NSString *)tableName dicOrModel:(id)parameters excludeName:(NSArray *)nameArr;
- (BOOL)jq_alterTable:(NSString *)tableName dicOrModel:(id)parameters;

- (BOOL)jq_alterTable:(NSString *)tableName dicOrModel:(id)parameters excludeName:(NSArray *)nameArr
{
    __block BOOL flag;
    [self jq_inTransaction:^(BOOL *rollback) {
        if ([parameters isKindOfClass:[NSDictionary class]]) {
            for (NSString *key in parameters) {
                if ([nameArr containsObject:key]) {
                    continue;
                }
                flag = [_db executeUpdate:[NSString stringWithFormat:@"ALTER TABLE %@ ADD COLUMN %@ %@", tableName, key, parameters[key]]];
                if (!flag) {
                    *rollback = YES;
                    return;
                }
            }
            
        } else {
            Class CLS;
            if ([parameters isKindOfClass:[NSString class]]) {
                if (!NSClassFromString(parameters)) {
                    CLS = nil;
                } else {
                    CLS = NSClassFromString(parameters);
                }
            } else if ([parameters isKindOfClass:[NSObject class]]) {
                CLS = [parameters class];
            } else {
                CLS = parameters;
            }
            NSDictionary *modelDic = [self modelToDictionary:CLS excludePropertyName:nameArr];
            NSArray *columnArr = [self getColumnArr:tableName db:_db];
            for (NSString *key in modelDic) {
                if (![columnArr containsObject:key] && ![nameArr containsObject:key]) {
                    flag = [_db executeUpdate:[NSString stringWithFormat:@"ALTER TABLE %@ ADD COLUMN %@ %@", tableName, key, modelDic[key]]];
                    if (!flag) {
                        *rollback = YES;
                        return;
                    }
                }
            }
        }
    }];
    
    return flag;
}

flag = [_db executeUpdate:[NSString stringWithFormat:@"ALTER TABLE %@ ADD COLUMN %@ %@", tableName, key, modelDic[key]]];

　　新增字段的表名、新增字段的名字、新增字段的類型。

/**
 將操作語句放入block中即可保證線程安全, 如:
 
 Person *p = [[Person alloc] init];
 p.name = @"小李";
 [jqdb jq_inDatabase:^{
 [jqdb jq_insertTable:@"users" dicOrModel:p];
 }];
 */
- (void)jq_inDatabase:(void (^)(void))block;


/**
 事務: 將操作語句放入block中可執行回滾操作(*rollback = YES;)
 
 Person *p = [[Person alloc] init];
 p.name = @"小李";
 
 for (int i=0,i < 1000,i++) {
 [jq jq_inTransaction:^(BOOL *rollback) {
 BOOL flag = [jq jq_insertTable:@"users" dicOrModel:p];
 if (!flag) {
 *rollback = YES; //只要有一次不成功,則進行回滾操作
 return;
 }
 }];
 }

 */
- (void)jq_inTransaction:(void(^)(BOOL *rollback))block;

- (void)jq_inDatabase:(void(^)(void))block
{
    
    [[self dbQueue] inDatabase:^(FMDatabase *db) {
        block();
    }];
}

- (void)jq_inTransaction:(void(^)(BOOL *rollback))block
{
    
    [[self dbQueue] inTransaction:^(FMDatabase *db, BOOL *rollback) {
        block(rollback);
    }];
    
}

　　在 Queue 的 inDatabase 里面做操作。

END

  參考連接:http://blog.csdn.net/jk110333/article/details/41940177

http://www.cnblogs.com/hanyonglu/archive/2011/05/07/2039916.html