《iOS组件与框架——iOS SDK高级特性剖析》——第8章，第8.3节UIDocument简介

本节书摘来自异步社区《iOS组件与框架——iOS SDK高级特性剖析》一书中的第8章，第8.3节UIDocument简介，作者 【美】Kyle Richter , Joe Keeley，更多章节内容可以访问云栖社区“异步社区”公众号查看

8.3 UIDocument简介
iOS组件与框架——iOS SDK高级特性剖析
应用的功能围绕着以用户为中心的文档式数据展开时，创建UIDocument子类很合适。UIDocument用于自动完成与文档交互时所需的众多典型功能。例如，UIDocument支持自动保存，还支持后台加载和保存，以免影响主队列，进而降低用户界面的响应速度。另外，UIDocument将加载和保存逻辑抽象为简单的方法调用，让开发人员只需编写在文档数据和NSData之间进行转换的简单逻辑。对本章来说最重要的是，UIDocument还自动完成与iCloud的交互。

8.3.1 创建UIDocument子类
在示例应用中，用户创建的每条备忘录都是UIDocument子类ICFMyNoteDocument的实例。UIDocument子类应实现方法contentsForType:error:和loadFromContents: ofType:error:，并实现修改跟踪以启用UIDocument的自动保存功能。在示例应用中，由于备忘录只在一个字符串变量中存储备忘录内容，因此这些方法实现起来很容易。

在方法contentsForType:error:中，首先检查是否给myNoteText指定了值，如果没有，就提供一个默认值以防应用崩溃。接下来，将myNoteText转换为NSData并返回转换结果。这个NSData就是UIDocument将保存的内容。方法loadFromContents: ofType:error:执行的操作与此相反。

UIDocument以NSData格式返回保存的内容，而这个方法将其转换为子类的属性。它检查内容的长度，如果没有内容，就将myNoteText设置为空字符串，否则将NSData转换为NSString，并使用转换结果填充属性myNoteText。最后，这个方法告诉委托文档发生了变化，让它能够采取合适的措施，如使用新加载的数据更新用户界面。

为启用UIDocument提供的自动保存功能，子类需要实现变更跟踪。变更跟踪是使用UIDocument提供的undoManager启用的。

注意到不需要执行额外的操作就能自动保存：应用不需要实际实现撤销功能；给undoManager指定操作（action）后，自动保存功能便启用了。

8.3.2 与UIDocument交互
要创建UIDocument子类的实例，首先需要确定表示文件保存位置的URL。用户轻按示例应用中的加号按钮时，将调用主视图控制器的方法newMyNoteName，由它决定新备忘录将使用的文件名。这个方法在MyNote后面加上一个数字来生成文件名，并检查它是否存在；如果存在，就将数字加1，直到生成的文件名未被使用。接下来，将这个文件名附加到iCloud目录URL的后面，得到文件的完整路径。然后，将这个URL传递给详细视图控制器。在详细视图控制器中，方法configureView使用NSFileManager判断这个文件是否存在，并据此创建或加载它。

为创建文档，调用了UIDocument的方法saveToURL:forSaveOperation: completionHandler:，并将保存操作指定为UIDocumentSaveForCreating。为打开既有文档，调用了方法openWith CompletionHandler，并指定了一个结束块。在这里，结束块将更新用户界面，并将文本视图设置为第一响应者以便开始编辑备忘录。请注意，这里检查了文档的documentState；这个属性指出文档可编辑还是处于需要解决的冲突状态。冲突状态将在本章后面介绍，详情请参阅8.4.2节。