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(数量限制)

其中的and和or又要配置“>,<,=,>=,<=,!=,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）