FMDB浅析

Posted 2020-08-12

一、FMDB介绍

FMDB是一种第三方的开源库，FMDB就是对SQLite的API进行了封装，加上了面向对象的思想，让我们不必使用繁琐的C语言API函数，比起直接操作SQLite更加方便。

FMDB优点：

• 使用起来更加面向对象，省去了很多麻烦、冗余的C语言代码
• 对比苹果自带的CoreData框架，更加轻量级和灵活
• 提供多线程安全，有效地防止数据混乱，原来的SQLite不是线程安全的

FMDB缺点：

               因为是OC语言封装的，失去了SQLite原来的跨平台性

我们要使用FMDB需要的步骤：

1. 项目中添加libsqlite3库的依赖
2. 导入FMDB源码：
   下载FMDB的源代码，将代码文件拖入工程
3. #import导入FMDB的头文件"FMDatabase.h"

二、FMDB使用

使用FMDB前，需要先了解下3个主要类：

1. FMDatabase ： 一个单一的SQLite数据库，用于执行SQL语句。
2. FMResultSet ：执行查询一个FMDatabase结果集。
3. FMDatabaseQueue ：在多个线程来执行查询和更新时会使用这个类。

一般的FMDB数据库操作有：

1. 创建数据库
2. 打开数据库、关闭数据库
3. 执行更新的SQL语句
4. 执行查询的SQL语句

1.创建数据库

创建数据库使用到的是FMDatabase的类方法：

/*
 1. 如果该路径下已经存在该数据库，直接获取该数据库;
 2. 如果不存在就创建一个新的数据库;
 3. 如果传@""，会在临时目录创建一个空的数据库，当数据库关闭时，数据库文件也被删除;
 4. 如果传nil，会在内存中临时创建一个空的数据库，当数据库关闭时，数据库文件也被删除;
*/
+ (FMDatabase *)databaseWithPath:(NSString *)filePath;

下面是实例：

NSString *path = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory,NSUserDomainMask,YES).firstObject; 
NSString *filePath = [path stringByAppendingPathComponent:@"FMDB.db"];
FMDatabase *database = [FMDatabase databaseWithPath:filePath];

注意：这里创建数据库，并不会打开数据库，和SQLite有点区别

2. 打开数据库、关闭数据库

打开和关闭数据库很简单：

/* 打开数据库，成功返回YES，失败返回NO */
- (BOOL)open;
/* 关闭数据库，成功返回YES，失败返回NO */
- (BOOL)close;

3. 执行更新的SQL语句

在FMDB中，除查询以外的所有操作，都称为“更新”。
例如create、drop、insert、update、delete等SQL语句命令都是更新操作。

执行更新的SQL语句用到的常用方法：

/* 执行更新的SQL语句，字符串里面的"?"，依次用后面的参数替代，必须是对象，不能是int等基本类型 */
- (BOOL)executeUpdate:(NSString *)sql,... ;
/* 执行更新的SQL语句，可以使用字符串的格式化进行构建SQL语句 */
- (BOOL)executeUpdateWithFormat:(NSString*)format,... ;
/* 执行更新的SQL语句，字符串中有"?"，依次用arguments的元素替代 */
- (BOOL)executeUpdate:(NSString*)sql withArgumentsInArray:(NSArray *)arguments;

下面的4种使用等价：

/* 1. 直接使用完整的SQL更新语句 */
[database executeUpdate:@"insert into mytable(num,name,sex) values(0,‘liuting‘,‘m‘);"];

NSString *sql = @"insert into mytable(num,name,sex) values(?,?,?);";
/* 2. 使用不完整的SQL更新语句，里面含有待定字符串"?"，需要后面的参数进行替代 */
[database executeUpdate:sql,@0,@"liuting",@"m"];
/* 3. 使用不完整的SQL更新语句，里面含有待定字符串"?"，需要数组参数里面的参数进行替代 */
[database executeUpdate:sql 
   withArgumentsInArray:@[@0,@"liuting",@"m"]];

/* 4. SQL语句字符串可以使用字符串格式化，这种我们应该比较熟悉 */
[database executeUpdateWithFormat:@"insert into mytable(num,name,sex) values(%d,%@,%@);",0,@"liuting","m"];

使用实例：

- (BOOL)createTable {
    NSString *sqlStr = @"create table mytable(num integer,name varchar(7),sex char(1),primary key(num));";
    BOOL res = [_database executeUpdate:sqlStr];
    if (!res) {
        NSLog(@"error when creating database table");
        [_database close];
    }
    return res;
}

4. 执行查询的SQL语句

查询SQL语句一般指select

下面是常用实现方法：

/* 执行查询SQL语句，返回FMResultSet查询结果 */
- (FMResultSet *)executeQuery:(NSString*)sql, ... ;
- (FMResultSet *)executeQueryWithFormat:(NSString*)format, ... ;
- (FMResultSet *)executeQuery:(NSString *)sql withArgumentsInArray:(NSArray *)arguments;

处理结果FMResultSet的常用方法：

/* 获取下一个记录 */
- (BOOL)next;
/* 获取记录有多少列 */
- (int)columnCount;
/* 通过列名得到列序号，通过列序号得到列名 */
- (int)columnIndexForName:(NSString *)columnName;
- (NSString *)columnNameForIndex:(int)columnIdx;
/* 获取存储的整形值 */
- (int)intForColumn:(NSString *)columnName;
- (int)intForColumnIndex:(int)columnIdx;
/* 获取存储的长整形值 */
- (long)longForColumn:(NSString *)columnName;
- (long)longForColumnIndex:(int)columnIdx;
/* 获取存储的布尔值 */
- (BOOL)boolForColumn:(NSString *)columnName;
- (BOOL)boolForColumnIndex:(int)columnIdx;
/* 获取存储的浮点值 */
- (double)doubleForColumn:(NSString *)columnName;
- (double)doubleForColumnIndex:(int)columnIdx;
/* 获取存储的字符串 */
- (NSString *)stringForColumn:(NSString *)columnName;
- (NSString *)stringForColumnIndex:(int)columnIdx;
/* 获取存储的日期数据 */
- (NSDate *)dateForColumn:(NSString *)columnName;
- (NSDate *)dateForColumnIndex:(int)columnIdx;
/* 获取存储的二进制数据 */
- (NSData *)dataForColumn:(NSString *)columnName;
- (NSData *)dataForColumnIndex:(int)columnIdx;
/* 获取存储的UTF8格式的C语言字符串 */
- (const unsigned cahr *)UTF8StringForColumnName:(NSString *)columnName;
- (const unsigned cahr *)UTF8StringForColumnIndex:(int)columnIdx;
/* 获取存储的对象，只能是NSNumber、NSString、NSData、NSNull */
- (id)objectForColumnName:(NSString *)columnName;
- (id)objectForColumnIndex:(int)columnIdx;

使用实例：

- (NSArray *)getResultFromDatabase{
    //执行查询SQL语句，返回查询结果
    FMResultSet *result = [_database executeQuery:@"select * from mytable"];
    NSMutableArray *array = [NSMutableArray array];
    //获取查询结果的下一个记录
    while ([result next]) {
        //根据字段名，获取记录的值，存储到字典中
        NSMutableDictionary *dict = [NSMutableDictionary dictionary];
        int num  = [result intForColumn:@"num"];
        NSString *name = [result stringForColumn:@"name"];
        NSString *sex  = [result stringForColumn:@"sex"];
        dict[@"num"] = @(num);
        dict[@"name"] = name;
        dict[@"sex"] = sex;
        //把字典添加进数组中
        [array addObject:dict];
    }
    return array;
}

三、 多线程安全FMDatabaseQueue

FMDatabase这个类是线程不安全的，如果在多个线程同时使用一个FMDatabase实例，会造成数据混乱问题。
为了保证线程安全，FMDB提供方便快捷的FMDatabaseQueue类，要使用这个类，需要#import导入头文件"FMDatabaseQueue.h"，FMDatabaseQueue类的操作很多都和FMDatabase很相似

1. 创建

NSString *path = NSSearchPathForDirectoriesInDomains(NSDocumentDirectory,NSUserDomainMask,YES).firstObject; 
NSString *filePath = [path stringByAppendingPathComponent:@"FMDB.db"];
FMDatabaseQueue *queue = [FMDatabaseQueue databaseQueueWithPath:path];

2. 操作数据库

[queue inDatabase:^(FMDatabase*db) {
    //FMDatabase数据库操作
}];

使用实例：

[queue inDatabase:^(FMDatabase*db) {
    //插入记录到表中
    NSString *sqlStr = @"insert into mytable(num,name,sex) values(4,‘xiaoming‘,‘m‘);";
    BOOL result = [db executeUpdate:sqlStr];
    if (!result) {
        NSLog(@"error when insert into database table");
        [db close];
    }
}];

四、 事务

事务，是指作为单个逻辑工作单元执行的一系列操作，要么完整地执行，要么完全地不执行。

想象一个场景，比如你要更新数据库的大量数据，我们需要确保所有的数据更新成功，才采取这种更新方案，如果在更新期间出现错误，就不能采取这种更新方案了，如果我们不使用事务，我们的更新操作直接对每个记录生效，万一遇到更新错误，已经更新的数据怎么办？难道我们要一个一个去找出来修改回来吗？怎么知道原来的数据是怎么样的呢？这个时候就需要使用事务实现。

之所以将事务放到FMDB中去说并不是因为只有FMDB才支持事务，而是因为FMDB将其封装成了几个方法来调用，不用自己写对应的SQL而已。

SQLite进行事务的SQL语句：

只要在执行SQL语句前加上以下的SQL语句，就可以使用事务功能了：
开启事务的SQL语句，"begin transaction;"
进行提交的SQL语句，"commit transaction;"
进行回滚的SQL语句，"rollback transaction;"

只有事务提交了，开启事务期间的操作才会生效

FMDatabase使用事务的方法：

//事务 
-(void)transaction {
    // 开启事务
    [self.database beginTransaction]; 
    BOOL isRollBack = NO; 
    @try { 
        for (int i = 0; i<500; i++) { 
            NSNumber *num = @(i+1); 
            NSString *name = [[NSString alloc] initWithFormat:@"student_%d",i]; 
            NSString *sex = (i%2==0)?@"f":@"m";
            NSString *sql = @"insert into mytable(num,name,sex) values(?,?,?);"; 
            BOOL result = [database executeUpdate:sql,num,name,sex]; 
            if ( !result ) { 
                NSLog(@"插入失败！");
                return; 
            } 
        } 
    } 
    @catch (NSException *exception) { 
        isRollBack = YES; 
        // 事务回退
        [self.database rollback]; 
    } 
    @finally { 
        if (!isRollBack) { 
            //事务提交
            [self.database commit]; 
        } 
    } 
}

FMDatabaseQueue使用事务的方法：

//多线程事务 
- (void)transactionByQueue { 
    //开启事务
    [self.queue inTransaction:^(FMDatabase *db, BOOL *rollback) {
         for (int i = 0; i<500; i++) { 
            NSNumber *num = @(i+1); 
            NSString *name = [[NSString alloc] initWithFormat:@"student_%d",i]; 
            NSString *sex = (i%2==0)?@"f":@"m";
            NSString *sql = @"insert into mytable(num,name,sex) values(?,?,?);"; 
            BOOL result = [db executeUpdate:sql,num,name,sex]; 
            if ( !result ) { 
                //当最后*rollback的值为YES的时候，事务回退，如果最后*rollback为NO，事务提交
                *rollback = YES;
                 return; 
            } 
        }
     }]; 
}

发现一个很好的关于FMDB文档《FMDB类的说明文档》，里面虽然是英文的，但是列出了所有的FMDB类的方法，很棒！下面是截图：

以上是关于FMDB浅析的主要内容，如果未能解决你的问题，请参考以下文章

浅析 Python 模块

浅析普通函数与构造函数

浅析XSS的几种测试方法

IOS FMDB

FMDB基本操作

FMDB数据库队列