阅读 164

Swift 5.x - 错误处理(中文文档)

引言

继续学习Swift文档,从上一章节:可选链接,我们学习了Swift可选链接相关的内容。现在,我们学习Swift错误处理的相关内容。由于篇幅较长,这里分篇来记录,接下来,Fighting!

如果你已经掌握这一部分内容,跳转下一章节:类型转换

错误处理

错误处理是响应程序错误状态并从错误状态中恢复的过程。 Swift在运行时为抛出,捕获,传播和操作可恢复错误提供了一流的支持。

不能保证某些操作总是能完成执行或产生有用的输出。 可选参数用于表示缺少值,但是当操作失败时,了解导致失败的原因通常很有用,以便您的代码可以做出相应的响应。

例如,考虑从磁盘上的文件读取和处理数据的任务。 此任务可能有多种方式失败,包括指定路径中不存在的文件,没有读取权限的文件或未以兼容格式编码的文件。 通过区分这些不同的情况,程序可以解决一些错误,并向用户传达无法解决的任何错误。

注意
Swift中的错误处理与使用Cocoa和Objective-C中的NSError类的错误处理模式互操作。 有关此类的更多信息,请参见Handling Cocoa Errors in Swift

1 表示和抛出错误

在Swift中,错误由符合Error协议的类型的值表示。 此空协议表示可以将类型用于错误处理。

Swift枚举特别适合于对一组相关的错误条件进行建模,其关联值允许传达有关错误性质的其他信息。 例如,您可以通过以下方式表示在游戏中操作自动售货机的错误情况:

enum VendingMachineError: Error {
    case invalidSelection
    case insufficientFunds(coinsNeeded: Int)
    case outOfStock
}
复制代码

抛出错误可让您指出发生了意外情况,并且正常的执行流程无法继续进行。 您使用throw语句抛出错误。 例如,以下代码抛出错误,以指示自动售货机需要另外五个硬币:

throw VendingMachineError.insufficientFunds(coinsNeeded: 5)
复制代码

2 处理错误

抛出错误时,周围的一些代码段必须负责处理错误-例如,通过更正问题,尝试其他方法或将故障通知用户。

Swift中有四种处理错误的方法。 您可以将错误从函数传播到调用该函数的代码,使用do-catch语句处理错误,将错误作为可选值处理,或者断言。 每种方法在下面的部分中进行介绍。

当一个函数抛出错误时,它会改变程序的流程,因此重要的是,您必须快速识别代码中可能抛出错误的位置。 要在代码中标识这些位置,在一段代码中可以编写try关键字-还是try? 或try! ,该代码调用可能会抛出错误的函数,方法或初始化方法。 这些关键字在以下各节中介绍。

注意
使用try,catch和throw关键字,Swift中的错误处理类似于其他语言中的异常处理。 与许多语言(包括Objective-C)中的异常处理不同,Swift中的错误处理不涉及展开调用堆栈,该过程在计算上可能会非常昂贵。 这样,throw语句的性能特征可与return语句的性能特征相媲美。

2.1 使用throwing函数传递错误

为了表明函数,方法或初始化程序可能引发错误,请在函数的参数后的声明中写throws关键字。 标有throws的函数称为throwing函数。 如果函数指定了返回类型,则在返回箭头(->)之前编写throws关键字。

func canThrowErrors() throws -> String

func cannotThrowErrors() -> String
复制代码

抛出函数会将内部抛出的错误传递到调用它的范围。

注意
只有throwing函数可以传递错误。 抛出于非抛出函数内部的任何错误都必须在函数内部进行处理。

在下面的示例中,VendingMachine类具有vend(itemNamed :)方法,如果所请求的项目不可用,没有库存或成本超过当前的存入金额,则抛出适当的VendingMachineError:

struct Item {
    var price: Int
    var count: Int
}

class VendingMachine {
    var inventory = [
        "Candy Bar": Item(price: 12, count: 7),
        "Chips": Item(price: 10, count: 4),
        "Pretzels": Item(price: 7, count: 11)
    ]
    var coinsDeposited = 0

    func vend(itemNamed name: String) throws {
        guard let item = inventory[name] else {
            throw VendingMachineError.invalidSelection
        }

        guard item.count > 0 else {
            throw VendingMachineError.outOfStock
        }

        guard item.price <= coinsDeposited else {
            throw VendingMachineError.insufficientFunds(coinsNeeded: item.price - coinsDeposited)
        }

        coinsDeposited -= item.price

        var newItem = item
        newItem.count -= 1
        inventory[name] = newItem

        print("Dispensing \(name)")
    }
}
复制代码

vend(itemNamed :)方法的实现使用保护性语句来提前退出该方法,如果不满足购买零食的任何要求,则会抛出适当的错误。 由于throw语句会立即转移程序控制权,因此只有在满足所有这些要求的情况下,才可以出售商品。

因为vend(itemNamed :)方法传递了它抛出的所有错误,所以任何调用此方法的代码都必须处理错误(使用do-catch语句,try?或try!)或继续传递它们。 例如,下面的示例中的buyFavoriteSnack(person:vendingMachine :)也是一个throwing函数,并且vend(itemNamed :)方法抛出的任何错误都将传递到buyFavoriteSnack(person:vendingMachine :)函数。

let favoriteSnacks = [
    "Alice": "Chips",
    "Bob": "Licorice",
    "Eve": "Pretzels",
]
func buyFavoriteSnack(person: String, vendingMachine: VendingMachine) throws {
    let snackName = favoriteSnacks[person] ?? "Candy Bar"
    try vendingMachine.vend(itemNamed: snackName)
}
复制代码

在此示例中,buyFavoriteSnack(person:vendingMachine :)函数查找给定人员最喜欢的零食,并尝试通过调用vend(itemNamed :)方法为他们购买零食。 由于vend(itemNamed :)方法可能会抛出错误,因此会在其前面使用try关键字进行调用。

Throwing初始化方法可以像抛出函数一样传播错误。 例如,以下清单中PurchasedSnack结构体的初始化方法在初始化过程中调用了throwing函数,它通过将错误传递给调用者来处理遇到的任何错误。

struct PurchasedSnack {
    let name: String
    init(name: String, vendingMachine: VendingMachine) throws {
        try vendingMachine.vend(itemNamed: name)
        self.name = name
    }
}
复制代码

2.2 使用Do-Catch处理错误

您可以使用do-catch语句通过运行代码块来处理错误。 如果do子句中的代码引发错误,则将其与catch子句进行匹配,以确定其中哪一个可以处理该错误。

这是do-catch语句的一般形式:

do {
    try expression
    statements
} catch pattern 1 {
    statements
} catch pattern 2 where condition {
    statements
} catch pattern 3, pattern 4 where condition {
    statements
} catch {
    statements
}
复制代码

在catch之后编写一个模式,以指示该子句可以处理的错误。 如果catch子句没有模式,则该子句会匹配任何错误,并将错误绑定到名为error的本地常量。 有关模式匹配的更多信息,请参见Patterns

例如,以下代码与VendingMachineError枚举的所有三种case匹配。

var vendingMachine = VendingMachine()
vendingMachine.coinsDeposited = 8
do {
    try buyFavoriteSnack(person: "Alice", vendingMachine: vendingMachine)
    print("Success! Yum.")
} catch VendingMachineError.invalidSelection {
    print("Invalid Selection.")
} catch VendingMachineError.outOfStock {
    print("Out of Stock.")
} catch VendingMachineError.insufficientFunds(let coinsNeeded) {
    print("Insufficient funds. Please insert an additional \(coinsNeeded) coins.")
} catch {
    print("Unexpected error: \(error).")
}
// Prints "Insufficient funds. Please insert an additional 2 coins."
复制代码

在上面的示例中,在try表达式中调用了buyFavoriteSnack(person:vendingMachine :)函数,因为它可能抛出错误。如果抛出错误,执行将立即转移到catch子句,该子句决定是否允许继续传递。如果没有匹配的模式,则错误将被最终的catch子句捕获,并绑定到本地错误常量。如果没有潘总出错误,则执行do语句中的其余语句。

catch子句不必处理do子句中的代码可能抛出的所有可能的错误。如果没有任何catch子句处理该错误,则该错误会传递到周围的范围。但是,传递的错误必须由周围的范围来处理。在非抛出函数中,一个封闭的do-catch语句必须处理该错误。在throwing函数中,封闭的do-catch语句或调用者必须处理该错误。如果错误没有得到处理就传递到顶级范围,则会出现运行时错误。

例如,可以编写上面的示例,以便所有不是VendingMachineError的错误都可以被调用函数捕获:

func nourish(with item: String) throws {
    do {
        try vendingMachine.vend(itemNamed: item)
    } catch is VendingMachineError {
        print("Couldn't buy that from the vending machine.")
    }
}

do {
    try nourish(with: "Beet-Flavored Chips")
} catch {
    print("Unexpected non-vending-machine-related error: \(error)")
}
// Prints "Couldn't buy that from the vending machine."
复制代码

在nourish(with :)函数中,如果vend(itemNamed :)抛出VendingMachineError枚举case之一的错误,则nourish(with :)通过打印消息来处理错误。 否则,nourish(with :)会将错误传递到其调用的区域。 然后,该错误由常规catch子句捕获。

捕获多个相关错误的另一种方法是在捕获后列出它们,并用逗号分隔。 例如:

func eat(item: String) throws {
    do {
        try vendingMachine.vend(itemNamed: item)
    } catch VendingMachineError.invalidSelection, VendingMachineError.insufficientFunds, VendingMachineError.outOfStock {
        print("Invalid selection, out of stock, or not enough money.")
    }
}
复制代码

注:用逗号隔开,在实际撸代码时,会报错

eat(item :)函数列出了要捕获的自动售货机错误,其错误文本与该列表中的项目相对应。 如果抛出了三个列出的错误中的任何一个,则此catch子句通过打印一条消息来处理它们。 其他任何错误都会传播到周围的范围,包括以后可能会添加的自动售货机错误。

2.3 将错误转换为可选值

可以用try?通过将其转换为可选值来处理错误。 如果在调用try?时抛出错误,这个表达式的值就为nil。 例如,在以下代码中,x和y具有相同的值和行为:

func someThrowingFunction() throws -> Int {
    // ...
}

let x = try? someThrowingFunction()

let y: Int?
do {
    y = try someThrowingFunction()
} catch {
    y = nil
}
复制代码

如果someThrowingFunction()引发错误,则x和y的值为nil。 否则,x和y的值就是函数返回的值。 注意,x和y是someThrowingFunction()返回的任何类型的可选参数。 这里的函数返回一个整数,因此x和y是可选的整数。

使用try?,当您要以相同方式处理所有错误时,可以编写简洁的错误处理代码。 例如,以下代码使用几种方法来获取数据,如果所有方法均失败,则返回nil。

func fetchData() -> Data? {
    if let data = try? fetchDataFromDisk() { return data }
    if let data = try? fetchDataFromServer() { return data }
    return nil
}
复制代码

2.4 禁用错误传递

有时,您知道抛出函数或方法实际上不会在运行时抛出错误。 在那种情况下,您可以编写try! 在表达式前禁用错误传播,并将调用包装在不会引发任何错误的运行时断言中。 如果实际上引发了错误,则会收到运行时错误。

例如,以下代码使用loadImage(atPath :)函数,该函数会在给定的路径上加载图像资源,或者在无法加载图像时抛出错误。 在这种情况下,由于该image是随应用程序一起提供的,因此在运行时不会引发任何错误,因此应该禁用错误传播。

let photo = try! loadImage(atPath: "./Resources/John Appleseed.jpg")
复制代码

3 指定清理措施

您可以在代码执行离开当前代码块之前使用defer语句执行一组语句。该语句使您可以执行任何必要的清除操作,而不管执行如何离开当前代码块(无论是由于引发错误还是由于诸如return或break之类的语句而离开)。例如,您可以使用defer语句来确保关闭文件描述符并释放手动分配的内存。

一个defer语句将执行推迟到当前范围退出。该语句由defer关键字和以后要执行的语句组成。延迟的语句可能不包含任何将控制权移出该语句的代码,例如break或return语句,或引发错误。延后操作的执行顺序与您在源代码中编写的顺序相反。也就是说,第一个defer语句中的代码最后执行,第二个defer语句中的代码倒数第二执行,依此类推。源代码顺序中的最后一个defer语句将首先执行。

func processFile(filename: String) throws {
    if exists(filename) {
        let file = open(filename)
        defer {
            close(file)
        }
        while let line = try file.readline() {
            // Work with the file.
        }
        // close(file) is called here, at the end of the scope.
    }
}
复制代码

上面的示例使用defer语句来确保open(_ :)函数具有对close(_ :)的对应调用。

注意
即使没有错误处理代码,也可以使用defer语句。

总结

这章节内容主要讲的是错误处理机制,在开发过程中,可以使用这个机制来捕获一些意外的错误,并进行相应的处理(发给服务器或容错处理或提示用户),来避免程序奔溃。处理错误的方式主要有:

  • 使用throwing函数,在方法参数后面添加throws,若有返回值,在括号的后面添加throws,使用throw捕获错误,用于定位错误代码的位置。
  • 使用do-catch处理错误,表达式为:
do {
    try expression
    statements
} catch pattern 1 {
    statements
} catch pattern 2 where condition {
    statements
} catch pattern 3, pattern 4 where condition {
    statements
} catch {
    statements
}
复制代码
  • 将错误转换为可选值:使用try?,如:
let x = try? someThrowingFunction()
复制代码
  • 禁用错误处理:使用try!,如:
let photo = try! loadImage(atPath: "./Resources/John Appleseed.jpg")
复制代码
  • 指定清理措施:使用defer关键词,延迟操作;即使没有错误处理代码,也可以使用defer。

好了,大概的内容就是这些,喜欢的朋友点个赞呦,谢谢啦~

上一章节:可选链接

下一章节:类型转换

参考文档: Swift - Error Handling