iOS开发数据库-FMDB

前言

FMDB是以OC的方式封装了SQLite的C语言API，使用起来更加面向对象，省去了很多麻烦、冗余的C语言代码；对比苹果自带的Core Data框架，更加轻量级和灵活；提供了多线程安全的数据库操作方法，有效地防止数据混乱；FMDB同时兼容ARC和非ARC工程，在编译的时候会自动根据工程配置来调整相关的内存管理代码。

使用方法

FMDB有三个主要的类

• FMDatabase 表示一个单独的SQLite数据库。 用来执行SQLite的命令。
• FMResultSet 表示FMDatabase执行查询后的结果集
• FMDatabaseQueue 如果你想在多线程中执行多个查询或更新，你应该使用该类。这是线程安全的。

数据库创建

通过指定SQLite数据库文件路径来创建FMDatabase对象

FMDatabase *db = [FMDatabase databaseWithPath:path];
if (![db open]) {
  NSLog(@"数据库打开失败！");
}

创建FMDatabase对象时参数为SQLite数据库文件路径。该路径可以是以下三种之一：

1、具体文件路径

• 该文件路径无需真实存，如果不存在会自动创建。

2、空字符串@""

• 表示会在临时目录创建一个空的数据库，当FMDatabase 链接关闭时，数据库文件也被删除。

3、NULL

• 会创建一个内存中临时数据库，当FMDatabase连接关闭时，数据库会被销毁

打开数据库

在和数据库交互 之前，数据库必须是打开的。如果资源或权限不足无法打开或创建数据库，都会导致打开失败，返回BOOL类型

if (![db open]) {
        [db release];
        return;
 }

执行更新

• 一切不是SELECT命令的命令都视为更新。这包括 CREATE, UPDATE, INSERT,ALTER,COMMIT, BEGIN, DETACH, DELETE, DROP, END, EXPLAIN, VACUUM, and REPLACE （等）。
  简单来说，只要不是以SELECT开头的命令都是UPDATE命令。
• 执行更新返回一个BOOL值。YES表示执行成功，否则表示有那些错误 。你可以调用 -lastErrorMessage 和 -lastErrorCode方法来得到更多信息。

使用executeUpdate:方法执行更新

- (BOOL)executeUpdate:(NSString*)sql, ...
- (BOOL)executeUpdateWithFormat:(NSString*)format, ...
- (BOOL)executeUpdate:(NSString*)sql withArgumentsInArray:(NSArray *)arguments

示例

[db executeUpdate:@"UPDATE t_student SET age = ? WHERE name = ?;", @20, @"Jack"]

执行查询

SELECT命令就是查询，执行查询的方法是以 -excuteQuery开头的。

查询方法

- (FMResultSet *)executeQuery:(NSString*)sql, ...
- (FMResultSet *)executeQueryWithFormat:(NSString*)format, ...
- (FMResultSet *)executeQuery:(NSString *)sql withArgumentsInArray:(NSArray *)arguments

执行查询时，如果成功返回FMResultSet对象， 错误返回nil. 与执行更新相当，支持使用 NSError**参数。同时，你也可以使用 -lastErrorCode和-lastErrorMessage获知错误信息。

为了遍历查询结果，你可以使用while循环。你还需要知道怎么跳到下一个记录。使用FMDB，很简单实现，就像这样：

FMResultSet *s = [db executeQuery:@"SELECT * FROM myTable"];
while ([s next]) {
    //retrieve values for each record
}

你必须一直调用 -[FMResultSet next] 在你访问查询返回值之前，甚至你只想要一个记录：

FMResultSet *s = [db executeQuery:@"SELECT COUNT(*) FROM myTable"];
if ([s next]) {
    int totalCount = [s intForColumnIndex:];
}

FMResultSet 提供了很多方法来获得所需的格式的值：

intForColumn:
longForColumn:
longLongIntForColumn:
boolForColumn:
doubleForColumn:
stringForColumn:
dataForColumn:
dataNoCopyForColumn:
UTF8StringForColumnIndex:
objectForColumn:

这些方法也都包括 {type}ForColumnIndex 的这样子的方法，参数是查询结果集的列的索引位置。
你无需调用 [FMResultSet close]来关闭结果集, 当新的结果集产生，或者其数据库关闭时，会自动关闭。

关闭数据库

当使用完数据库，你应该 -close 来关闭数据库连接来释放SQLite使用的资源。
[db close];

使用FMDatabaseQueue 及线程安全

在多个线程中同时使用一个FMDatabase实例是不明智的。现在你可以为每个线程创建一个FMDatabase对象。 不要让多个线程分享同一个实例，它无法在多个线程中同时使用。 若此，坏事会经常发生，程序会时不时崩溃，或者报告异常，或者陨石会从天空中掉下来砸到你Mac Pro. 总之很崩溃。所以，不要初始化FMDatabase对象，然后在多个线程中使用。请使用 FMDatabaseQueue，它是你的朋友而且会帮助你。以下是使用方法：
首先创建队列

FMDatabaseQueue *queue = [FMDatabaseQueue databaseQueueWithPath:aPath];

这样使用

[queue inDatabase:^(FMDatabase *db) {
      [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:]];
      [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:]];
      [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:]];
      FMResultSet *rs = [db executeQuery:@"select * from foo"];
      while([rs next]) {
         …
      }
}];

像这样，轻松地把简单任务包装到事务里

[queue inTransaction:^(FMDatabase *db, BOOL *rollback) {
        [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:]];
        [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:]];
        [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:]];
        if (whoopsSomethingWrongHappened) {
                *rollback = YES; return;
        }
        // etc…
        [db executeUpdate:@"INSERT INTO myTable VALUES (?)", [NSNumber numberWithInt:]];
}];

FMDatabaseQueue将运行在一个序列化队列块。所以如果你从多个线程在同一时间调用FMDatabaseQueue的方法，他们将执行他们收到的指令。这样查询和更新不会相互影响，每一个都是快乐的。

代码示例

FMDBDataBase.h

//  FMDBDataBase.h
#import <Foundation/Foundation.h>
@interface FMDBDataBase : NSObject

// 获取数据库管理对象单例的方法
+ (FMDBDataBase *)sharedDataBase;
// 关闭数据库
- (void)closeDataBase;
// 清空数据库
- (BOOL)deleteDataBase;
// 向搜索记录表中插入新纪录
- (BOOL)insertSearchText:(NSString *)searchText;
// 查询数据库中是否包含当前搜索记录
- (BOOL)isExistSearchText:(NSString *)searchText;
// 获取所有搜素记录
- (NSMutableArray *)getAllSearchText;
// 删除所有搜索记录
- (BOOL)deleteAllSearchText;

@end

FMDBDataBase.m

#import "FMDBDataBase.h"
#import "FMDB.h"

@interface FMDBDataBase ()

@property (nonatomic, strong) FMDatabase *fmDataBase;

@end
@implementation FMDBDataBase

+ (FMDBDataBase *)sharedDataBase
{
    static FMDBDataBase *fmdbDataBase = nil;
    static dispatch_once_t onceToken;
    dispatch_once(&onceToken, ^{
        fmdbDataBase = [[FMDBDataBase alloc] init];
    });
    return fmdbDataBase;
}

- (instancetype)init
{
    if (self = [super init]) {
        _fmDataBase = [FMDatabase databaseWithPath:[self getDataBasePath]];
        // 如果数据库打开失败返回空值
        if (![_fmDataBase open]) {
            return nil;
        }
    }
    // 如果数据库打开成功 创建表
    // 创建搜索历史记录表
    NSString *searchHistorySql = @"CREATE TABLE IF NOT EXISTS t_history(t_id integer PRIMARY KEY AUTOINCREMENT, searchText text NOT NULL, age integer NOT NULL)";
    BOOL isSuc = [_fmDataBase executeUpdate:searchHistorySql];

    if (isSuc) {
        NSLog(@"创建成功！");
    }
    return self;
}

- (NSString *)getDataBasePath
{
    // 1.获得数据库文件的路径
    NSString *doc = [NSSearchPathForDirectoriesInDomains(NSDocumentDirectory, NSUserDomainMask, YES) lastObject];
//    NSString *doc = [NSHomeDirectory() stringByAppendingPathComponent:@"Documents"];
    NSString *fileName = [doc stringByAppendingPathComponent:@"fmdb.sqlite"];
    return fileName;
}

// 清空数据库
- (BOOL)deleteDataBase
{
    NSString *sql = @"DELETE FROM t_history";
    BOOL isSuc = [_fmDataBase executeUpdate:sql];
    if (isSuc) {
        NSLog(@"删除成功");
        return YES;
    }
    NSLog(@"删除失败");
    return NO;
}

// 关闭数据库
- (void)closeDataBase
{
    if (_fmDataBase) {
        [_fmDataBase close];
    }
}

// 查询数据库中是否包含当前搜索记录
- (BOOL)isExistSearchText:(NSString *)searchText
{
    NSString *sql = @"SELECT * FROM t_history";
    FMResultSet *results = [_fmDataBase executeQuery:sql];
    while (results.next) {
        if ([searchText isEqualToString:[results stringForColumn:@"searchText"]]) {
            return YES;
        }
    }
    return NO;
}

// 搜索记录表中插入新记录
- (BOOL)insertSearchText:(NSString *)searchText
{
    if (!searchText || [searchText isEqualToString:@""] || [self isExistSearchText:searchText]) {
        NSLog(@"数据为空或已存在");
        return NO;
    }
    NSString *sql = @"INSERT INTO t_history(searchText) VALUES (?)";
   // executeUpdate : 不确定的参数用?来占位
    BOOL isInsertSuc = [_fmDataBase executeUpdate:sql, searchText];
    if (isInsertSuc) {
        NSLog(@"%@插入成功", searchText);
        return YES;
    }
    NSLog(@"%@插入失败", searchText);
    return NO;
}

// 获取所有的搜索记录
- (NSMutableArray *)getAllSearchText
{
    NSString *sql = @"SELECT * FROM t_history order by t_id desc";
    // 保存所有数据的数组
    NSMutableArray *searchTests = [NSMutableArray array];
    FMResultSet *results = [_fmDataBase executeQuery:sql];
    while (results.next) {
        NSString *result = [results stringForColumn:@"searchText"];
        [searchTests addObject:result];
    }
    return searchTests;
}

// 删除所有的搜索记录
- (BOOL)deleteAllSearchText
{
    NSString *sql = @"DELETE FROM t_history";
    BOOL isDeleteSuc = [_fmDataBase executeUpdate:sql];
    if (isDeleteSuc) {
        NSLog(@"删除成功");
        return YES;
    }
    return NO;
}

@end

注意

• 如果ID设置为逐渐，且设置为自动增长的话，那么把表中的数据删除后，重新插入新的数据，ID的编号不是从0开始，而是接着之前的ID进行编号。

参考文章

• FMDB官方使用文档（翻译）
• iOS开发数据库篇—FMDB简单介绍

欢迎阅读上一篇：

• iOS数据存储之归档
• iOS数据存储之偏好设置和属性列表

iOS-Ant-Bang互助社区 426981364
iOS技术交流群 461069757 欢迎加入！