[iOS-Foundation] NSError

Error Handling Programming Guide

程序运行时总是会发生各种各样的错误，比如文件无法打开，文档无法解析等，在 Cocoa(Cocoa Touch) 框架中提供了 NSError 来对错误信息进行封装，它由一个 error domain，domain 内的一个 code 和包含应用自定义信息的 userInfo组成。使用NSError对象，除了封装多种错误信息，还可以归档保存，以及继承后实现自定义行为。

domain

通过 domain 属性，可以对 error 信息进行细分，domain 可以指明 error 对象代表的错误具体是发生在哪一层框架，除了指明层级的 domain，一个框架或某一模块的类都可以提供自己相关错误的 domain 用于分类，当然也包括自己实现的框架和类。另外，domain 相当于对下述代表具体错误原因的 code 提供了命名空间，避免了 code 的重复。字符串类型的 domain 推荐的格式是
com.company.framework_or_app.ErrorDomain

// 层级
NSMachErrorDomain
NSPOSIXErrorDomain
NSOSStatusErrorDomain
NSCocoaErrorDomain
// 类别
NSURLErrorDomain

code

NSInteger类型的 code 说明了 domain 下错误的具体原因。

userInfo

通过 error 对象的 userInfo 字典，可以包含一些其他的自定义信息。NSError类内置了几个关于本地化描述错误的 key，除了根据 key 从 userInfo 中取值外，NSError还提供了对应的只读属性来直接读取相关信息。当创建 error 对象时，应该在 userInfo 内也提供这几项内容。

description

通过属性localizedDescription获取 key 为NSLocalizedDescriptionKey中的内容，该项是错误的描述，可能包含 failure reason。

failure reason

通过属性localizedFailureReason获取 key 为NSLocalizedFailureReasonErrorKey中的内容，该项是错误原因的解释。

An example can help to clarify the relationship between error description and failure reason. An error object has an error description of “File could not be saved because the disk is full.” The accompanying failure reason is “The disk is full.”

recovery suggestion

通过属性localizedRecoverySuggestion获取 key 为
NSLocalizedRecoverySuggestionErrorKey中的内容，该项描述了用户如何操作以修复错误。

recovery options

通过属性localizedRecoveryOptions获取 key 为
NSLocalizedRecoveryOptionsErrorKey中的内容，该项是一个字符串数组，内容是提供给用户操作的按钮的标题，与 recovery suggestion 配合使用，默认的顺序规则是，第一个字符串应该用于最右边的按钮，以此类推。

下图展示了上述几项属性的关系

recoveryAttempter

获取 userInfo 中 key 为NSRecoveryAttempterErrorKey的值，该值是一个实现了NSErrorRecoveryAttempting协议的实例，与 recovery options 配合使用，可以让系统根据用户选择点击的按钮，执行相应的修复方法，但只能在 Cocoa 框架中使用。

helpAnchor

获取 userInfo 中 key 为NSHelpAnchorErrorKey的值，用于 Cocoa 框架中，
NSAlert类执行方法+ alertWithError:时，展示的错误提示框中 help anchor button 的标题。

针对上面这些内容，NSError提供了便捷方法
+ setUserInfoValueProviderForDomain:provider:，该方法对一个特定的 domain 可以设置一个 block，当调用上述属性而不是直接从 userInfo 中通过 key 取值时，如果对应 key 的值为空，就会执行 block 来返回一个 key 对应的值。这个方法使创建 error domain 的类，可以统一的为该 domain 提供相关描述信息，而不需要在每次创建 error 对象时都要提供 userInfo，但不应用来自定义系统的 error domain。
方法+ userInfoValueProviderForDomain:可以获取设置的 domain。

除了上述基本的描述信息外，userInfo 中还可以保存另一个NSError对象用于更深一级的错误描述，通过 key NSUnderlyingErrorKey。此外，不同的 error domain 中也会定义一些 key 对应 userInfo 中的自定义内容。

Error 的处理

如果一个方法的实现方式是接收一个NSError类型的指针为参数，并返回布尔值说明操作是否成功(有些返回对象的方法则可能返回 nil)，那么在处理 error 时，应先判断返回值是否为 false 或 nil，之后再处理 error 对象，而不应根据 error 对象是否为 nil 来作为判断依据。

NSError *theError;
BOOL success = [myDoc writeToURL:[self docURL] ofType:@"html" error:&theError];

if (success == NO) {
    NSAlert *theAlert = [NSAlert alertWithError:theError];
    [theAlert runModal];
}

NSError 对象的创建

+ errorWithDomain:code:userInfo:
- initWithDomain:code:userInfo: