DAO(Data Access Object,資料存取物件)是一組面向物件的介面,專責與資料庫往來,把新增、刪除、修改、查詢這些動作封裝起來,對外只暴露乾淨的方法,讓業務邏輯層不必知道 SQL 的存在。
在 iOS 上,這樣的分層同樣有價值:Controller 只關心「我要哪一筆提醒」,而不是「這筆提醒的 SELECT 語句長什麼樣子」。
- (void)saveRemind:(RemindEntity *)remind; // 儲存一筆提醒
- (void)deleteRemindWithWhere:(NSString *)where; // 依條件刪除
- (RemindEntity *)loadRemindWithRemindID:(NSString *)rid; // 依 ID 讀取
- (void)deleteRemindWithRemindID:(NSString *)rid; // 依 ID 刪除
- (void)deleteRemindWithWeihuaId:(NSString *)weihuaId rcdId:(int)rcdId;
- (NSArray *)searchRemindWithWhere:(NSString *)where
order:(NSString *)order
limit:(NSString *)limit; // 條件查詢
- (NSInteger)remindCountWithWhere:(NSString *)where; // 統計筆數
- (NSArray *)allArrivalReminds; // 已到期
- (NSArray *)allNonOverdueReminds; // 未過期
+ (void)setupDB; // 初始化資料庫
底層多半是 FMDB。問題很明顯:實體類有多少個,你就得寫多少份幾乎一樣的 DAO,SQL 大量重複。
解法是把「表名」與「主鍵」抽成實體必須實作的協定,再用泛型(Objective-C 中實為 Class 參數)把實體類別傳進 DAO。
@protocol XYBaseDaoEntityProtocol <NSObject> @required + (NSString *)getTableName; // 回傳表名 + (NSString *)getPrimaryKey; // 回傳主鍵欄位 @end // 泛型化的本地 DAO @interface XYBaseDao : NSObject @property (nonatomic, weak, readonly) Class entityClass; + (instancetype)daoWithEntityClass:(Class)aClass; - (NSError *)saveEntity:(id)entity; - (NSError *)saveEntityWithArray:(NSArray *)array; - (id)loadEntityWithKey:(NSString *)key; - (NSArray *)loadEntityWithWhere:(NSString *)where; - (NSInteger)countWithWhere:(NSString *)where; - (NSError *)deleteEntityWithKey:(NSString *)key; - (NSError *)deleteEntityWithWhere:(NSString *)where; - (void)deleteAllEntity; @end
這裡以 LKDBHelper 為底層,建立時順便把表建好。
+ (instancetype)daoWithEntityClass:(Class)aClass
{
return [[[self class] alloc] initWithEntityClass:aClass];
}
- (instancetype)initWithEntityClass:(Class)aClass
{
self = [super init];
if (self) {
_entityClass = aClass;
_globalHelper = [LKDBHelper getUsingLKDBHelper];
[_globalHelper createTableWithModelClass:_entityClass];
}
return self;
}
- (NSError *)saveEntity:(id)entity
{
if (entity == nil) {
return [NSError errorWithDomain:@"[save error] entity is nil"
code:XYBaseDao_error_code userInfo:nil];
}
if (![[LKDBHelper getUsingLKDBHelper] insertToDB:entity]) {
return [NSError errorWithDomain:[NSString stringWithFormat:@"[save error] :%@", entity]
code:XYBaseDao_error_code userInfo:nil];
}
return nil;
}
- (NSError *)saveEntityWithArray:(NSArray *)array
{
if (array.count == 0) return nil;
NSMutableString *errStr = [NSMutableString stringWithString:@"[save error] :"];
NSInteger originLength = errStr.length;
__weak typeof(self) weakSelf = self;
[_globalHelper executeDB:^(FMDatabase *db) {
[db beginTransaction];
for (NSObject *entity in array) {
if (![weakSelf.globalHelper insertToDB:entity]) {
[errStr appendFormat:@"%@ ", entity];
}
}
[db commit];
}];
if (errStr.length > originLength) {
return [NSError errorWithDomain:errStr code:XYBaseDao_error_code userInfo:nil];
}
return nil;
}
批次寫入包在交易裡,是為了避免寫到一半失敗留下半套資料;同時收集失敗的物件,讓呼叫端知道哪些沒存成功。
- (id)loadEntityWithKey:(NSString *)key
{
if (key.length == 0) return nil;
NSString *where = [NSString stringWithFormat:@"%@ = '%@'",
[_entityClass getPrimaryKey], key];
return [_entityClass searchSingleWithWhere:where orderBy:nil];
}
- (NSArray *)loadEntityWithWhere:(NSString *)where
{
if (where.length == 0) return nil;
return [_entityClass searchWithWhere:where
orderBy:nil
offset:0
count:XYBaseDao_load_maxCount];
}
- (NSInteger)countWithWhere:(NSString *)where
{
return [_entityClass rowCountWithWhere:where];
}
注意 loadEntityWithWhere: 設了上限 XYBaseDao_load_maxCount,這是防呆設計——避免誤傳空條件時把整張表拉進記憶體。
- (NSError *)deleteEntityWithKey:(NSString *)key
{
id object = [[_entityClass alloc] init];
[object setValue:key forKey:[_entityClass getPrimaryKey]];
if (![object deleteToDB]) {
return [NSError errorWithDomain:[NSString stringWithFormat:@"[delete error] : %@ %@",
_entityClass, key]
code:XYBaseDao_error_code userInfo:nil];
}
return nil;
}
- (NSError *)deleteEntityWithWhere:(NSString *)where
{
if (![_entityClass deleteWithWhere:where]) {
return [NSError errorWithDomain:[NSString stringWithFormat:@"[delete error] : %@ %@",
_entityClass, where]
code:XYBaseDao_error_code userInfo:nil];
}
return nil;
}
- (void)deleteAllEntity
{
[LKDBHelper clearTableData:[_entityClass class]];
}
- (void)clickTestDao:(id)sender
{
XYBaseDao *dao = [XYBaseDao daoWithEntityClass:[CarEntity class]];
[dao deleteAllEntity];
CarEntity *car = [[CarEntity alloc] init];
car.name = @"a";
car.brand = @"科魯茲";
car.time = 1;
[dao saveEntity:car];
NSArray *array = @[car2, car3, car5];
[dao saveEntityWithArray:array];
CarEntity *car4 = [dao loadEntityWithKey:@"c"];
NSLog(@"%@", car4);
NSArray *array2 = [dao loadEntityWithWhere:@"brand = '科魯茲'"];
NSLog(@"%@", array2);
NSLog(@"%ld", (long)[dao countWithWhere:nil]);
[dao deleteEntityWithKey:@"c"];
[dao deleteEntityWithWhere:@"brand = '科魯茲'"];
}
泛型化之後,新增一個實體只要繼承 XYBaseDao 或透過工廠類建立,不必再寫 SQL,維護成本大幅下降。但也要留意兩個代價:
where 用字串拼接,拼錯欄位名要到執行期才發現,也有 SQL 注入風險。若資料來源不可信,應改用參數化查詢。實務上的折衷是:簡單的 CRUD 走泛型 BaseDao,複雜查詢另開專用方法。這樣既省下大量重複程式碼,也不犧牲彈性。