Swift 2.0中的错误处理

本文翻译自Error Handling in Swift 2.0

Swift主设计师在苹果今年的WWDC上发布Swift 2.0时指出2.0版本主要提升了语言的三个方面:fundamentals,safety和beautiful code.除去新特性、改进、美化等,其中一条对你的swift 1.x 代码有影响的要数错误处理了.

因为你无法不写错误处理.想要使用Swift 2.0则必须要有它.而且它和以前在Cocoa和Cocoa Touch中使用NSError方法有所不同.

• 历史起源

众所周知,Swift是被用来替代Objective-C开发OS X和iOS应用的.在早期的版本中,Objective-C并没有原生的错误处理.后来有了NSException类和NS_DURING,NS_HANDLER，NS_ENDHANDLER宏出现时才有了异常处理.这套方案被称为"经典的异常处理",且这些宏是以C函数中的setjmp()和longjmp()为基础.
捕捉异常的结构如下所示,其中NS_DURING和NS_HANDLER宏内抛出的异常会执行NS_HANDEL和NS_ENDHANDLER宏之间的代码.

NS_DURING
    // Call a dangerous method or function that raises an exception:
    [obj someRiskyMethod];
NS_HANDLER
    NSLog(@"Oh no!");
    [anotherObj makeItRight];
NS_ENDHANDLER

快速获取异常的方法为(现在仍可用):

- (void)someRiskyMethod
{
    [NSException raise:@"Kablam"
                format:@"This method is not implemented yet. Do not call!"];
}

如你所料,这样的异常处理方式给早期的Cocoa开发者带来很多测试工作.然而这些程序员仍然可以保持高下巴,因为他们很少用到它.在Cocoa和Cocoa Touch中,异常处理被降级到用来标记灾难性的、不可恢复的错误,例如程序员犯的错误.上面的-someRiskyMethod就是个好的例子,是因为实现还没准备好而引发的一个异常.Cocoa和Cocoa Touch框架里,用NSError处理的可恢复错误会在待会讨论到.

• 原生异常处理

我想苹果从Objective-C经典的异常处理中尝到了苦头,于是在OS X 10.3时发布了原生异常处理,早于iOS的任何版本.它是通过基本嫁接C++异常到Objective-C中所完成的.异常处理结构现在看起来是下面的样子:

@try {
    [obj someRiskyMethod];
}
@catch (SomeClass *exception) {
    // Handle the error.
    // Can use the exception object to gather information.
}
@catch (SomeOtherClass *exception) {
    // ...
}
@catch (id allTheRest) {
    // ...
}
@finally {
    // Code that is executed whether an exception is thrown or not.
    // Use for cleanup.
}

原生异常处理通过不同的@catch blocks来处理不同的异常类型.而无论@try block里的结果如何都会执行@finally block里的代码.
虽然提高NSException的使用可以达到同原生异常处理同样的效果,但通过@throw<expression>的方式使抛出的异常更加明确.而NSException的异常却是由众多原因导致的.

• NSError

虽然原生的异常处理相较于传统的异常处理有诸多优势,但Cocoa和Cocoa Touch开发者仍然很少用到,仅在不可恢复的编程错误时使用.可恢复的编程错误,早期时用NSError来处理异常.NSError模式在Swift 1.x时仍可用.

在Swift 1.x中,Cocoa和Cocoa Touch函数和方法可能会失败,通过给对象返回一个布尔值false或者nil来表示失败.此外,NSErrorPointer被当做参数传递到返回的错误信息中.一个典型的例子如下:

// A local variable to store an error object if one comes back:
var error: NSError?
// success is a Bool:
let success = someString.writeToURL(someURL,
                                    atomically: true,
                                    encoding: NSUTF8StringEncoding,
                                    error: &error)
if !success {
    // Log information about the error:
    println("Error writing to URL: \(error!)")
}

编程错误可以被标记为Swift标准库中的fatalError("Error message")方法来将生成的错误信息log到控制台并无条件终止执行.另外还包括assert(),assertionFailure(),precondition()和preconditionFailure()方法.

当Swift首次发布时,一些Apple平台之外的开发者煽风点火.他们声称Swift并不能成为真正的语言,因为它缺乏异常处理机制.当然,Cocoa和Cocoa Touch开发者知道,有NSError和NSException可用.私以为,苹果还在思考实现error/exception处理的正确方式.且苹果推迟了Swift的开源,直到问题解决.这些障碍随着Swift 2.0的发布而被清除.

• Swift 2.0中的错误处理

如果你想在Swift 2.0中抛出个错误,这个对象必须遵从ErrorType协议.如你所想,NSError遵从这个协议.使用枚举来定义不同的错误类型.

enum AwfulError: ErrorType {
    case Bad
    case Worse
    case Terrible
}

继而,一个函数或方法通过关键字throws标记处理抛出的一个或多个错误:

func doDangerousStuff() throws -> SomeObject {
    // If something bad happens throw the error:
    throw AwfulError.Bad

    // If something worse happens, throw another error: 
    throw AwfulError.Worse

    // If something terrible happens, you know what to do: 
    throw AwfulError.Terrible

    // If you made it here, you can return:
    return SomeObject()
}

为了获得这些错误,一个新的do-catch语句出现了:

do {
    let theResult = try obj.doDangerousStuff()
}
catch AwfulError.Bad {
    // Deal with badness.
}
catch AwfulError.Worse {
    // Deal with worseness.
}
catch AwfulError.Terrible {
    // Deal with terribleness.
}
catch ErrorType {
    // Unexpected error!
}

do-catch语句有点像switch,通过详尽的引起错误的清单来捕捉相对应的错误类型.另外注意try关键字的使用,用来标记抛出异常的代码位置,以使你在阅读代码的时候知道哪处代码容易出错.
关键字try的另一种用法为try!.该关键字适用于程序员的再次错误.如果你标记一个异常call为try!,表示告诉编译器这个错误将永不会出现,不需要捕捉到.如果在此出现了错误,则程序将停止运行,你需要开始debug.

let theResult = try! obj.doDangerousStuff()

• 与Cocoa和Cocoa Touch框架的交互

现在的问题是,如何在Swift 2.0中处理爷爷辈的NSError API?苹果已经在Swift 2.0中做了统一的工作,并且做好了将来用Swift写框架的准备.
Cocoa和Cocoa Touch函数和方法产生的NSError时会自动转换为Swift新的错误处理机制.
例如,下面的NSString的初始化在Swift 1.x中有以下signature:

convenience init?(contentsOfFile path: String,
                  encoding enc: UInt,
                  error error: NSErrorPointer)

Swift 2.0中signature转换为:

convenience init(contentsOfFile path: String,
                 encoding enc: UInt) throws

注意到在Swift 2.0中,初始化不再被标记为可以失败,且不需要一个NSErrorPointer参数,并有个throws来标记可能存在错误.使用新的signature的例子如下:

do {
    let str = try NSString(contentsOfFile: "Foo.bar",
                           encoding: NSUTF8StringEncoding)
}
catch let error as NSError {
    print(error.localizedDescription)
}

可以看到错误发生时产生了一个NSError信息,此时你可以使用你所熟知的API了.实际上,任何ErrorType都能被转换为NSError.

• 最后来谈谈@finally?

细心的读者也许注意到在Swift 2.0中介绍的新的语句为do-catch,而不是do-catch-finally.当你需要执行不论是否发生错误都要执行的语句时怎么办?为了解决这个问题,现在你可以使用defer语句来延迟执行一个block代码直到当前作用域退出.

// Some scope:
{
    // Get some resource.

    defer {
        // Release resource.
    }

    // Do things with the resource.
    // Possibly return early if an error occurs.

} // Deferred code is executed at the end of the scope.

Swift 2.0在融合以前的Cocoa和Cocoa Touch错误处理外使其进入了一个使众多开发者更加熟悉的现代化的操作方式.统一的操作方式使Swift语言和它所继承的框架能够获得良好的发展.

Girl学iOS100天 第22天