FMDB封裝

b10l07發表於2017-11-24

一些FMDB封裝框架功能比較多，程式碼量也比較大，但是很多功能不常用，因而自行封裝一個適用於手頭專案的輕量級小框架。
因為專案需要在多執行緒下運算元據庫，所以只基於FMDatabaseQueue進行了封裝。

FMDB簡單二次封裝
執行緒安全
支援事務操作
支援模型儲存，但不支援集合型別、自定義類型別屬性等等。（支援NSString、NSNumber、NSInteger 、BOOL、int、float、 double、NSData等簡單型別屬性）

1.資料庫的建立

+ (instancetype)shareDB;

+ (instancetype)shareDB:(NSString *)dbName;

+ (instancetype)shareDB:(NSString *)dbName dbPath:(NSString *)dbpath;

三個單例方法，dbName為資料庫名，引數如果為nil，那麼就會建立一個名為XiaoYa.sqlite的資料庫檔案；如果 dbpath 為子路徑名，若引數為nil，那麼就預設在NSDocumentDirectory下建立資料庫檔案。如使用shareDB方法建立，則預設在NSDocumentDirectory下建立XiaoYa.sqlite。
使用這三個方法中任意一個建立資料庫，之後再使用三個方法中任意一個都會會的同一個例項。

@property (nonatomic ,strong) HXDBManager *hxdb;

self.hxdb = [HXDBManager shareDB];
self.hxdb = [HXDBManager shareDB:@"HXDB.sqlite"];
//在hxDataBasePath/hxDataBasePath路徑下建立HXDB.sqlite
self.hxdb = [HXDBManager shareDB:@"HXDB.sqlite" dbPath:@"hxDataBasePath"];

2.切換資料庫

考慮到有使用者退出登入、切換到另一個使用者賬號的情況，每一個使用者需要單獨一份資料，所以需要切換資料庫。

- (void)changeFilePath:(NSString *)path dbName:(NSString *)dbName;

path引數是檔案子路徑，dbName是資料庫名。

[self.hxdb changeFilePath:[Utils HXNSStringMD5:appDelegate.userid] dbName:@"XiaoYa.sqlite"];

3.建立表

方式1：根據sql語句建立表

/**
根據sql語句建立表

 @param sql SQL語句
 @param tableName 表名
 @return 建立表是否成功
 */
- (BOOL)tableCreate:(NSString *)sql table:(NSString *)tableName;

[self.hxdb tableCreate:@"CREATE TABLE IF NOT EXISTS memberGroupRelation (memberId TEXT,groupId TEXT, FOREIGN KEY(groupId) REFERENCES groupTable(groupId) ON DELETE CASCADE);" table:@"memberGroupRelation"];

方式2：根據字典建立表
字典key：欄位名，字典value：欄位型別。可以指定主鍵欄位名，如果不需要主鍵 pk 引數傳入nil即可。

/**
 根據字典建立表

 @param tableName 表名
 @param dict 字典，key 欄位名、value 欄位型別
 @param pk 主鍵，可為nil
 @return 是否成功
 */
- (BOOL)createTable:(NSString *)tableName colDict:(NSDictionary *)dict primaryKey:(NSString *)pk;

[self.hxdb createTable:groupTable colDict:@{@"groupId":@"TEXT",@"groupName":@"TEXT",@"groupAvatarId":@"TEXT",@"numberOfMember":@"TEXT",@"groupManagerId":@"TEXT",@"deleteFlag":@"INTEGER"} primaryKey:@"groupId"];

方式3：根據模型建立表，欄位名就是對應模型的屬性名

/**
 根據模型類建立表

 @param tableName 表名
 @param cls 模型類
 @param pk 主鍵，可為nil
 @param colArr 模型中不需要作為表欄位的屬性
 @return 建立表是否成功
 */
- (BOOL)createTable:(NSString *)tableName modelClass:(Class)cls primaryKey:(NSString *)pk excludeProperty:(NSArray *)colArr;

模型類：
@interface Person : NSObject
@property (nonatomic, copy) NSString *name;
@property (nonatomic, strong) NSNumber *phone;
@property (nonatomic, strong) NSData *userData;
@property (nonatomic, assign) NSInteger identity;
@property (nonatomic, assign) BOOL sex;
@property (nonatomic, assign) int age;
@property (nonatomic, assign) float height;  //可能會丟失精度
@property (nonatomic, assign) double weight;

@property (nonatomic, strong)NSDictionary *testDic;

@end

建立表：
 [self.hxdb createTable:@"modelTable" modelClass:NSClassFromString(@"Person") primaryKey:@"identity" excludeProperty:nil];

要注意，NSDictionary這種集合型別的屬性不會作為表欄位，除此之外還有NSArray、NSSet等集合型別。

4.刪除表

/**
 刪除表

 @param tableName 表名
 @param block 刪除失敗回撥
 */
- (void)dropTable:(NSString *)tableName callback:(void(^)(NSError *error ))block;

[self.hxdb dropTable:@"modelTable" callback:^(NSError *error) {
        NSLog(@"error");
    }];

5.0增刪改資料

直接傳入sql語句進行增刪查改

/**
 直接傳入sql語句進行增刪查改

 @param sql SQL語句
 @param block 回撥
 */
- (void)updateWithSqlStat:(NSString *)sql callback:(void(^)(NSError *error ))block;
//批量版本
- (void)updateWithSqlStatInTransaction:(NSArray <NSString *> *)sqlArr callback:(void(^)(NSError *error))block;

5.1插入資料

1.插入單個模型

/**
 插入單個模型

 @param tableName 表名
 @param model 模型物件
 @param colArr 模型中不需要插入到表的屬性名集合
 @param block 回撥
 */
- (void)insertTable:(NSString *)tableName model:(id)model excludeProperty:(NSArray *)colArr callback:(void(^)(NSError *error ))block;

Person *person = [[Person alloc] init];
    person.name = @"PersonName";
    person.phone = @(12345667890);
    person.userData = [@"testData" dataUsingEncoding:NSUTF8StringEncoding];
    person.identity = 60;
    person.sex = 1;
    person.age = 23;
    person.height = 170.1;
    person.weight = 233.33333;
    person.testDic = [NSDictionary dictionary];
//插入一個模型物件的資料，其中weight和height屬性不需要被插入
    [self.hxdb insertTable:@"modelTable" model:person excludeProperty:@[@"height",@"weight"] callback:^(NSError *error) {
        NSLog(@"%@",error);
    }];

2.批量插入模型

/**
 批量插入模型

  @param tableName 表名
 @param modelArr 模型物件陣列
 @param colArr 一一對應模型物件陣列中的每一元素，模型物件中不需要插入到表的屬性名集合。需要程式設計師自行管理一一對應的關係，如果某模型物件沒有要剔除的屬性，則對應的excludeArr為空陣列即可；如果所有模型物件都不需要剔除某些屬性，則excludeProperty傳入nil即可。
 @param block （失敗）回撥
 */
- (void)insertTableInTransaction:(NSString *)tableName modelArr:(NSArray <id>*)modelArr excludeProperty:(NSArray <NSArray *>*)colArr callback:(void(^)(NSError *error ))block;

    //一組資料
    NSMutableArray *testModelArr = [NSMutableArray arrayWithCapacity:0];
//所有待插入模型物件中不需要插入到表的屬性名集合
    NSMutableArray *exclude = [NSMutableArray arrayWithCapacity:0];
    for (int i = 0; i < 3; i++) {
        Person *person = [[Person alloc] init];
        person.name = @"PersonName";
        person.phone = @(12345667890);
        person.userData = [@"testData" dataUsingEncoding:NSUTF8StringEncoding];
        person.identity = arc4random() % 1000;
        person.sex = 1;
        person.age = 23;
        person.height = 170.1;
        person.weight = 233.33333;
        person.testDic = [NSDictionary dictionary];
        
        [testModelArr addObject:person];
        
        [exclude addObject:@[@"height",@"weight"]];
    }
    [self.hxdb insertTableInTransaction:@"modelTable" modelArr:testModelArr excludeProperty:exclude callback:^(NSError *error) {
        NSLog(@"%@",error);;
    }];

關於excludeProperty：需要程式設計師自行管理一一對應的關係，如果某模型物件沒有要剔除的屬性，則對應的excludeArr為空陣列即可，比如[exclude addObject:@[]];；如果所有模型物件都不需要剔除某些屬性，則excludeProperty傳入nil即可。

3.插入單條記錄

/**
 插入單條記錄

 @param tableName 表名
 @param paraDict 待插入資料。字典key：欄位名，value：欄位值
 @param block 回撥
 */
- (void)insertTable:(NSString *)tableName param:(NSDictionary *)paraDict callback:(void(^)(NSError *error ))block;

NSDictionary *paraDict = @{@"name":@"commet",@"phone":@"13535230987",@"identity":@"999"};
    
    [self.hxdb insertTable:@"modelTable" param:paraDict callback:^(NSError *error) {
        if(error) NSLog(@"插入表失敗：%@",error);
    }];

4.批量插入記錄

/**
 批量插入記錄

 @param tableName 表名
 @param paraArr 待插入資料陣列。陣列每個元素是字典，字典構成同上。
 @param block 回撥
 */
- (void)insertTableInTransaction:(NSString *)tableName paramArr:(NSArray <NSDictionary *>*)paraArr callback:(void(^)(NSError *error))block;

5.2更新資料

1.更新指定模型資料

/**
 更新單個模型

 @param tableName 表名
 @param model 模型物件
 @param colArr 模型中不需要更新的屬性名集合
 @param where where子句字典。key:where子句遵循繫結語法，value：繫結值陣列。比如“where name = 'John' AND age = '17'” -> @{@"WHERE name = ? AND age = ?":@[@"John",@"17"]}。要保證where字典有且僅有一組key-value
 @param block 回撥
 */
- (void)updateTable:(NSString *)tableName model:(id)model excludeProperty:(NSArray *)colArr whereDict:(NSDictionary *)where callback:(void(^)(NSError *error ))block;

根據模型物件更新資料，其中name、userData、identity、age屬性不需要更新。如果where傳入nil，則對每條記錄都進行更新。

//根據模型物件更新資料，其中name、userData、identity、age屬性不需要更新
[self.hxdb updateTable:@"modelTable" model:person excludeProperty:@[@"name",@"userData",@"identity",@"age"] whereDict:@{@"where identity = ?" : @[@60]} callback:^(NSError *error) {
        NSLog(@"%@",error);
    }];

2.批量更新模型資料

/**
 批量更新模型

 @param tableName 表名
 @param modelArr 模型物件集合
 @param colArr 一一對應模型物件陣列中的每一元素，模型物件中不需要更新的屬性名集合
 @param whereArr where子句字典的集合。where子句字典 -- key:where子句遵循繫結語法，value：繫結值陣列。比如“where name = 'John' AND age = '17'” -> @{@"WHERE name = ? AND age = ?":@[@"John",@"17"]}。要保證where字典有且僅有一組key-value
 @param block 回撥
 */
- (void)updateTableInTransaction:(NSString *)tableName modelArr:(NSArray <id>*)modelArr excludeProperty:(NSArray <NSArray *>*)colArr whereArrs:(NSArray<NSDictionary *> *)whereArr callback:(void (^)(NSError *))block;

要注意此處where子句（字典）必須和模型一一對應且必須不能為空。由於這個方法是對同一個表進行批量更新，如果有其中一個沒有where子句（就會更新整表），那麼批量更新就沒意義了

    NSMutableArray *testModelArr = [NSMutableArray arrayWithCapacity:0];
    NSMutableArray *exclude = [NSMutableArray arrayWithCapacity:0];
    NSMutableArray *whereArr = [NSMutableArray arrayWithCapacity:0];
    for (int i = 0; i < 3; i++) {
        Person *person = [[Person alloc] init];
        person.name = @"PersonName";
        person.phone = @(11111111);
        person.userData = [@"testData" dataUsingEncoding:NSUTF8StringEncoding];
        person.identity = i+1;
        person.sex = 0;
        person.age = 24;
        person.height = 170.1;
        person.weight = 233.33333;
        person.testDic = [NSDictionary dictionary];

        [testModelArr addObject:person];

        [exclude addObject:@[@"height",@"weight"]];
        [whereArr addObject:@{@"where identity = ?" : @[[NSNumber numberWithInteger:person.identity]]}];
    }

    //批量更新模型
    [self.hxdb updateTableInTransaction:@"modelTable" modelArr:testModelArr excludeProperty:exclude whereArrs:whereArr callback:^(NSError *error) {
        NSLog(@"%@",error);
    }];

3.更新單個記錄

/**
 更新單個記錄

 @param tableName 表名
 @param paraDict 待更新資料。字典key：欄位名，value：欄位值
 @param where where子句字典。key:where子句遵循繫結語法，value：繫結值陣列。比如“where name = 'John' AND age = '17'” -> @{@"WHERE name = ? AND age = ?":@[@"John",@"17"]}。要保證where字典有且僅有一組key-value
 @param block 回撥
 */
- (void)updateTable:(NSString *)tableName param:(NSDictionary *)paraDict whereDict:(NSDictionary *)where callback:(void(^)(NSError *error ))block;

//更新單個記錄
    NSDictionary *paraDict = @{@"name":@"commet",@"phone":@"13535230987"};
    
    [self.hxdb updateTable:@"modelTable" param:paraDict whereDict:@{@"where identity = ?" : @[@1]} callback:^(NSError *error) {
        if(error) NSLog(@"%@",error);
    }];

4.批量更新記錄

/**
 批量更新記錄

 @param tableName 表名
 @param paraArr 待更新資料集合。陣列每個元素是字典，字典構成同上
 @param whereArr where子句字典的集合。where子句字典 -- key:where子句遵循繫結語法，value：繫結值陣列。比如“where name = 'John' AND age = '17'” -> @{@"WHERE name = ? AND age = ?":@[@"John",@"17"]}。要保證where字典有且僅有一組key-value
 @param block 回撥
 */
- (void)updateTableInTransaction:(NSString *)tableName paramArr:(NSArray <NSDictionary *>*)paraArr whereArrs:(NSArray <NSDictionary *>*)whereArr callback:(void(^)(NSError *error))block;

5.3刪除資料

1.刪除指定資料

/**
 刪除單條件記錄

 @param tableName 表名
 @param where where子句字典。key:where子句遵循繫結語法，value：繫結值陣列。比如“where name = 'John' AND age = '17'” -> @{@"WHERE name = ? AND age = ?":@[@"John",@"17"]}。要保證where字典有且僅有一組key-value
 @param block 回撥
 */
- (void)deleteTable:(NSString *)tableName whereDict:(NSDictionary *)where callback:(void(^)(NSError *error))block;

如果where為空就刪除整表資料

[self.hxdb deleteTable:@"modelTable" whereDict:@{@"where age = ?" : @[@24]} callback:^(NSError *error) {
        if(error) NSLog(@"%@",error);
    }];

2.批量刪除資料

/**
 批量刪除不同條件的記錄

 @param tableName 表名
 @param whereArrs where子句字典的集合。where子句字典 -- key:where子句遵循繫結語法，value：繫結值陣列。比如“where name = 'John' AND age = '17'” -> @{@"WHERE name = ? AND age = ?":@[@"John",@"17"]}。要保證where字典有且僅有一組key-value
 @param block 回撥
 */
- (void)deleteTableInTransaction:(NSString *)tableName whereArrs:(NSArray <NSDictionary *>*)whereArrs callback:(void(^)(NSError *error))block;

    //批量刪除
    NSMutableArray *deleteWhere = [NSMutableArray array];
    [deleteWhere addObject:@{@"where sex = ?" : @[@0]}];
    [deleteWhere addObject:@{@"where sex = ? and name = ?":@[@1,@"commet"]}];
    [deleteWhere addObject:@{@"where phone = ?" : @[@"305757732"]}];
    [self.hxdb deleteTableInTransaction:@"modelTable" whereArrs:deleteWhere callback:^(NSError *error) {
        
    }];

6.查詢

1.根據條件查詢有多少條記錄

/**
 根據條件查詢有多少條記錄

 @param tableName 表名
 @param where where子句字典。key:where子句遵循繫結語法，value：繫結值陣列。比如“where name = 'John' AND age = '17'” -> @{@"WHERE name = ? AND age = ?":@[@"John",@"17"]}。要保證where字典有且僅有一組key-value
 @return 記錄數目
 */
- (int)itemCountForTable:(NSString *)tableName whereDict:(NSDictionary *)where;

    int count = [self.hxdb itemCountForTable:@"modelTable" whereDict:@{@"where sex = ?" : @[@1]}];
    NSLog(@"count = %d",count);

2.根據模型類查詢

/**
 根據條件查詢模型

 @param tableName 表名
 @param cls 模型類
 @param colArr 模型中不需要被查詢的屬性名集合
 @param where where子句字典。key:where子句遵循繫結語法，value：繫結值陣列。比如“where name = 'John' AND age = '17'” -> @{@"WHERE name = ? AND age = ?":@[@"John",@"17"]}。要保證where字典有且僅有一組key-value
 @param block 回撥
 @return 查詢結果
 */
- (NSMutableArray *)queryTable:(NSString *)tableName modelClass:(Class)cls excludeProperty:(NSArray *)colArr whereDict:(NSDictionary *)where callback:(void(^)(NSError *error))block;

    NSMutableArray *rsArr = [self.hxdb queryTable:@"modelTable" modelClass:NSClassFromString(@"Person") excludeProperty:nil whereDict:nil callback:^(NSError *error) {
        
    }];
    NSLog(@"rs:%@",rsArr);

3.根據條件查詢

/**
 根據條件查詢

 @param tableName 表名
 @param columnDict 查詢欄位。字典：key 欄位名，value 欄位對應的sql資料型別
 @param where where子句字典。key:where子句遵循繫結語法，value：繫結值陣列。比如“where name = 'John' AND age = '17'” -> @{@"WHERE name = ? AND age = ?":@[@"John",@"17"]}。要保證where字典有且僅有一組key-value
 @param block 回撥
 @return 查詢結果
 */
- (NSMutableArray *)queryTable:(NSString *)tableName columns:(NSDictionary *)columnDict whereDict:(NSDictionary *)where callback:(void(^)(NSError *error))block;

查詢整表

/**
 查詢整表

 @param tableName 表名
 @param block 回撥
 @return 查詢結果
 */
- (NSMutableArray *)queryAll:(NSString *)tableName callback:(void(^)(NSError *error))block;

其他

一般為了防止ui卡死，把資料庫操作放在非同步執行緒。比如：

dispatch_async(dispatch_get_global_queue(0, 0), ^{
        NSMutableArray *rsArr = [self.hxdb queryTable:@"modelTable" modelClass:NSClassFromString(@"Person") excludeProperty:nil whereDict:nil callback:^(NSError *error) {
            
        }];
        NSLog(@"rs:%@",rsArr);
    });

github地址：https://github.com/huixinHu/HXDB

對FMDB物件導向封裝
2016-03-22
物件封裝
iOS 基於FMDB簡單封裝
2018-12-20
iOS封裝
FMDB 二次封裝，面向模型
2016-12-21
封裝模型
FMDB 二次封裝工具類，讓你快速學會封裝，整合資料庫
2016-09-29
封裝資料庫
LLFMDB 高度封裝的FMDB 傻瓜式操作一鍵快取
2018-02-07
封裝快取
【封裝那些事】缺失封裝
2018-05-15
封裝
筆記-FMDB
2018-12-08
筆記
swift FMDB使用
2017-12-15
Swift
封裝
2020-12-12
封裝
【封裝小技巧】is 系列方法的封裝
2022-05-07
封裝
【JavaScript框架封裝】公共框架的封裝
2018-07-15
JavaScript框架封裝
Sqlite封裝1-基本封裝-SqliteTool
2017-08-02
SQLite封裝
Flutter 封裝：富文字 RichText 極簡封裝
2021-07-31
Flutter封裝
Dapper的封裝、二次封裝、官方擴充套件包封裝，以及ADO.NET原生封裝
2022-01-03
APP封裝套件
AVPlayer封裝
2019-03-05
封裝
ajax 封裝
2019-04-13
封裝
封裝OCX
2022-01-16
封裝
封裝介面
2018-11-07
封裝
sqlite封裝
2020-12-04
SQLite封裝
java封裝
2018-02-04
Java封裝
java 封裝
2018-04-12
Java封裝
EventBus封裝
2017-05-12
封裝
websocket封裝
2018-01-12
Web封裝
5.1封裝
2015-04-30
封裝
FMDB增刪改查
2017-12-15
【封裝小技巧】列表處理函式的封裝
2022-05-14
封裝函式
Flutter MVP 封裝
2020-03-27
FlutterMVP封裝
JavaScript 模組封裝
2020-08-07
JavaScript封裝
JS功能封裝
2020-08-17
JS封裝
ToolBar封裝策略
2019-03-04
封裝
svg sprite 封裝
2019-03-13
SVG封裝
request sdk 封裝
2019-07-09
封裝
09-封裝
2019-02-11
封裝
Java（三）封裝
2020-11-15
Java封裝
lua list 封裝
2022-09-02
封裝
TS MQTT封裝
2023-12-29
MQQT封裝
axios封裝
2020-10-14
iOS封裝
封裝axios
2020-09-29
封裝iOS