Golang panic

前言

Golang中当程序发生致命异常时（比如数组下标越界，注意这里的异常并不是error），Golang程序会panic（运行时恐慌）。当程序发生panic时，程序会执行当前栈中的defer 函数列表。然后打印引发panic的具体信息，最后进程退出，本篇文章我们一起探讨Golang中的panic以及如何利用defer 和 recover 来恢复这种致命的异常

分析造成panic堆栈信息

func main() {
    f1()
    fmt.Println("main func end")
}

func f1() {
    fmt.Println("func f1 start")
    arr := []int{}
    fmt.Println(arr[10])
    fmt.Println("func f1 end")
}

上述代码中，我在main函数(主协程)中调用了f1函数，在调用完该函数后，我打印了「main func end」,程序如果正常执行的话会输出

func f1 start
func f1 end
main func end

很明显我们可以看出 f1 函数中，切片arr是没有索引为10的元素的，这个时候程序运行时会造成panic，下面是程序panic时，console打印的堆栈信息

func f1 start
panic: runtime error: index out of range [10] with length 0
goroutine 1 [running]:
main.f1()
/Users/carlos/go/src/test/demo01.go:15 +0x78
main.main()
/Users/carlos/go/src/test/demo01.go:8 +0x20
Process finished with the exit code 2

我们从堆栈中可以发现：

程序会在造成panic所处的位置终止

我们可以看到错误信息中只输出了 func f1 start

产生panic的原因

panic: runtime error: index out of range [10] with length 0

是哪里造成的panic

goroutine 1 [running] // 运行该程序的协程
main.f1()
/Users/carlos/go/src/test/demo01.go:15 +0x78 // f1 函数，当前demo01文件的低15行
main.main()
/Users/carlos/go/src/test/demo01.go:8 +0x20 // main 函数，当前文件的弟8行

从上面的panic详情我们可以看出，错误链是通过栈的形式展现出来的（mian函数先调用，然后在mian中调用f1）,所以大家以后在程序发生panic时查看堆栈信息时可以先看最上层的错误，因为这里是造成panic的根本原因

如何恢复panic造成的程序崩溃

Golang中提供了recover函数用来恢复因panic造成的程序崩溃。recover函数有一个返回值来告诉我们panic产生的具体原因。下面我们通过代码来进行演示

func main() {
    f1()
    r := recover()
    fmt.Printf("%s \n", r)
    fmt.Println("main func end")
}

func f1() {
    fmt.Println("func f1 start")
    arr := []int{}
    fmt.Println(arr[10])
    fmt.Println("func f1 end")
}

上述代码中我只是在调用f1函数的下一行调用了recover函数，这样一来我们的理想状态了能够恢复程序，让程序执行完main函数中剩下的代码（打印panic信息，最后打印 main func end）,当我们运行该程序的时候发现recover并没有起到作用,这是因为当f1造成panic时，f1下方的recover函数根本没有机会执行。

下面我将上述代码进行一个简单的改造：

func main() {
    defer func() {
        fmt.Println("defer func start")
        if r := recover(); r != nil {
            fmt.Printf("%s \n", r)
        }
        fmt.Println("defer func end")
    }()
    f1()
    fmt.Println("main func end")
}

func f1() {
    fmt.Println("func f1 start")
    arr := []int{}
    fmt.Println(arr[10])
    fmt.Println("func f1 end")
}

输出

func f1 start
defer func start
runtime error: index out of range [10] with length 0 
defer func end

上述代码中，我只是在main函数最开头添加了一个defer 函数，并在该函数中调用了recover函数。注意，我们在文章的最开头已经说明了，当程序发生panic时，程序会依次执行栈中的defer函数（关于defer函数请阅读官网描述）。所以当前程序发生panic时在进程退出之前会走到defer函数中执行recover函数，recover函数会恢复当前进程并打印错误信息。

这里我需要特别提醒你一点，最好将defer语句写在函数的最前面。如果上述例子我将f1的调用写在defer函数之前，你会发现recover函数还是没有执行

func main() {
    f1()
    defer func() {
        fmt.Println("defer func start")
        if r := recover(); r != nil {
            fmt.Printf("%s \n", r)
        }
        fmt.Println("defer func end")
    }()
    fmt.Println("main func end")
}

这是因为f1造成panic时，defer函数根本就没有压入函数调用栈中。

何时使用panic

当你的项目中特别依赖一些组件时，比如一些web项目中经常会在进程启动之前初始化一些mysql，mq句柄。这些实例对业务来说是非常重要的，所以当这些实例初始化失败时我们可以直接让当前程序panic（手动panic），然后及时发现问题并解决。这样总比你带着问题上线后，然后一批流入打入进来，客户端疯狂报错要好

Golang中手动调用panic：

func main() {
    initMysql()
}

func initMysql() {
    panic("init mysql failed") // panic可以接收一个interface类型的参数
}