FMDB封裝

一些FMDB封裝框架功能比較多,代碼量也比較大,但是很多功能不常用,因而自行封裝一個適用于手頭項目的輕量級小框架。
因為項目需要在多線程下操作數據庫,所以只基于FMDatabaseQueue進行了封裝。

https://github.com/huixinHu/HXDB

  • 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;
  1. 查詢整表
/**
 查詢整表

 @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

?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,488評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,034評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,327評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,554評論 1 307
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,337評論 6 404
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,883評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,975評論 3 439
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,114評論 0 286
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,625評論 1 332
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,555評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,737評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,244評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,973評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,362評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,615評論 1 280
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,343評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,699評論 2 370

推薦閱讀更多精彩內容