Golang 语言怎么使用 panic 函数？

01

介绍

panic 是一个 Go 内置函数，它用来停止当前常规控制流并启动 panicking（运行时恐慌）过程。当函数 F 调用 panic 函数时，函数 F 的执行停止，函数 F 中已进行了求值的 defer 函数都将得到正常执行，然后函数 F 将控制权返还给其调用者。对于函数 F 的调用者而言，函数 F 之后的行为就如同调用者调用的函数是 panic 一样，该 panicking（运行时恐慌）过程将继续在栈上进行下去，直到当前 goroutine 中的所有函数都返回为止，此时程序将崩溃退出。

02

panic 触发方式和引发的后果

Golang 语言是静态强类型语言，在编译时，大多数问题就会被发现。但是一些会触发 panic 的问题只能在运行时才会被发现。

panic 触发方式有两种，除了上面讲到的，在运行时遇到错误触发 panic，比如越界访问数组，不相同类型的变量强制类型转换等，还可以通过直接调用 panic 函数触发 panic。

怎么通过显式调用 panic 函数触发 panic，panic 函数接收一个 interface{} 空接口类型的参数，也就是说，panic 函数可以接收一个任意类型的参数，代码如下：

func panic(v interface{})

什么时候通过显式调用 panic 函数触发 panic？

虽然 panic 可以使程序崩溃，我们尽量少用 panic，但是少用不等于不用。阅读过 golang 源码的读者应该发现在 golang 标准库代码中有显式调用 panic 函数的代码片段，比如 golang 标准库的 json 包。

请参阅在 encode.go 文件中 encodeState 类型的 error 和 marshal 方法的代码。

另外，当我们在程序中处理会影响程序正确运行的错误时，也可以考虑使用显式调用 panic 函数来返回错误。

不管是显式调用 panic 函数，还是运行时检测到违法情况自动触发 panic，都会导致程序崩溃。那么，我们应该怎么处理 panic 呢？

通常的做法是使用 defer 和 recover 捕获 panic，将 panic 错误写入日志文件，将程序恢复正常执行。需要注意的是，panic 是谁触发谁捕获，当我们调用三方库时，调用方是不会考虑处理三方库的 panic 异常。

但是，对于一些严重的 panic 异常，例如 main 函数和 init 函数中执行的程序代码，不应该使用 recover 捕获并将程序恢复正常执行，而是应该及时让 panic 执行，使程序崩溃，及时暴露出问题并解决。

03

使用 defer 和 recover 捕获 panic

defer 是什么？

defer 语句将延迟调用函数保存到列表上。defer 所在的函数返回后，将执行保存的延迟调用函数列表。

defer 延迟函数有 3 个规则：

1. 在对 defer 语句求值时，将对 defer 延迟调用的函数的参数求值。
2. defer 所在的函数返回后，将按照后进先出的顺序执行 defer 保存的延迟调用函数。
3. defer 延迟调用函数可以读取并分配给返回函数的命名返回值。

注意：关于 defer 的知识点还有很多，感兴趣的读者可以查阅相关资料进一步了解。因为本文的重点是讲述 panic，所以不再对 defer 做过多的赘述。

recover 是什么？

recover 是一个 Go 内置函数，可以重新获取对一个运行时恐慌的 goroutine 的控制。recover 仅在 defer 延迟函数内部使用。在正常执行程序中，调用 recover 函数，将返回 nil。如果当前 goroutine 处于恐慌状态，调用 recover 会捕获提供给 panic 的值并恢复正常执行。

使用 defer 和 recover 捕获 panic

通常，我们不会去捕获运行时 panic，发生 panic 异常，直接让程序崩溃即可，及时根据 panic 提供的信息，修复异常。但是，一些情况下，我们还是需要捕获 panic，比如在程序发生 panic 异常时，释放资源。比如关闭文件或者释放锁。

上面我们讲到，调用 recover 函数可以捕获 panic，但是 recover 函数仅在 defer 函数内部使用。所以想要使用 recover 捕获 panic，我们需要结合 defer 一起使用。而且，程序在触发 panic 异常后，虽然不会继续往下执行代码，但是可以执行 defer 调用的函数，示例代码如下：

未使用 defer 调用匿名函数的 recover 捕获 panic：

func main() {
    fmt.Println("this is a panic example")
    panic("this is a panic")
    r := recover()
    fmt.Printf("panic recover:%s", r)
}

output:

./prog.go:10:5: unreachable code
Go vet exited.
this is a panic example
panic: this is a panic
goroutine 1 [running]:
main.main()
 /tmp/sandbox752240852/prog.go:9 +0x95
Program exited: status 2.

使用 defer 调用匿名函数的 recover 捕获 panic：

func main() {
    fmt.Println("this is a panic example")
    defer func(){
        if r := recover(); r != nil {
            fmt.Printf("panic recover:%s", r)
        }
    }()
    panic("this is a panic")
    // r := recover()
    // fmt.Printf("panic recover:%s", r)
}

output:

this is a panic example
panic recover:this is a panic
Program exited.

04

总结

本文主要介绍在 golang 语言中，panic 异常的概念，发生 panic 的两种方式和导致的后果，以及捕获 panic 的方法。因为 panic 导致的后果非常严重，会导致程序崩溃，所以我们在处理一些不会影响程序正确运行的错误时，尽量使用 error 处理错误。

推荐阅读：

Golang 语言怎么处理错误？

Go 语言学习之错误处理

参考资料：

https://blog.golang.org/defer-panic-and-recover