FMDB 二次封装工具类,让你快速学会封装,集成数据库

时间:2022-02-05 19:47:39

来源:StrivEver

链接:http://www.jianshu.com/p/4c77aee0b41c


上个版本为了增加用户体验,部分页面集成了离线缓存数据功能,于是就在项目里使用了数据库管理离线数据。下面交大家一步步学会使用FMDB,以及FMDB的二次封装,同事把我二次封装的数据库放出来,希望能够帮助大家快速学习,集成数据库功能吧。


一.首先看一下STDB文件结构


FMDB 二次封装工具类,让你快速学会封装,集成数据库


STDB文件结构


  • Table.h主要放一些Table的创建语句, 方便管理我的数据库各张表创建

  • DBDefine.h主要放一些表名的宏定义,数据库版本号,数据库名字等等,方便我们在使用数据库过程中更直观管理版本和各种表

  • STDBTool.h,STDBTool.m具体封装实现代码


FMDB 二次封装工具类,让你快速学会封装,集成数据库


Table.h结构


二.具体实现功能


1 . STDBTool.h 头文件看一下


FMDB 二次封装工具类,让你快速学会封装,集成数据库


STDBTool.h


我定义了三个FMDatabaseQueue 因为实际操作中我需要数据库嵌套,如果只使用一个FMDatabaseQueue 将会陷入死循环,下面看一下1FMDatabaseQueue源码分析一下原因:


FMDB 二次封装工具类,让你快速学会封装,集成数据库


FMDatabaseQueue 全局变量


创建一个队列_queue = dispatch_queue_create([[NSString stringWithFormat:@"fmdb.%@", self] UTF8String], NULL);默认是串行队列,数据库操作的时候FMDB源码如下图


FMDB 二次封装工具类,让你快速学会封装,集成数据库


FMDatabaseQueue 同步执行源码


同步执行串行队列 block块里按着顺序执行。


FMDB 二次封装工具类,让你快速学会封装,集成数据库


demo0


任务1执行 ——>任务二等待任务一执行完毕执行,任务一等待任务二执行完毕执行,死锁。 如果新建一个串行队列


FMDB 二次封装工具类,让你快速学会封装,集成数据库


demo1


这样就没有问题。 至于同步异步并行串行网上也有很多,不在一一介绍啦。


2 . STDBTool的初始化 ,很显然 STDBTool用的是单例啦, 看一下alloc方法


FMDB 二次封装工具类,让你快速学会封装,集成数据库


STDBTool 初始化


这里面也就是创建一下数据库文件,设置数据库版本号。

当数据库有新表需要增加时,我们需要改变数据库版本号,对数据库进行升级。


  • .查询数据库当前版本


NSString * sql = [NSString stringWithFormat:@"PRAGMA user_version"];

FMResultSet * rs = [db executeQuery:sql];  

    int nVersion = 0;  

    while ([rs next]) {  

        nVersion = [rs intForColumn:@"user_version"];

    }


  • 与宏定义数据库版本不一致 需要更新 设置 数据库版本号


NSString *sql = [NSString stringWithFormat:@"PRAGMA user_version = %ld",(long)newVersion];  

BOOL ret = [db executeUpdate:sql];


STDBTool初始化就这些吧。也没什么难点,主要是跟大家一起回顾一下。


3 .实现的数据库数据操作功能


一般数据库操作无非是增删改查这些基本操作,当然我的封装也是基于实现这些功能的。但是根据具体情况我们需要进行封装。


  • 执行单个sql语句时候,不需要使用事务处理,我们需要知道操作类型,这里我写了个枚举type 便于区分


-(void)executeSQL:(NSString *)sqlStr actionType:(ST_DB_ActionType)actionType withBlock:(void(^)(BOOL bRet, FMResultSet *rs, NSString *msg))block{

[_dbQueue inDatabase:^(FMDatabase *db) {

     if (actionType == ST_DB_SELECT) {

         //查询语句 需要返回记录集

       FMResultSet * rs = [db executeQuery:sqlStr];

         if ([db hadError]) {

             block(NO,rs,[db lastErrorMessage]);

             NSLog(@"executeSQL error %d:  %@",[db lastErrorCode],[db lastErrorMessage]);

         }else{

             block(YES,rs,nil);

         }

     }else{

         //更新操作 只关心操作是否执行成功,不关心记录集  返回布尔值  无执行结果

         BOOL ret = [db executeUpdate:sqlStr];

         if ([db hadError]) {

             block(NO,nil,[db lastErrorMessage]);

             NSLog(@"executeSQL error %d:  %@",[db lastErrorCode],[db lastErrorMessage]);

         }else{

             block(ret,nil,nil);

         }

     }

}];

}


  • 根据查询结果 确定是更新还是新增操作,只需要知道是否操作成功,不关心结果集 只处理一个查询更新,不需要事务处理


- (void)executeRelevanceSql:(NSArray *)sqlList withBlock:(void(^)(BOOL ret,NSString * errMsg))block{

    __block BOOL ret;

    [_dbQueue inDatabase:^(FMDatabase *db) {

        FMResultSet * rs = [db executeQuery:sqlList[0]];

        if ([db hadError]) {

            block(NO,[db lastErrorMessage]);

            NSLog(@"da_error_%@",[db lastErrorMessage]);

        }

 

        int nCount = 0;

        if ([rs next]) {

            //获取查询数据的个数

            nCount = [rs intForColumnIndex:0];

        }

        [rs close];

 

        NSString * nextSqlString = nil;

        if (nCount > 0) {

            //查询到了结果  执行update操作

            nextSqlString = sqlList[1];

        }else{

            //查询无结果  执行 insert into 操作

            nextSqlString = sqlList[2];

        }

 

        ret = [db executeUpdate:nextSqlString];

        if ([db hadError]) {

            block(NO,[db lastErrorMessage]);

            NSLog(@"da_error_%@",[db lastErrorMessage]);

        }else{

            block(ret, nil);

        }

    }];

}


注:sql语句数组,sqlList[0]查询select语句 sqList[1] update更新语句 sqlList[2] insert into 插入语句


  • 1.根据查询结果 确定是更新还是新增操作,只需要知道是否操作成功,不关心结果集 只处理一个查询更新,不需要事务处理


- (void)executeRelevanceSql:(NSArray *)sqlList withBlock:(void(^)(BOOL ret,NSString * errMsg))block{

__block BOOL ret;

[_dbQueue inDatabase:^(FMDatabase *db) {

    FMResultSet * rs = [db executeQuery:sqlList[0]];

    if ([db hadError]) {

        block(NO,[db lastErrorMessage]);

        NSLog(@"da_error_%@",[db lastErrorMessage]);

    }

    int nCount = 0;

    if ([rs next]) {

        //获取查询数据的个数

        nCount = [rs intForColumnIndex:0];

    }

    [rs close];

 

    NSString * nextSqlString = nil;

    if (nCount > 0) {

        //查询到了结果  执行update操作

        nextSqlString = sqlList[1];

    }else{

        //查询无结果  执行 insert into 操作

        nextSqlString = sqlList[2];

    }

    ret = [db executeUpdate:nextSqlString];

    if ([db hadError]) {

        block(NO,[db lastErrorMessage]);

        NSLog(@"da_error_%@",[db lastErrorMessage]);

    }else{

        block(ret, nil);

    }

}];

}


注: sql语句数组,sqlList[0]查询select语句 sqList1update更新语句 sqlList2 insert into 插入语句


4 . sqlList 是一个二维数组,每一个成员包含三个sql语句,分别是查询,更新,插入,并且根据查询结果返回是执行更新 还是 插入操作。使用dbQueue2 用于直接调用。批量处理,使用事务。


- (void)executeDbQueue2RelevanceTransactionSqlList:(NSArray *)sqlList withBlock:(void(^)(BOOL bRet, NSString *msg, BOOL *bRollback))block{

    __block BOOL ret = NO;

    [_dbQueue2 inTransaction:^(FMDatabase *db, BOOL *rollback) {

        for (NSArray * singleSqlList in sqlList ) {

            FMResultSet * rs = [db executeQuery:singleSqlList[0]];

            if ([db hadError]) {

                block(NO,[db lastErrorMessage],rollback);

                NSLog(@"da_error_%@",[db lastErrorMessage]);

            }else{

                int nCount = 0;

                while ([rs next]){

                    nCount  = [rs intForColumnIndex:0];

                }

                [rs close];

 

                NSString * nextSqlString = nil;

                if (nCount > 0){

                    //执行更新

                    nextSqlString = singleSqlList[1];

                }

                else{

                    //执行插入

                    nextSqlString = singleSqlList[2];

                }

 

                 ret = [db executeUpdate:nextSqlString];

                if ([db hadError])

                {

                    block(NO, [db lastErrorMessage], rollback);

                    NSLog(@"executeSql Err %d: %@", [db lastErrorCode], [db lastErrorMessage]);

                }

            }

        }

         block(ret, nil, rollback);

    }];

}


注:sql语句数组,sqlArr[i][0]:查询语句;sqlArri:update语句;sqlArri:insert into语句


5.sql语句数组中每个成员有2条语句,第一条是select语句,第二条是insert into语句,根据第一个sql的执行结果确定第二条语句是否执行。根据查询结果确定是否新增,批量处理,使用事务处理,不需要返回记录集使用dbQueue2,用于程序中直接调用(非封装在其他方法中)


-(void)executeInsertTransactionSqlList:(NSArray *)sqlStrList withBlock:(void(^)(BOOL bRet, NSString *msg, BOOL *bRollback))block

{

    __block BOOL ret = NO;

     NSLog(@"开始啦---");

    [_dbQueue2  inTransaction:^(FMDatabase *db, BOOL *rollback){

 

        for (NSArray *sqlArray in sqlStrList){

            FMResultSet *rs = [db executeQuery:[sqlArray objectAtIndex:0]];

            if ([db hadError]){

                block(NO, [db lastErrorMessage], rollback);

                NSLog(@"executeSql Err %d: %@", [db lastErrorCode], [db lastErrorMessage]);

            }

 

            int nCount = 0;

            while ([rs next]){

                nCount = [rs intForColumnIndex:0];

            }

            [rs close];

 

            if (nCount <= 0){

                ret = [db executeUpdate:[sqlArray objectAtIndex:1]];

                if ([db hadError])

                {

                    block(NO, [db lastErrorMessage], rollback);

                    NSLog(@"executeSql Err %d: %@", [db lastErrorCode], [db lastErrorMessage]);

                }

            }

        }

        block(ret, nil, rollback);

    }];

}


注:sql语句数组,sqlArr[i][0]:查询语句;sqlArri:insert into语句

6.批量处理更新或者新增sql语句,不需要返回记录集 无事务处理


- (void)executeSQLList:(NSArray *)sqlStrList db:(FMDatabase *)db withBlock:(void(^)(BOOL bRet, NSString *msg))block{

    __block BOOL bRet = NO;

    for (NSString * sqlString in sqlStrList) {

        bRet = [db executeUpdate:sqlString];

        if ([db hadError]) {

            block(bRet,[db lastErrorMessage]);

            NSLog(@"executeSQLList Err %d: %@", [db lastErrorCode], [db lastErrorMessage]);

            break;

        }

    }

    block(bRet,nil);

}


注: sql语句数组update或者insert into语句


7.批量处理更新或者新增sql语句,并且不需要返回记录集,使用事务处理


-(void)executeTransactionSqlList:(NSArray *)sqlStrList withBlock:(void(^)(BOOL bRet, NSString *msg, BOOL *bRollback))block

{

    __block BOOL bRet = NO;

    [_dbQueue  inTransaction:^(FMDatabase *db, BOOL *rollback){

 

        for (NSString *sqlStr in sqlStrList)

        {

            bRet = [db executeUpdate:sqlStr];

            if ([db hadError])

            {

                block(bRet, [db lastErrorMessage], rollback);

                NSLog(@"executeSQLList Err %d: %@", [db lastErrorCode], [db lastErrorMessage]);

                break;

            }

        }

        block(bRet, nil, rollback);

    }];

}


注:sql语句数组update或者insert into语句


还有几个方法在防止死循环嵌套 类似的函数。

github地址(https://github.com/strivever/STSTDBTool)可以直接下载使用,感觉有用的话star一下,谢谢大家。希望能帮到大家。