[Cocoa]深入浅出 Cocoa 之 Core Data- 框架详解

Posted 2023-01-18 飘飘白云

深入浅出 Cocoa 之 Core Data（1）- 框架详解 罗朝辉( http://blog.csdn.net/kesalin)

CC 许可，转载请注明出处

Core data 是 Cocoa 中处理数据，绑定数据的关键特性，其重要性不言而喻，但也比较复杂。Core Data 相关的类比较多，初学者往往不太容易弄懂。计划用三个教程来讲解这一部分：

框架详解：讲解  Core data 框架，运作过程，设计的类；
Core data应用程序示例：通过生成一个使用 Core data 的应用程序来讲解如何 在  XCode 4 中使用 Core data。
手动创建Core data示例：不利用框架自动生成代码，完全自己编写所有的 Core data 相关代码的命令行应用程序来深入讲解 Core data的使用。

本文为第一部份：框架详解

一，概观
下面先给出一张类关系图，让我们对它有个总体的认识。

在上图中，我们可以看到有五个相关模块：
1， Managed Object Model
Managed Object Model 是描述应用程序的数据模型，这个模型包含实体（Entity），特性（Property），读取请求（Fetch Request）等。（下文都使用英文术语。）

2，Managed Object Context
Managed Object Context 参与对数据对象进行各种操作的全过程，并监测数据对象的变化，以提供对 undo/redo 的支持及更新绑定到数据的 UI。

3，Persistent Store Coordinator
Persistent Store Coordinator 相当于数据文件管理器，处理底层的对数据文件的读取与写入。一般我们无需与它打交道。

4，Managed Object
Managed Object 数据对象，与 Managed Object Context 相关联。

5，Controller
图中绿色的 Array Controller, Object Controller, Tree Controller 这些控制器，一般都是通过 control+drag 将 Managed Object Context 绑定到它们，这样我们就可以在 nib 中可视化地操作数据。

这写模块是怎样运作的呢？

1，应用程序先创建或读取模型文件（后缀为xcdatamodeld）生成 NSManagedObjectModel 对象。Document应用程序是一般是通过 NSDocument 或其子类 NSPersistentDocument）从模型文件（后缀为 xcdatamodeld）读取。
2，然后生成 NSManagedObjectContext 和 NSPersistentStoreCoordinator 对象，前者对用户透明地调用后者对数据文件进行读写。
3，NSPersistentStoreCoordinator 负责从数据文件(xml, sqlite,二进制文件等)中读取数据生成 Managed Object，或保存 Managed Object 写入数据文件。
4，NSManagedObjectContext 参与对数据进行各种操作的整个过程，它持有 Managed Object。我们通过它来监测 Managed Object。监测数据对象有两个作用：支持 undo/redo 以及数据绑定。这个类是最常被用到的。
5，Array Controller, Object Controller, Tree Controller 这些控制器一般与 NSManagedObjectContext 关联，因此我们可以通过它们在 nib 中可视化地操作数据对象。

二， Model class

模型有点像数据库的表结构，里面包含 Entry， 实体又包含三种 Property：Attribute（属性），RelationShip（关系）， Fetched Property（读取属性）。Model class 的名字多以 "Description" 结尾。我们可以看出：模型就是描述数据类型以及其关系的。

主要的 Model class 有：

Model Classes

Managed Object Model	NSManagedObjectModel	数据模型
Entity	NSEntityDescription	抽象数据类型，相当于数据库中的表
Property	NSPropertyDescription	Entity 特性，相当于数据库表中的一列
> Attribute	NSAttributeDescription	基本数值型属性（如Int16, BOOL, Date等类型的属性）
> Relationship	NSRelationshipDescription	属性之间的关系
> Fetched Property	NSFetchedPropertyDescription	查询属性（相当于数据库中的查询语句）

1）Entity - NSEntityDescription
Entity 相当于数据库中的一个表，它描述一种抽象数据类型，其对应的类为 NSManagedObject 或其子类。

NSEntityDescription 常用方法:
+insertNewObjectForEntityForName:inManagedObjectContext: 工厂方法，根据给定的 Entity 描述，生成相应的 NSManagedObject 对象，并插入 ManagedObjectContext 中。
-managedObjectClassName 返回映射到 Entity 的 NSManagedObject 类名
-attributesByName 以名字为 key， 返回 Entity 中对应的 Attributes
-relationshipsByName 以名字为 key， 返回 Entity 中对应的 Relationships

2）Property - NSPropertyDescription
Property 为 Entity 的特性，它相当于数据库表中的一列，或者 XML 文件中的 value-key 对中的 key。它可以描述实体数据(Attribute)，Entity之间的关系(RelationShip)，或查询属性(Fetched Property)。

 > Attribute - NSAttributeDescription
Attribute 存储基本数据，如 NSString, NSNumber or NSDate 等。它可以有默认值，也可以使用正则表达式或其他条件对其值进行限定。一个属性可以是 optional 的。
 
 > Relationship - NSRelationshipDescription 
Relationship 描述 Entity，Property 之间的关系，可以是一对一，也可以是一对多的关系。 

 > Fetched Property - NSFetchedPropertyDescription
Fetched Property 根据查询谓词返回指定 Entity 的符合条件的数据对象。

上面说的比较抽象，举个例子来说，见图：

我们有一个 CocoaDataDemo.xcdatamodeld 模型文件，应用程序根据它生成一个 NSManagedObjectModel 对象，这个模型有三个 Entity，每个 Entity 又可包含 Attribute Relationship, Feteched Property 三种类型的 Property。在本例中， Author Entity 包含两个Attribute : name 和 email，它们对于的运行时类均为 NSManagedObject；还包含一个与 Post 的 Relationship；没有设置  Feteched Property。

我们通常使用 KVC 机制来访问 Property。下面来看代码：

NSManagedObjectContext * context = [[NSApp delegate] managedObjectContext];
NSManagedObject        * author  = nil;
    
author = [NSEntityDescription insertNewObjectForEntityForName: @"Author" inManagedObjectContext: context];
[author setValue: @"[e-mail]" forKey: @"email"];

NSLog (@"The Author's email is: %@", [author valueForKey:@"email"]);

在上面代码中，我们先取得 NSManagedObjectContext， 然后调用 NSEntityDescription 的方法，以 Author 为实体模型，生成对应的 NSManagedObject 对象，插入 NSManagedObjectContext 中，然后给这个对象设置特性 email 的值。

三，运行时类与对象
> Managed Object - NSManagedObject
Managed Object 表示数据文件中的一条记录，每一个 Managed Object 在内存中对应 Entity 的一个数据表示。Managed Object 的成员为 Entity 的 Property 所描述。
比如在上面的代码，author 这个 NSManagedObject，对应名为 Author 的 Entity。

每一个 Managed Object 都有一个全局 ID（类型为：NSManagedObjectID）。Managed Object 会附加到一个 Managed Object Context，我们可以通过这个全局 ID 在 Managed Object Context 查询对应的 Managed Object。

NSManagedObject 常用方法

-entity	获取其 Entity
-objectID	获取其 Managed Object ID
-valueForKey:	获取指定 Property 的值
-setValue: forKey:	设定指定 Property 的值

> Managed Object Context - NSManagedObjectContext
Managed Object Context 的作用相当重要，对数据对象进行的操作都与它有关。当创建一个数据对象并插入 Managed Object Context 中，Managed Object Context 就开始跟踪这个数据对象的一切变动，并在合适的时候提供对 undo/redo 的支持，或调用 Persistent Store Coordinato 将变化保存到数据文件中去。

通常我们将 controller 类（如：NSArrayController，NSTreeController）或其子类与 Managed Object Context 绑定，这样就方便我们动态地生成，获取数据对象等。

NSManagedObjectContext 常用方法

-save:	将数据对象保存到数据文件
-objectWithID:	查询指定 Managed Object ID 的数据对象
-deleteObject:	将一个数据对象标记为删除，但是要等到 Context 提交更改时才真正删除数据对象
-undo	回滚最后一步操作，这是都 undo/redo 的支持
-lock	加锁，常用于多线程以及创建事务。同类接口还有：-unlock and -tryLock
-rollback	还原数据文件内容
-reset	清除缓存的 Managed Objects。只应当在添加或删除 Persistent Stores 时使用
-undoManager	返回当前 Context 所使用的 NSUndoManager
-assignObject: toPersistantStore:	由于 Context 可以管理从不同数据文件而来的数据对象， 这个接口的作用就是指定数据对象的存储数据文件（通过指定 PersistantStore 实现）
-executeFetchRequest: error:	执行 Fetch Request 并返回所有匹配的数据对象

> Persistent Store Coordinator - NSPersistentStoreCoordinator
使用 Core Data document 类型的应用程序，通常会从磁盘上的数据文中中读取或存储数据，这写底层的读写就由 Persistent Store Coordinator 来处理。一般我们无需与它直接打交道来读写文件，Managed Object Context 在背后已经为我们调用 Persistent Store Coordinator 做了这部分工作。

NSPersistentStoreCoordinator 常用方法

-addPersistentStoreForURL:configuration:URL:options:error:	装载数据存储，对应的卸载数据存储的接口为 -removePersistentStore:error:
-migratePersistentStore:toURL:options:withType:error:	迁移数据存储，效果与 "save as"相似，但是操作成功后， 迁移前的数据存储不可再使用
-managedObjectIDForURIRepresentation:	返回给定 URL所指示的数据存储的 object id，如果找不到匹配的数据存储则返回 nil
-persistentStoreForURL:	返回指定路径的 Persistent Store
-URLForPersistentStore:	返回指定 Persistent Store 的存储路径

> Persistent Document - NSPersistentDocument
NSPersistentDocument 是 NSDocument 的子类。 multi-document Core Data 应用程序使用它来简化对 Core Data 的操作。通常使用 NSPersistentDocument 的默认实现就足够了，它从 Info.plist 中读取 Document types 信息来决定数据的存储格式（xml,sqlite, binary）。

NSPersistentDocument 常用方法

-managedObjectContext	返回文档的 Managed Object Context，在多文档应用程序中，每个文档都有自己的 Context。
-managedObjectModel	返回文档的 Managed Object Model

四，Fetch Requests
Fetch Requests 相当于一个查询语句，你必须指定要查询的 Entity。我们通过 Fetch Requests 向 Managed Object Context 查询符合条件的数据对象，以 NSArray 形式返回查询结果，如果我们没有设置任何查询条件，则返回该 Entity 的所有数据对象。我们可以使用谓词来设置查询条件，通常会将常用的 Fetch Requests 保存到 dictionary 以重复利用。

示例：

NSManagedObjectContext * context  = [[NSApp delegate] managedObjectContext];
NSManagedObjectModel   * model    = [[NSApp delegate] managedObjectModel];
NSDictionary           * entities = [model entitiesByName];
NSEntityDescription    * entity   = [entities valueForKey:@"Post"];

NSPredicate * predicate;
predicate = [NSPredicate predicateWithFormat:@"creationDate > %@", date];
                         
NSSortDescriptor * sort = [[NSortDescriptor alloc] initWithKey:@"title"];
NSArray * sortDescriptors = [NSArray arrayWithObject: sort];

NSFetchRequest * fetch = [[NSFetchRequest alloc] init];
[fetch setEntity: entity];
[fetch setPredicate: predicate];
[fetch setSortDescriptors: sortDescriptors];

NSArray * results = [context executeFetchRequest:fetch error:nil];
[sort release];
[fetch release];

在上面代码中，我们查询在指定日期之后创建的 post，并将查询结果按照 title 排序返回。

NSFetchRequest 常用方法

-setEntity:	设置你要查询的数据对象的类型（Entity）
-setPredicate:	设置查询条件
-setFetchLimit:	设置最大查询对象数目
-setSortDescriptors:	设置查询结果的排序方法
-setAffectedStores:	设置可以在哪些数据存储中查询

参考资料：
Core Data Reference API listing for the Core Data classes
http://developer.apple.com/documentation/Cocoa/Reference/CoreData_ObjC/index.html

NSPredicate Reference API listing for NSPredicate
http://developer.apple.com/documentation/Cocoa/Reference/Foundation/ObjC_classic/Classes/NSPredicate.html