iOS-FMDB改进方案YIIFMDB:直接操作Model,纯面向对象,不需要写sql语句

我在写UDUserDefaultsModel(文章链接,github)这个库时曾经立下一个flag:要写一个基于model来存取数据库的库,最近刚离职,所以就整合了一下,希望大家多多支持。

在iOS开发过程当中,难免用到数据库,以FMDB居多。以下是一个根据年龄筛选数据的sql语句:

select * from Student where age > 10 and age < 20 or age > 30 order by age desc limit 20

这样写其实没什么问题,但是在我个人看来难以接受,字符串看起来太别扭。比如我再添加一个条件,那么就需要修改整个字符串了。

如果可以很好的控制sql语句,将大大提高编程效率。为此,YIIFMDB就改善了这个缺陷:纯面向对象,直接操作Model,完全不需要写sql语句

其灵感源自于php的Yii 2架构,因为我在看php代码当中,我发现根本就看不到sql语句,而php程序猿也说:“我们的工作就是操作数据库,但是却不写sql语句”。

以下是YIIFMDB详细用法:
YIIFMDB有两个类:YIIFMDB和YIIParameters。其中YIIFMDB封装了数据库相关的操作,比如增删改查之类,而YIIParameters则封装了where之后的参数,比如上段代码当中的:

age > 10 and age < 20 or age > 30 order by age desc limit 20

就可以在YIIParameters当中完成。

接下来逐一介绍YIIParameters类和YIIFMDB类的使用:

YIIParameters类

sql语句当中where之后的参数基本上由以下模块构成:

  • and(与操作)
  • or(或操作)
  • order by(排序)
  • limit(数量限制)

其中的andor又要配置“>,<,=,>=,<=,!=,like”关系,order by又有“ase,dese”的排序操作。

YIIParameters这个类就包含了以上所有元素。以上面的where之后的sql语句为例,具体用法如下:

// 初始化YIIParameters
YIIParameters *parameters = [[YIIParameters alloc] init];
// 执行and操作,将age限制在10-20之间
// age > 10,YIIParametersRelationTypeGreaterThan标志">"
[parameters andWhere:@"age" value:@"10" relationType:YIIParametersRelationTypeGreaterThan];  
// age < 20,YIIParametersRelationTypeLessThan标志"<"
[parameters andWhere:@"age" value:@"20" relationType:YIIParametersRelationTypeLessThan];
// 以上是and,也就是形成的sql语句为: age > 10 and age < 20
// 执行or操作,将age限制在age > 30 以上
[parameters orWhere:@"age" value:@"30" relationType:YIIParametersRelationTypeGreaterThan];
// 根据age进行降序排列
// YIIParametersOrderTypeDesc表示降序"desc",YIIParametersOrderTypeAsc
[parameters orderByColumn:@"age" orderType:YIIParametersOrderTypeDesc];
// 将数据的个数限制在20个
parameters.limitCount = 20;

配置完毕,验证其是否配置正确,那么可以调用一下方法就行了:

NSLog(@"where参数为:%@", parameters.whereParameters);

当然,如果参数都没法配置了,则可以设置whereParameters。而对于YIIParameters更详细的解释请参考 YIIFMDB中的YIIParameters.h

YIIFMDB

YIIParameters用来配置sql语句当中where之后的参数,而YIIFMDB类则是对数据库操作的进一步封装,具体如下:

获取YIIFMDB单例

YIIFMDB *db = [YIIFMDB shareDatabase]; // 推荐使用
// 或者
YIIFMDB *db = [YIIFMDB shareDatabaseForName:@"ABC.sqlite" path:path]; // 自定义数据库名字和路径,在第一次实例的时候传入,以后使用上面方法即可。

主键的字段

@property (nonatomic, readonly, copy) NSString *primaryKey; // 返回"yii_pkID",我自己在创建数据库是配置的主键字段

是否打印log

@property (nonatomic, assign) BOOL shouldOpenDebugLog; // 默认为NO,设为YES,会在控制器后台打印数据库操作相关的一些信息

创建一张表

[[YIIFMDB shareDatabase] createTableWithModelClass:[LCPersonModel class] excludedProperties:nil tableName:@"Person"];

此方法是创建一张名为@"Person"表,并且,表里面的字段也就是LCPersonModel里面的属性,字段的数据类型也对应LCPersonModel里面的数据类型

插入一条数据(增)

  LCPersonModel *model = [[LCPersonModel alloc] init];
  model.name = [NSString stringWithFormat:@"lc%d", (arc4random() % 100)];
  model.gender = arc4random() % 2;
  model.age = arc4random() % 80;
  model.floatNumber = (arc4random() % 20) / 100.0;
  model.doubleNumber = (arc4random() % 20) / 100.0;
  model.isMan = arc4random() % 2;
  model.number = @(arc4random() % 10);
            
  YIIFMDB *db = [YIIFMDB shareDatabase];
  BOOL isSuccess = [db insertWithModel:model tableName:tableName];  //插入一条数据
  [db insertWithModels:@[model] tableName:tableName];     // 批量插入数据

删除数据(删)

-(BOOL)deleteFromTable:(NSString * _Nonnull)tableName whereParameters:(YIIParameters *)parameters; // 根据参数删除一条数据,YIIParameters参考上面
-(BOOL)deleteAllDataFromTable:(NSString * _Nonnull)tableName; // 删除表中的所有数据

 YIIFMDB *db = [YIIFMDB shareDatabase];
 YIIParameters *parameters = [[YIIParameters alloc] init];
 // db.primaryKey 是数据库的主键,这条语句意思是删除主键 = 1的那条数据
 [parameters andWhere:db.primaryKey value:@"1" relationType:YIIParametersRelationTypeEqualTo];
 [db deleteFromTable:tableName whereParameters:parameters];

更改数据(改)

-(BOOL)updateTable:(NSString * _Nonnull)tableName dictionary:(NSDictionary * _Nonnull)dictionary whereParameters:(YIIParameters *)parameters; // 更新一条数据

  YIIFMDB *db = [YIIFMDB shareDatabase];
  YIIParameters *parameters = [[YIIParameters alloc] init];
  // 参数设置为主键 = 10
  [parameters andWhere:db.primaryKey value:@"10" relationType:YIIParametersRelationTypeEqualTo];
  // 将主键为10的那条数据的name更改为monkey
  [db updateTable:tableName dictionary:@{@"name": @"monkey"} whereParameters:parameters];

查询数据

-(NSArray *)queryFromTable:(NSString * _Nonnull)tableName model:(Class _Nonnull)modelClass whereParameters:(YIIParameters *)parameters; // 根据YIIParameters条件从表为tableName的查询数据

  YIIFMDB *db = [YIIFMDB shareDatabase];
  YIIParameters *parameters = [[YIIParameters alloc] init];
  [parameters andWhere:db.primaryKey value:@"5" relationType:YIIParametersRelationTypeLessThan];
  NSLog(@"主键小于5的数据:%@", [db queryFromTable:tableName model:[LCPersonModel class] whereParameters:parameters]);

除了增删改查之外,YIIFMDB还提供了增加一个属性,删除一张表,获取表中所有字段名,获取表中数据个数,表是否存在,求和,求平均值,最大值,最小值等功能,详情请参考YIIFMDB的文档。

线程安全操作(队列和事务)

由于FMDB本身就是是不安全的,上面的方法也是不安全的,为了保证其安全则需要结合队列和事务操作,参考FMDB的队列和事务。

-(void)inDatabase:(dispatch_block_t)block; // 将数据库相关操作写在block里可保证线程安全

  YIIFMDB *db = [YIIFMDB shareDatabase];
   [db inDatabase:^{
       // 增删改查放在此代码块里执行则可以保证线程安全
   }];

-(void)inTransaction:(void(^)(BOOL *rollback))block; // 在block里写入代码可执行回滚操作

  YIIFMDB *db = [YIIFMDB shareDatabase];
  [db inTransaction:^(BOOL *rollback) {
  // 如果某一个操作失误,则可以执行回滚操作
  BOOL isSuccess = YES;   // 数据库操作是否操作成功
  if (!isSuccess) {
      *rollback = YES;  //  回滚操作
                    
      return ;
     }
  }];

这里还有两个缺陷:

  • 未支持联表查询
  • 未支持Model当中套Model的插入。

如果是联表查询的话,那么需要获取到YIIFMDB单例的"currentDatabase"来实现联表查询,而Model套Model的,则最好是创建两张表。

目前YIIFMDB已支持Cocoapods,地址:Github。(不要吝啬你的star)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,937评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,503评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,712评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,668评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,677评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,601评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,975评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,637评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,881评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,387评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,971评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2 342