簡書博客已經(jīng)暫停更新,想看更多技術(shù)博客請到:
在移動開發(fā)中,有時不得不在客戶端本地保存一些數(shù)據(jù)。在iOS端,我們可以使用plist,屬性列表等技術(shù)來存儲數(shù)據(jù),而相比而下更高端一點的,我們也可以使用數(shù)據(jù)庫來存儲數(shù)據(jù)。
有趣的是,很多iOS開發(fā)者沒有去選擇使用蘋果自家的Core Data技術(shù)來操作數(shù)據(jù)庫,而是選擇了FMDB這個第三方框架。
該框架很好地封裝了操作繁瑣的SQLite語句,讓數(shù)據(jù)庫的操作更加面向?qū)ο螅疑鲜挚欤T檻低,不用學習數(shù)據(jù)庫的相關(guān)知識就可以使用自如。如此優(yōu)秀流行的框架是值得學習的,于是筆者這兩天研究了一下FMDB。研究后,略有所思,將它封裝了一下,寫了一個Manager
類,最后結(jié)合了一個Demo演示如何使用這個類。
該博客分為兩個部分:第一個部分講解筆者封裝的這個Manager
類;第二部分結(jié)合Demo來體現(xiàn)該類的實用性。
1. 封裝FMDB
1.1 封裝類的功能
首先看一下這個類的大名:SJUserInfoManager
- SJ:筆者的名字縮寫,作為前綴,都懂得。
- UserInfo:說明這個類用于操作用戶信息。
- Manager:這個類只具有工廠方法,省內(nèi)存,而且方便使用。
這個類的功能是:它可以創(chuàng)建一個關(guān)于用戶信息的表(數(shù)據(jù)庫),可以保存,修改,讀取,刪除用戶信息。
現(xiàn)在幾乎每個app都有登錄功能,有登錄就意味著有用戶信息。有的時候,我們需要將一些用戶信息存儲到本地,方便今后的讀取和操作。
而對于用戶信息,幾乎永遠不變的一項就是用戶id,因為用戶可以改自己的名字,自己的注冊手機號,用戶簽名等等,然而用戶id是唯一一成不變的,后端查找用戶信息一般都通過用戶id來查找,這不難理解。
因此,這個封裝類基于用戶id(user_id),讓使用者可以自主添加一項自定義的用戶信息(可以是用戶名,用戶簽名,用戶性別等等),從而形成一個只具有兩個縱行的表(第一個縱行是默認的字段:user_id,第二個縱行是自定義字段,可以是user_name等等)。
這樣一來,我們就可以生成很多基于用戶id的表:可以是用戶姓名的表,可以是用戶出生日期的表,可以是用戶手機號的表等等。
1.2 API介紹
該封裝類的API一共有五個,分別是:
- 創(chuàng)建表格
- 更新用戶信息(添加&修改)
- 查詢某個用戶的信息
- 查詢?nèi)坑脩舻男畔?/li>
- 刪除某個用戶的信息
下面開始一一講解:
1. 創(chuàng)建表格
/*
********** Create table with tableName and fieldName **********
*
* @param dataBaseName tableNameString (表的名字)
* @param userInfoField fieldNameString(自定義字段名)
*
* @return if the table is successfully created
*
*/
+ (BOOL)createDataBaseWithName:(NSString *)dataBaseName andUserInfoField:(NSString *)userInfoField;
這個方法的意圖很明顯,只要傳進去表的名字和自定義字段的名字就能創(chuàng)造一個表。
- 創(chuàng)建成功,返回YES;
- 創(chuàng)建失敗,返回NO。
而且這個表有一個默認的字段:user_id。因為通過這個類創(chuàng)建用戶信息的表是基于用戶id來操作的,前面已有說明。
2. 更新用戶信息(添加&修改)
/*
********** update specific userInfo with specific userID and userInfoField and userInfoValue **********
*
* @param dataBaseName tableNameString (表的名字)
* @param userID userIDString(用戶id的值)
* @param userInfoField fieldNameString(自定義字段名)
* @param userInfoValue userInfoValueString(字段對應(yīng)的值)
*
* @return the result of updating specific userInfo
*
*/
+ (NSString *)updateUserInfoIntoDataBase:(NSString *)dataBaseName withUserID:(NSString *)userID andUserInfoField:(NSString *)userInfoField andUserInfoValue:(NSString *)userInfoValue;
這個方法用于更新用戶信息,傳入表的名字,用戶id,自定義字段名,和自定義字段對應(yīng)的值。
- 如果輸入的表不存在,則返回相應(yīng)的錯誤信息。
- 如果輸入的用戶id已經(jīng)存在,就更新對應(yīng)的用戶信息。
- 如果輸入的用戶id不存在,就添加這個用戶的信息。
3. 查詢某個用戶的信息
/*
********** Query specific userInfoValue with tableName and userID and userInfoField **********
*
* @param dataBaseName tableNameString (表的名字)
* @param userID userIDString(用戶id的值)
* @param userInfoField fieldNameString(自定義字段名)
*
* @return specific userInfoValue (表內(nèi)某用戶id對應(yīng)的用戶信息)
*
*/
+ (NSString *)queryUserInfoInDataBase:(NSString *)dataBaseName WithUserID:(NSString *)userId andUserInfoField:(NSString *)userInfoField;
該方法用于查詢某個用戶的信息,傳入表的名字,用戶id和自定義字段名。
- 如果輸入的表不存在,則返回相應(yīng)的錯誤信息。
- 如果輸入的用戶id存在,則返回對應(yīng)的信息。
- 如果輸入的用戶id不存在,則返回相應(yīng)的錯誤信息。
4. 查詢?nèi)坑脩舻男畔?/h4>
/*
********** Query all userInfos in this table with userInfoField **********
*
* @param dataBaseName tableNameString (表的名字)
* @param userInfoField fieldNameString(自定義字段名)
*
* @return all the userInfos in this table (表內(nèi)所有的用戶信息)
*
*/
+ (NSDictionary *)queryUserInfosInDataBase:(NSString *)dataBaseName andUserInfoField:(NSString *)userInfoField;
該方法用戶獲取某個表內(nèi)的所有用戶信息,傳入表的名字和自定義字段名即可。
返回的字典里包含一個數(shù)組,數(shù)組元素為表的每一行的信息。每一行的信息是一個字典:
- 其中一個key為默認的字段名:user_id,它的值為對應(yīng)的user_id的值。
- 另一個key為添加的自定義字段名,它對應(yīng)的值為該字段對應(yīng)的值。
5. 刪除某個用戶的信息
/*
********** Delete specific userInfo with specific userID **********
*
* @param dataBaseName tableNameString (表的名字)
* @param userId userIDString(用戶id的值)
*
* @return the result of deleting specific userInfo (刪除的結(jié)果)
*
*/
+ (NSString *)deleteUserInfoInDataBase:(NSString *)dataBaseName WithUserID:(NSString *)userId;
該方法用于刪除表里的某個用戶信息,只要傳入表的名字和用戶id即可,可以刪除表中對應(yīng)的一整行信息。同樣地,如果輸入的表不存在,則返回相應(yīng)的錯誤信息。
/*
********** Query all userInfos in this table with userInfoField **********
*
* @param dataBaseName tableNameString (表的名字)
* @param userInfoField fieldNameString(自定義字段名)
*
* @return all the userInfos in this table (表內(nèi)所有的用戶信息)
*
*/
+ (NSDictionary *)queryUserInfosInDataBase:(NSString *)dataBaseName andUserInfoField:(NSString *)userInfoField;
該方法用戶獲取某個表內(nèi)的所有用戶信息,傳入表的名字和自定義字段名即可。
返回的字典里包含一個數(shù)組,數(shù)組元素為表的每一行的信息。每一行的信息是一個字典:
/*
********** Delete specific userInfo with specific userID **********
*
* @param dataBaseName tableNameString (表的名字)
* @param userId userIDString(用戶id的值)
*
* @return the result of deleting specific userInfo (刪除的結(jié)果)
*
*/
+ (NSString *)deleteUserInfoInDataBase:(NSString *)dataBaseName WithUserID:(NSString *)userId;
該方法用于刪除表里的某個用戶信息,只要傳入表的名字和用戶id即可,可以刪除表中對應(yīng)的一整行信息。同樣地,如果輸入的表不存在,則返回相應(yīng)的錯誤信息。
如果覺得有點抽象的話,可以看下面這個Demo,可以看到該封裝類的具體使用方法。
2. Demo演示
在這個Demo中,我們要在表里添加的自定義字段名(fieldNameString)為:“user_name”。也就是說這個表將保存用戶id和用戶名信息。
2.1 需求
- 在插入板塊中插入用戶信息(用戶id和用戶名)。
- 在查詢板塊中,根據(jù)輸入的用戶id,可以顯示對應(yīng)的用戶名。如果沒有對應(yīng)的用戶id,則顯示“沒有對應(yīng)id”。
- 在刪除板塊中,根據(jù)輸入的用戶id,可以刪除對應(yīng)的用戶信息(包括用戶id和用戶名,也就是刪除了表的一整行)。如果沒有對應(yīng)的用戶id,則顯示“沒有對應(yīng)id”。
- 點擊導(dǎo)航欄右側(cè)的按鈕,進入“用戶信息列表頁”。在這一頁顯示當前表里的全部用戶的信息(在cell的textLabel里顯示用戶名;在cell的detailTextLabel里顯示用戶id)。
2.2 效果圖
2.3 代碼講解
1. 最先導(dǎo)入這個封裝類和FMDB框架:
#import "SJUserInfoManager.h"
2. 因為表的名字和自定義字段是固定的,所以就以宏來定義了:
#define DATABASENAME @"userInfoTable" //表的名字
#define USERINFOFIELD @"user_name" //自定義字段的名字
3. 添加幾個輸入框的屬性,獲取輸入框的內(nèi)容;和查詢結(jié)果顯示Label:
@property (strong, nonatomic) IBOutlet UITextField *insertUserIdTextfield; //插入輸入框:輸入用戶id
@property (strong, nonatomic) IBOutlet UITextField *insertUserInfoValueTextfiled;//插入收入框:輸入用戶名
@property (strong, nonatomic) IBOutlet UITextField *queryUserIdTextfield; //查詢輸入框:輸入用戶id
@property (strong, nonatomic) IBOutlet UILabel *queryUserInfoValueLabel; //查詢結(jié)果顯示Label:顯示用戶id對應(yīng)的用戶名
@property (strong, nonatomic) IBOutlet UITextField *deleteUserIdTextField; //刪除輸入框:輸入用戶id
4. 下面看一下封裝的增改&查&刪的代碼:
//插入用戶信息
- (IBAction)insertAction:(id)sender {
NSString *result = @"";
if (self.insertUserInfoValueTextfiled.text.length == 0) {
result = @"Please Input UserID!";//沒有輸入用戶id就點擊了插入按鈕
}else{
result = [SJUserInfoManager updateUserInfoIntoDataBase:DATABASENAME withUserID:self.insertUserIdTextfield.text andUserInfoField:USERINFOFIELD andUserInfoValue:self.insertUserInfoValueTextfiled.text];
}
[self showAlertWithTitle:result];
}
//查詢用戶信息
- (IBAction)queryUserInfoValue:(UIButton *)sender {
NSString *result = @"";
if (self.queryUserIdTextfield.text.length == 0) {
result = @"Please Input UserID!";//沒有輸入用戶id就點擊了查詢按鈕
self.queryUserInfoValueLabel.text = @"";//重置查詢輸入框
}else{
result = [SJUserInfoManager queryUserInfoInDataBase:DATABASENAME WithUserID:self.queryUserIdTextfield.text andUserInfoField:USERINFOFIELD];
self.queryUserInfoValueLabel.text = result;
[self showAlertWithTitle:result];
}
[self showAlertWithTitle:result];
}
//刪除用戶信息
- (IBAction)deleteUserInfoWithUserID:(UIButton *)sender {
NSString *result = @"";
if (self.deleteUserIdTextField.text.length == 0) {
result = @"Please Input UserID!";
}else{
result = [SJUserInfoManager deleteUserInfoInDataBase:DATABASENAME WithUserID:self.deleteUserIdTextField.text];
}
[self showAlertWithTitle:result];
}
其實不難看出,除了處理錯誤信息的代碼以外,數(shù)據(jù)庫的操作代碼是非常簡潔的:都是一行結(jié)束,而且返回一個結(jié)果字符串或者布爾值。
5. 在進入第二頁之前,需要查詢表內(nèi)所有的用戶信息并傳遞給第二個頁面的VC:
-(void)prepareForSegue:(UIStoryboardSegue *)segue sender:(id)sender
{
if ([segue.destinationViewController isKindOfClass:[DataListTableViewController class]]) {
if ([segue.identifier isEqualToString:@"userInfosList"]) {
NSDictionary *userInfosDict = [SJUserInfoManager queryUserInfosInDataBase:DATABASENAME andUserInfoField:USERINFOFIELD];
DataListTableViewController *dataListVc = (DataListTableViewController *)segue.destinationViewController;
dataListVc.userInfosDict = userInfosDict;
}
}
}
6. 在第二頁的viewDidLoad方法里獲取用戶信息列表,并刷新表格將其顯示出來:
- (void)viewDidLoad {
[super viewDidLoad];
NSString *alertTitle = [self.userInfosDict objectForKey:@"result"];
[self showAlertWithTitle:alertTitle];
NSArray *userInfosArray = [self.userInfosDict objectForKey:@"userInfosArray"];
if ([userInfosArray count] != 0) {
self.userInfosArray = userInfosArray;
[self.tableView reloadData];
}
}
想知道Demo是如何實現(xiàn)的么?
Demo傳送門:SJUserInfoManager - GitHub
如果可以給星星,或者給筆者提意見,那就再好不過啦~
最后的話
說來慚愧,筆者封裝的這個類的功能還是很有局限性的:
- 操作表格前必須創(chuàng)建一次表格(一次就可以)。
- 只支持NSString類型的值。
- 除user_id字段以外只支持一個自定義字段。
- 不同的自定義字段必須對應(yīng)不同的表格名,也就是說不同的自定義字段不能對應(yīng)同一個表格名。
- 數(shù)據(jù)庫操作API的返回值還不夠完善,最好以枚舉類型返回,有待改進。
- 沒有使用FMDB的隊列API。
雖然這個封裝很簡單,但是筆者始終贊同學習的最終目的在于應(yīng)用和創(chuàng)造這句話。如果只是用眼睛看FMDB框架的API或是復(fù)制粘貼一些別人寫好的FMDB的應(yīng)用代碼,那么其實是意義不大的。
如果在學習后,可以融會貫通,將學到的知識可以按照自己的意圖加以改進和運用的話,那么相對于“搬運工”式學習來說,顯然收獲更大。
這是筆者第一個開源項目,雖然簡單,算上優(yōu)化和改bug只寫了大概3個小時,但是畢竟是開源的第一步,對自己的鼓勵還是蠻大的,以后還會封裝優(yōu)化更多的庫,加油~
本文已同步到個人博客:傳送門,歡迎常來^^
本文已在版權(quán)印備案,如需轉(zhuǎn)載請訪問版權(quán)印。48422928
-------------------------------- 2018年7月16日更新 --------------------------------
注意注意!!!
筆者在近期開通了個人公眾號,主要分享編程,讀書筆記,思考類的文章。
- 編程類文章:包括筆者以前發(fā)布的精選技術(shù)文章,以及后續(xù)發(fā)布的技術(shù)文章(以原創(chuàng)為主),并且逐漸脫離 iOS 的內(nèi)容,將側(cè)重點會轉(zhuǎn)移到提高編程能力的方向上。
- 讀書筆記類文章:分享編程類,思考類,心理類,職場類書籍的讀書筆記。
- 思考類文章:分享筆者平時在技術(shù)上,生活上的思考。
因為公眾號每天發(fā)布的消息數(shù)有限制,所以到目前為止還沒有將所有過去的精選文章都發(fā)布在公眾號上,后續(xù)會逐步發(fā)布的。
而且因為各大博客平臺的各種限制,后面還會在公眾號上發(fā)布一些短小精干,以小見大的干貨文章哦~
掃下方的公眾號二維碼并點擊關(guān)注,期待與您的共同成長~