網路上談 CoreData 的文章不少,但多數講得零散,很少把完整程式碼從頭敲一遍。本文記錄一次自行封裝 CoreData 的過程,思路是「單例 + 中間層」,一方面加深對底層三個核心物件的理解,另一方面也方便日後在業務量變大時針對中間層做優化。
我們刻意不使用系統自動產生的 CoreData 樣板碼,而是自行引入 CoreData.framework 手寫,這樣對 NSManagedObjectModel、NSPersistentStoreCoordinator、NSManagedObjectContext 三者之間的關係會清楚很多。
整體分成四個檔案:
ADCoreData:單例,負責建立與持有 CoreData 三層堆疊,並對外提供增刪改查介面。ADCoreDataManager:中間層,繼承自 NSManagedObject,用來承接各模型的屬性。.momd 模型檔與 .sqlite 資料庫檔。// // ADCoreData.h // CoreData_CE // // Created by Dylan on 14-10-11. // Copyright (c) 2014年 Dylan. All rights reserved. // /*! * @Author Dylan. * * Please add CoreData.FrameWork */ #import <Foundation/Foundation.h> #import <CoreData/CoreData.h> @interface ADCoreData : NSObject /*! * @Author Dylan. * * context */ @property (nonatomic, strong, readonly) NSManagedObjectContext *manageContext; + (instancetype)shareInstanceWithStoreName:(NSString *)storeName; /*! * @Author Dylan. * * Methods */ - (NSMutableArray *)findByModel:(id)model; - (NSMutableArray *)findByModel:(id)model predicateString:(NSString *)predicateString; /*! Update */ - (BOOL)create:(id)model; - (BOOL)remove:(id)model; - (BOOL)remove:(id)model predicateString:(NSString *)predicateString; - (BOOL)modify:(id)model predicateString:(NSString *)predicateString; @end
//
// ADCoreData.m
// CoreData_CE
//
// Created by Dylan on 14-10-11.
// Copyright (c) 2014年 Dylan. All rights reserved.
//
#import "ADCoreData.h"
#import "ADCoreDataManager.h"
#import <objc/runtime.h>
#define CLASS_NAME(PRAM) NSStringFromClass([PRAM class])
@interface ADCoreData ()
@property (nonatomic, strong) NSManagedObjectModel *managedobjectModel;
@property (nonatomic, strong) NSPersistentStoreCoordinator *persistentStoreCoordinator;
/*!
* @Author Dylan.
*
* storeName
*/
@property (nonatomic, strong) NSString *storeName;
- (NSURL *)applicationDomainUrl;
@end
static ADCoreData *coreData;
@implementation ADCoreData
+ (instancetype)shareInstanceWithStoreName:(NSString *)storeName
{
static dispatch_once_t onceToken;
dispatch_once(&onceToken, ^{
coreData = [[self alloc] init];
coreData.storeName = storeName;
});
return coreData;
}
/*!
* @Author Dylan.
*
* synthesize
*/
@synthesize manageContext = _manageContext;
@synthesize managedobjectModel = _managedobjectModel;
@synthesize persistentStoreCoordinator = _persistentStoreCoordinator;
#pragma mark - GET
- (NSManagedObjectContext *)manageContext
{
if (_manageContext) {
return _manageContext;
}
NSPersistentStoreCoordinator *coordinator = [self persistentStoreCoordinator];
if (coordinator != nil) {
_manageContext = [[NSManagedObjectContext alloc] init];
[_manageContext setPersistentStoreCoordinator:coordinator];
}
return _manageContext;
}
- (NSPersistentStoreCoordinator *)persistentStoreCoordinator
{
if (_persistentStoreCoordinator) {
return _persistentStoreCoordinator;
}
NSURL *storeUrl = [[self applicationDomainUrl]
URLByAppendingPathComponent:[NSString stringWithFormat:@"%@.sqlite", _storeName]];
_persistentStoreCoordinator = [[NSPersistentStoreCoordinator alloc]
initWithManagedObjectModel:self.managedobjectModel];
[_persistentStoreCoordinator addPersistentStoreWithType:NSSQLiteStoreType
configuration:nil
URL:storeUrl
options:nil
error:nil];
return _persistentStoreCoordinator;
}
- (NSManagedObjectModel *)managedobjectModel
{
if (_managedobjectModel) {
return _managedobjectModel;
}
NSURL *modelUrl = [[NSBundle mainBundle] URLForResource:_storeName withExtension:@"momd"];
_managedobjectModel = [[NSManagedObjectModel alloc] initWithContentsOfURL:modelUrl];
return _managedobjectModel;
}
#pragma mark - Methods
- (NSMutableArray *)findByModel:(id)model
{
NSError *error = nil;
NSArray *listArray = [_manageContext
executeFetchRequest:[self bindRequest:CLASS_NAME(model) predicate:nil]
error:&error];
NSMutableArray *resultArray = [NSMutableArray array];
for (ADCoreDataManager *manager in listArray) {
for (NSString *propertyName in [self ClassAttributes:model]) {
[model setValue:[manager valueForKey:propertyName] forKey:propertyName];
}
[resultArray addObject:model];
}
return resultArray;
}
- (NSMutableArray *)findByModel:(id)model predicateString:(NSString *)predicateString
{
NSError *error = nil;
NSArray *listArray = [_manageContext
executeFetchRequest:[self bindRequest:CLASS_NAME(model) predicate:predicateString]
error:&error];
NSMutableArray *resultArray = [NSMutableArray array];
if (listArray.count >= 1) {
for (ADCoreDataManager *manager in listArray) {
for (NSString *propertyName in [self ClassAttributes:model]) {
[model setValue:[manager valueForKey:propertyName] forKey:propertyName];
}
[resultArray addObject:model];
}
}
return resultArray;
}
#pragma mark update
- (BOOL)create:(id)model
{
ADCoreDataManager *manager = [NSEntityDescription
insertNewObjectForEntityForName:CLASS_NAME(model)
inManagedObjectContext:_manageContext];
for (NSString *propertyName in [self ClassAttributes:model]) {
[manager setValue:[model valueForKey:propertyName] forKey:propertyName];
}
return [self saveContext];
}
- (BOOL)remove:(id)model
{
NSError *error = nil;
NSArray *listArray = [_manageContext
executeFetchRequest:[self bindRequest:CLASS_NAME(model) predicate:nil]
error:&error];
if (listArray.count > 0) {
for (ADCoreDataManager *manager in listArray) {
[_manageContext deleteObject:manager];
}
}
return [self saveContext];
}
- (BOOL)remove:(id)model predicateString:(NSString *)predicateString
{
NSError *error = nil;
NSArray *listArray = [_manageContext
executeFetchRequest:[self bindRequest:CLASS_NAME(model) predicate:predicateString]
error:&error];
if (listArray.count > 0) {
for (ADCoreDataManager *manager in listArray) {
[_manageContext deleteObject:manager];
}
}
return [self saveContext];
}
- (BOOL)modify:(id)model predicateString:(NSString *)predicateString
{
NSError *error = nil;
NSArray *listArray = [_manageContext
executeFetchRequest:[self bindRequest:CLASS_NAME(model) predicate:predicateString]
error:&error];
if (listArray.count > 0) {
for (ADCoreDataManager *manager in listArray) {
for (NSString *propertyName in [self ClassAttributes:model]) {
[manager setValue:[model valueForKey:propertyName] forKey:propertyName];
}
}
}
return [self saveContext];
}
#pragma mark - collect
- (NSFetchRequest *)bindRequest:(NSString *)className predicate:(NSString *)predicateString
{
NSFetchRequest *request = [[NSFetchRequest alloc] init];
[request setEntity:[NSEntityDescription entityForName:className
inManagedObjectContext:_manageContext]];
if (predicateString != nil) {
NSPredicate *predicate = [NSPredicate predicateWithFormat:predicateString];
NSLog(@"%@", predicate);
NSLog(@"%@", predicateString);
[request setPredicate:predicate];
}
return request;
}
#pragma mark - save
- (BOOL)saveContext
{
NSManagedObjectContext *context = [self manageContext];
if (context != nil) {
NSError *error = nil;
if ([context hasChanges] && ![context save:&error]) {
NSLog(@"%@", [error userInfo]);
abort();
return NO;
}
}
return YES;
}
- (NSURL *)applicationDomainUrl
{
return [[[NSFileManager defaultManager]
URLsForDirectory:NSDocumentDirectory inDomains:NSUserDomainMask] lastObject];
}
#pragma mark - allAttributes
- (NSMutableArray *)ClassAttributes:(id)classModel
{
NSMutableArray *array = [NSMutableArray array];
NSString *className = NSStringFromClass([classModel class]);
const char *cClassName = [className UTF8String];
id classM = objc_getClass(cClassName);
unsigned int outCount, i;
objc_property_t *properties = class_copyPropertyList(classM, &outCount);
for (i = 0; i < outCount; i++) {
objc_property_t property = properties[i];
NSString *attributeName = [NSString stringWithUTF8String:property_getName(property)];
[array addObject:attributeName];
}
return array;
}
@end
在 .m 檔案中我使用了 Objective-C Runtime,透過 class_copyPropertyList 在執行期取得模型的屬性清單,這樣一來就能搭配 KVC 做「通用型」的欄位搬運,不必為每個模型寫一遍繁瑣的赋值程式碼。
// // ADCoreDataManager.h // CoreData_CE // // Created by Dylan on 14-10-11. // Copyright (c) 2014年 Dylan. All rights reserved. // #warning add Model properties Here #import <CoreData/CoreData.h> #import <Foundation/Foundation.h> @interface ADCoreDataManager : NSManagedObject /*! * @Author Dylan. * * e.g */ @property (nonatomic, strong) NSString *name; @end
//
// ADCoreDataManager.m
// CoreData_CE
//
// Created by Dylan on 14-10-11.
// Copyright (c) 2014年 Dylan. All rights reserved.
//
#warning don't forget write @synthesize
#import "ADCoreDataManager.h"
@implementation ADCoreDataManager
@synthesize name = _name;
- (void)setValue:(id)value forUndefinedKey:(NSString *)key
{
}
@end
可以把所有模型的屬性都彙整到中間層裡,讓它充當資料傳遞的中介。這麼做的好處是:當資料表結構變動時,只需要調整中間層,單例層的通用邏輯不必跟著改。
1. 建立自己的 momd 檔。 在 Xcode 中選擇 New → Core Data → Data Model,建立完成後加入所需的 entity 與屬性。
2. 初始化單例並測試。
// test
ADCoreData *coreData = [ADCoreData shareInstanceWithStoreName:@"CoreData"];
Dylan *dylan = [[Dylan alloc]
initWithEntity:[NSEntityDescription entityForName:@"Dylan"
inManagedObjectContext:coreData.manageContext]
insertIntoManagedObjectContext:nil];
[dylan setName:@"Dylan"];
NSLog(@"**************************************************");
NSLog(@"first = %@", [coreData findByModel:dylan]);
NSLog(@"**************************************************");
[coreData create:dylan];
NSLog(@"second = %@", [coreData findByModel:dylan]);
NSLog(@"third = %@", [coreData findByModel:dylan predicateString:@"name = 'Dylan'"]);
NSLog(@"**************************************************");
[coreData remove:dylan];
NSLog(@"fourth = %@", [coreData findByModel:dylan]);
NSLog(@"**************************************************");
[coreData create:dylan];
NSLog(@"fifth = %@", [coreData findByModel:dylan]);
NSLog(@"**************************************************");
Dylan *dylan1 = [[Dylan alloc]
initWithEntity:[NSEntityDescription entityForName:@"Dylan"
inManagedObjectContext:coreData.manageContext]
insertIntoManagedObjectContext:nil];
dylan1.name = @"dylan-1";
[coreData modify:dylan1 predicateString:nil];
NSLog(@"sixth = %@", [coreData findByModel:dylan]);
NSLog(@"seventh = %@", [coreData findByModel:dylan1]);
謂詞中的字串值務必加單引號。 寫 name = 'Dylan' 而不是 name = Dylan,否則 CoreData 在組裝 fetch request 時會直接報錯。這是新手最常踩的坑之一。
別忽略 Runtime 帶來的風險。 用 class_copyPropertyList 搭配 KVC 做通用赋值很優雅,但它把型別檢查從編譯期推到了執行期。如果某個模型的屬性名稱與 CoreData 的 entity 定義不一致,不會在編譯時報錯,而是等到執行才 crash。建議在開發階段對 ClassAttributes: 的結果加上除錯輸出,並為每個模型補上單元測試。
另外,正式專案中建議把 NSManagedObjectContext 的存取限制在同一個佇列(performBlock:)內,並在背景寫入時改用 NSPrivateQueueConcurrencyType,以避免多執行緒下的資料競爭問題。