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实现里,我们就可以通过访问NSErrorlocalizedRecoverySuggestion属性来读取恢复建议了:

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

    // ...
}

CustomNSError

另外一个加入到Swift的protocolCustomNSError,我们可以通过它自定义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
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,793评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,567评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,342评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,825评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,814评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,680评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,033评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,687评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,175评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,668评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,775评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,419评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,020评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,206评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,092评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,510评论 2 343

推荐阅读更多精彩内容