Swift中的错误是如何映射到NSError的？

把Swift中的Error移植到Objective-C，相对而言倒是个简单很多的事情。Swift会根据enum的名字自动生成默认的error domain，并从0开始，为每一个enum中的case设置error code。

为了看到映射的结果，首先，我们得把上一节中的struct Car改成一个NSObject的派生类，并给它添加一个memberwise init方法：

class Car: NSObject {
    var fuelInLitre: Double

    init(fuelInLitre: Double) {
        self.fuelInLitre = fuelInLitre
    }

    // ...
}

然后，在Sensor.m中，我们先包含Swift类在Objective-C中的头文件：

#import "SwiftErrorsInOC-Swift.h"

就可以在Objective-C中使用class Car了。然后，我们定义一个全局函数startACar()：

// In Sensor.m
NSObject* startACar() {
    Car *car = [[Car alloc] initWithFuel:5];

    NSError *err = nil;
    [car startAndReturnError: &err];

    if (err != nil) {
        NSLog(@"Error code: %ld", (long)err.code);
        NSLog(@"Error domain: %@", err.domain);

        return nil;
    }

    return car;
}

在上面的代码里可以看到，由于Swift中的Car.start()是一个throws方法，在OC里，它会被添加一个AndReturnError后缀，并接受一个NSError **类型的参数。然后，当err不为nil时，我们向控制台打印了start抛出的错误映射到OC的结果。

由于car对象的fuel只有5，所以这个调用是一定会产生NSError的。为了在Swift中调用这个方法，我们在Sensor.h中添加下面的声明：

// In Sensor.h
NSObject* startACar();

然后，在main.swift里，我们直接调用startACar，就能在控制台看到类似这样的结果：

Swift errors in oc

在这里，自动生成的NSError对象的code是0，domain是“项目名.Swift中enum的名字”。当然，这只是最基本的映射。在Swift 3里，除了Error之外，还添加了一些新的protocol，帮助我们进一步定制自动生成的NSError对象的属性。

LocalizedError

第一个要介绍的，是LocalizedError，它的定义是这样的：

protocol LocalizedError : Error {
  /// A localized message describing what error occurred.
  var errorDescription: String? { get }

  /// A localized message describing the reason for the failure.
  var failureReason: String? { get }

  /// A localized message describing how one might recover from the failure.
  var recoverySuggestion: String? { get }

  /// A localized message providing "help" text if the user requests help.
  var helpAnchor: String? { get }
}

并且，Swift为LocalizedError中的每一个属性都提供了默认值nil，因此，你可以只定义自己需要的部分就好了。例如，对于我们的CarError来说，可以把它改成这样：

enum CarError: LocalizedError {
    case outOfFuel
}

然后，通过extension给它添加额外信息：

extension CarError: LocalizedError {
    var recoverySuggestion: String? {
        return "Switch to e-power mode"
    }
}

这样，在OC的startACar实现里，我们就可以通过访问NSError的localizedRecoverySuggestion属性来读取恢复建议了：

NSObject* startACar() {
    // ...
    if (err != nil) {
        // ...
        NSLog(@"Recovery suggestion: %@", 
            err.localizedRecoverySuggestion);
        return nil;
    }

    // ...
}

CustomNSError

另外一个加入到Swift的protocol是CustomNSError，我们可以通过它自定义NSError中的code / domain / userInfo。

extension CarError: CustomNSError {
    static let errorDomain = "CarErrorDomain"

    var errorCode: Int {
        switch self {
        case .outOfFuel:
            return -100
        }
    }

    var errorUserInfo: [String: Any] {
        switch self {
        case .outOfFuel:
            return [
                "LocalizedDescription":
                "U r running out of fuel"
            ]
        }
    }
}

尽管在SE-0112的约定里，errorDomain是一个computed property，但至少在XCode 8.2.1中，它只能定义成一个type property。不过想来也合理，一个NSError对象只需要一个error code就可以了，我们也没什么计算它的必要。

接下来，把startACar的定义改成这样：

NSObject* startACar() {
    // ...
    if (err != nil) {
        NSLog(@"Error domain: %@", err.domain);
        NSLog(@"Error code: %ld", (long)err.code);
        NSLog(@"Error userInfo: %@", err.userInfo);
    }

    // ...
}

我们就能在控制台看到自定义的结果了：

Swift errors in oc

Swift中的错误是如何映射到NSError的？