FMDB 再封装,多线程安全

一、前言

  • 继之前封装的 FMDB 二次封装,面向模型 ,由于需要多线程操作数据库,之前是针对 FMDatabase 进行封装的,对于多线程操作就很容易造成数据混乱,前文中也有说明。
  • 趁着刚搞完一个小程序项目,有点空余时间,就再封装一个针对 FMDatabaseQueue 的,支持多线程同时操作数据库,避免数据混乱。

二、API设计

考虑封装的统一性,所以API 设计跟 之前封装的 FMDB 二次封装,面向模型 保持一致,当然,以前都是通过返回值来处理,但由于使用 FMDatabaseQueue 回调都是block,因此提供的API 也是block回调,大家可以在Demo 中比对一下

  • 1、单例模式,项目中唯一,方便管理,传入数据库名称,后续操作不同的数据库
/**
 *  @author gitKong
 *
 *  单例创建,项目唯一
 */
+ (instancetype)shareManager:(NSString *)fl_dbName;

  • 2、创表,外界传入指定的类,工具会根据类来创建表,如果此时表已经存在,则跳过,没有才去创建,执行完这个操作后自动关闭数据库,释放内存
#pragma mark -- 创表

/**
 *  @author gitKong
 *
 *  根据类名创建表,如果有则跳过,没有才创建
 
 *  flag:YES表示创建表格操作执行成功 或者 表格已经存在,NO则失败
 
 *  注意:此方法创建表格后不会自动关闭数据库,当开发者执行其他操作(删除数据库除外)后会自动关闭数据库
 
 *  建议使用insert创建表格并添加数据
 */
- (void)fl_createTable:(Class)modelClass complete:(void(^)(FLFMDBQueueManager *manager, BOOL flag))complete;
  • 3、插入数据,可以传入单个模型,或者传入模型数组,此时内部处理了,遍历数组插入的期间数据库不会关闭,直到所有插入完毕后才关闭数据库;同时,如果传入的模型的FLDBID在对应表中已经存在,则执行更新操作,保证FLDBID对应数据的唯一性
#pragma mark -- 插入
/**
 *  @author gitKong
 *
 *  @param model 插入单个模型或者模型数组,如果此时传入的模型对应的FLDBID在表中已经存在,则替换更新旧的
 
 *  flag:YES表示插入数据操作执行成功,NO则失败
 
 *  注意:如果此时没创建表就自动先创建,表名为模型类名,数据插入完毕后会自动关闭数据库
 
 *  建议直接使用insert创建表格并添加数据,因为create方法执行完不会自动关闭数据库
 */
- (void)fl_insertModel:(id)model complete:(void(^)(FLFMDBQueueManager *manager, BOOL flag))complete;
  • 4、查询 提供三个方法
    • (1)、查询表是否存在,执行完毕就会自动关闭数据库,由于此方法存在,框架工具中会出现错误提示信息,因为如果没有对应表,执行操作语句FMDB就会打印出错误信息,当然,所有操作都不需要手动调用,框架中所有操作都有对应的判断
    • (2)、查找指定表中指定FLDBID的单个模型数据
    • (3)、查找指定表中模型数组(所有的)
/**
 *  @author gitKong
 *
 *  查询指定表是否存在
 
 *  flag:YES表示操作执行成功并且 modelClass 表格存在,NO则操作失败或者 modelClass 表格不存在
 
 *  注意:操作执行完毕会自动关闭数据库
 */
- (void)fl_isExitTable:(Class)modelClass complete:(void(^)(FLFMDBQueueManager *manager, BOOL flag))complete;
/**
 *  @author gitKong
 *
 *  查找指定表中指定DBID的模型
 
 *  model:不等于nil,表示查询数据操作执行成功并有数据,返回查询成功的模型数据,nil则表示查询操作失败 或者 查询成功但数据为空 或者 对应的表格不存在
 
 *  注意:操作执行完毕会自动关闭数据库
 */
- (void)fl_searchModel:(Class)modelClass byID:(NSString *)FLDBID complete:(void(^)(FLFMDBQueueManager *manager,id model))complete;
/**
 *  @author gitKong
 *
 *  查找指定表中模型数组(所有的)
 
 *  modelArr:不等于nil,表示查询数据操作执行成功并有数据,返回查询成功的模型数据,nil则表示查询操作失败 或者 查询成功但数据为空 或者 对应的表格不存在
 
 *  注意:操作执行完毕会自动关闭数据库
 */
- (void)fl_searchModelArr:(Class)modelClass complete:(void(^)(FLFMDBQueueManager *manager,NSArray *modelArr))complete;
  • 5、修改 根据指定FLDBID,将新传入的模型替换旧的模型数据,执行完毕后自动关闭数据库
/**
 *  @author gitKong
 *
 *  修改指定DBID的模型
 
 *  flag:YES表示更新操作执行成功,NO则操作失败 或者 对应的表格不存在
 
 *  注意:操作执行完毕会自动关闭数据库
 */

- (void)fl_modifyModel:(id)model byID:(NSString *)FLDBID complete:(void(^)(FLFMDBQueueManager *manager, BOOL flag))complete;
  • 6、删除,此时也提供了三个方法
    • (1)、删除指定表
    • (2)、删除指定表格的所有数据
    • (3)、删除指定表中指定FLDBID的模型
    • (4)、删除数据库
/**
 *  @author gitKong
 *
 *  删除指定表
 
 *  flag:YES表示删除操作执行成功,NO则操作失败 或者 对应的表格不存在
 
 *  注意:操作执行完毕会自动关闭数据库
 */
- (void)fl_dropTable:(Class)modelClass complete:(void(^)(FLFMDBQueueManager *manager, BOOL flag))complete;
/**
 *  @author gitKong
 *
 *  删除指定表格的所有数据
 
 *  flag:YES表示删除操作执行成功,NO则操作失败 或者 对应的表格不存在 或者 没有对应数据可以删除
 
 *  注意:操作执行完毕会自动关闭数据库
 */
- (void)fl_deleteAllModel:(Class)modelClass complete:(void(^)(FLFMDBQueueManager *manager, BOOL flag))complete;
/**
 *  @author gitKong
 *
 *  删除指定表中指定DBID的模型
 
 *  flag:YES表示删除操作执行成功,NO则操作失败 或者 对应的表格不存在 或者 没有对应数据可以删除
 
 *  注意:操作执行完毕会自动关闭数据库
 */
- (void)fl_deleteModel:(Class)modelClass byId:(NSString *)FLDBID complete:(void(^)(FLFMDBQueueManager *manager, BOOL flag))complete;
/**
 *  @author gitKong
 *
 *  删除数据库
 
 *  注意:操作不涉及到数据库操作,如果你通过create创建后执行此操作,不会关闭数据库
 
 *  @return YES 表示删除成功,NO则删除失败
 */
- (BOOL)fl_dropDB;

三、调用

操作和 之前 封装的一样,只是换了种回调方式,之前是通过返回值来判断,此时则通过block 回调中的 flag 来判断操作是否成功,而且操作失败会触犯回滚,详情请看 GitHub Demo,Demo 中作了详细的使用介绍。

[FLFMDBQUEUEMANAGER fl_insertModel:model complete:^(FLFMDBQueueManager *manager, BOOL flag) {
            if (flag) {
                NSLog(@"插入成功");
            }
            else {
                NSLog(@"插入失败");
            }
        }];
__weak typeof(self) weakSelf = self;
[FLFMDBQUEUEMANAGER fl_deleteModel:[FLStudentModel class] byId:model.FLDBID complete:^(FLFMDBQueueManager *manager, BOOL flag) {
        __strong typeof(self) strongSelf = weakSelf;
        if (flag) {
           NSLog(@"删除数据成功");
           [strongSelf showTip:@"删除数据成功"];
        }
       else{
           NSLog(@"删除数据失败");
           [strongSelf showTip:@"删除数据失败"];
       }
}];
__weak typeof(self) weakSelf = self;
[FLFMDBQUEUEMANAGER fl_modifyModel:model byID:model.FLDBID complete:^(FLFMDBQueueManager *manager, BOOL flag) {
                __strong typeof(self) strongSelf = weakSelf;
                if (flag) {
                    [strongSelf showTip:@"修改名字成功"];
                    [strongSelf.tableView reloadData];
                }
                else{
                    [strongSelf showTip:@"修改名字失败"];
                    NSLog(@"修改名字失败");
                }
            }];
 [FLFMDBQUEUEMANAGER fl_searchModel:[FLStudentModel class] byID:textField.text complete:^(FLFMDBQueueManager *manager,id model) {
                __strong typeof(weakSelf) strongSelf = weakSelf;
                FLStudentModel *studentModel = (FLStudentModel *)model;
                
                if (studentModel.FLDBID) {
                    [strongSelf.modelArrM removeAllObjects];
                    [strongSelf.modelArrM addObject:studentModel];
                    [strongSelf.tableView reloadData];
                }
                else{
                    NSLog(@"找不到这个模型");
                    [strongSelf showTip:@"找不到这个模型"];
                }
            }];

四、使用注意:

  • 1、需要在模型中添加一个属性FLDBID,NSString类型,为了绑定对应的数据,从而进行增删改查操作

  • 2、模型中属性不能有 id命名 的属性,会跟sql 的 主键id 冲突。

  • 3、需要插入数据库的模型不支持继承,因为根据类名来创建表,框架内部只能读取当前类的属性,其父类的属性没办法获取。

  • 4、修改数据库中的模型数据只能通过指定的FLDBID作为条件修改。

  • 5、暂时不支持模型属性动态删减,如果删了对应属性(除了FLDBID)不影响使用,但如果增加属性了,只能从新建表存储。

  • 6、嵌套模型暂时不支持单表处理,需要创建多张表处理。

  • 7、由于每次操作完毕都会主动关闭数据库,避免大量数据操作的时候出现文件读写失败问题,因此会在控制台打印 The FMDatabase <FMDatabase: 0x600000094a50> is not open. 不影响实际使用

五、总结

  • 0、为了方便大家使用,提供了两个宏,创建数据库管理实例,其中如果是使用FLFMDBQUEUEMANAGER ,就是使用默认的数据库,文件为gitkong.sqlite,使用 FLFMDBQUEUEMANAGERX 传入名称,就会创建文件为 “名称”.sqlite

    #define FLDB_DEFAULT_NAME @"gitkong"
    
    #define FLFMDBQUEUEMANAGER [FLFMDBQueueManager shareManager:FLDB_DEFAULT_NAME]
    

/**

  • @author gitKong
  • 多数据库操作暂时不开放,有问题需要解决,敬请期待
    */

define FLFMDBQUEUEMANAGERX(DB_NAME) [FLFMDBQueueManager shareManager:DB_NAME]


- 1、取消了断言机制,防止用户误操作而导致程序崩溃,影响用户体验,如果操作失败,可以通过回调中的 `flag` 判断。

- 2、除了查询表是否存在,所有提供的API 中都已经有相应判断,调用者无需手动做判断。

- 3、内部使用 block 回调,但使用时无需担心出现循环引用问题,当然为了确保安全,可以使用下面代码处理。

__weak typeof(self) weakSelf = self;
__weak typeof(self) strongSelf = weakSelf;


- 4、内部实现比较简单,就不作代码分析了,如果大家有什么不明白或者发现什么问题,欢迎留言给我。

- 5、**欢迎大家关注我,喜欢就给个like,随时更新!谢谢支持!** 

# [GitHub地址](https://github.com/gitkong/FLFMDBManager) 欢迎 Star

推荐阅读更多精彩内容