【译】defer-panic-and-recover

Go 有通用的控制流程：if，for，switch，goto。它也有go语句用于让代码运行在单独的协程。这里我将讨论一些不常见的问题：defer，panic 和 recover。

defer语句将函数调用推送到列表。这个保存调用的列表在函数返回后执行。defer通常用于简化执行各种清理操作。

例如，让我们看一个打开两个文件并将一个文件的内容复制到另一个文件的函数：

func CopyFile(dstName, srcName string) (written int64, err error) {
    src, err := os.Open(srcName)
    if err != nil {
        return
    }

    dst, err := os.Create(dstName)
    if err != nil {
        return
    }

    written, err = io.Copy(dst, src)
    dst.Close()
    src.Close()
    return
}

这个能工作，但有一个漏洞。如果调用os.Create 失败，函数将在不关闭源文件的情况下返回。这可以轻松补救，在第二个return 语句之前调用src.Close，但如果函数更复杂，则问题可能不那么容易被注意到和解决。通过引入defer语句，我们可以确保文件始终关闭：

func CopyFile(dstName, srcName string) (written int64, err error) {
    src, err := os.Open(srcName)
    if err != nil {
        return
    }
    defer src.Close()

    dst, err := os.Create(dstName)
    if err != nil {
        return
    }
    defer dst.Close()

    return io.Copy(dst, src)
}

defer语句允许我们在打开每个文件后立即考虑关闭它，从而保证无论函数中的return语句数量是多少，这些文件都将被关闭。

defer语句的行为是简单直接且可预测的。有三个简单的规则：

1、当defer被声明时，其参数就会被计算。

在此示例中，当Println调用被defer声明，将计算表达式“i”。defer调用将在函数返回后打印“0”。

2、defer的执行顺序为先进后出。

此函数打印“3210”：

func b() {
    for i := 0; i < 4; i++ {
        defer fmt.Print(i)
    }
}

3、defer可以读取有名返回值。

在此示例中，defer函数在函数返回后递增返回值i。因此，此函数返回2：

func c() (i int) {
    defer func() { i++ }()
    return 1
}

这对于修改函数的错误返回值很方便；我们很快就会看到一个这样的例子。

Panic是一个内置功能，可以停止普通的控制流程并开始Panicing。当函数F调用panic时，F的执行会停止，F中的任何defer函数都正常执行，然后F返回给其调用方。对于调用方，F的表现就像是panic。该过程继续在堆栈中向上移动，直到当前协程 中的所有函数都返回，此时程序崩溃。可以通过直接调用panic来启动panic。它们也可能是由运行时错误引起的，例如越界数组访问。

recover是一个内置功能，可以重新获得对正在panic的协程的控制。recover仅在defer函数中有用。在正常执行期间，recover调用将返回nil，并且没有其他效果。如果当前协程 出现panic，则调用recover将捕获panic提供的值并恢复正常执行。

下面是一个示例程序，演示了panic和defer的机制：

package main

import "fmt"

func main() {
    f()
    fmt.Println("Returned normally from f.")
}

func f() {
    defer func() {
        if r := recover(); r != nil {
            fmt.Println("Recovered in f", r)
        }
    }()
    fmt.Println("Calling g.")
    g(0)
    fmt.Println("Returned normally from g.")
}

func g(i int) {
    if i > 3 {
        fmt.Println("Panicking!")
        panic(fmt.Sprintf("%v", i))
    }
    defer fmt.Println("Defer in g", i)
    fmt.Println("Printing in g", i)
    g(i + 1)
}

函数g获取int i，如果i大于 3，则会出现panic，否则它将使用参数i+1调用自己。函数f defer调用recover并输出恢复值的函数（如果该值为非 nil）。在继续阅读之前，请尝试想象此程序的输出可能是什么。

程序将输出：

Calling g.
Printing in g 0
Printing in g 1
Printing in g 2
Printing in g 3
Panicking!
Defer in g 3
Defer in g 2
Defer in g 1
Defer in g 0
Recovered in f 4
Returned normally from f.

如果我们从f中删除derfer函数，则不会恢复panic，并在到达协程调用堆栈顶部时终止程序。这个修改后的程序将输出：

Calling g.
Printing in g 0
Printing in g 1
Printing in g 2
Printing in g 3
Panicking!
Defer in g 3
Defer in g 2
Defer in g 1
Defer in g 0
panic: 4

panic PC=0x2a9cd8
[stack trace omitted]

有关panic和recover的真实例子，请参阅Go标准库中的json 包。它使用一组递归函数对接口进行编码。如果在遍历该值时发生错误，则会调用panic将堆栈展开到最上层的函数调用，该调用将从panic 中恢复并返回适当的错误值（请参阅 encode.go 中 encodeState 类型的“error”和“marshal”方法）。

Go库中的约定是，即使包在内部使用panic，其对外的API仍会展示显式错误返回值。

defer的其他用法（除了前面给出的file.Close例子）还包括释放互斥锁：

mu.Lock()
defer mu.Unlock()

打印页脚：

printHeader()
defer printFooter()

以及更多。

总之，defer语句（有/没有panic和recover）为控制流提供了一种不同寻常且功能强大的机制。它可用于对其他编程语言中特殊用途结构实现的许多特性进行建模。试试吧。

---

原文 https://golang.google.cn/blog/defer-panic-and-recover