快捷導(dǎo)航

Golang Recover處理錯(cuò)誤原理解析

更新時(shí)間：2023年12月01日 11:02:25 作者：TimLiu 愛(ài)發(fā)白日夢(mèng)的后端

Golang 中的?recover?是一個(gè)鮮為人知但非常有趣和強(qiáng)大的功能,讓我們看看它是如何工作的,以及在 Outreach.io 中如何利用它來(lái)處理 Kubernetes 中的錯(cuò)誤

引言

Panic/Defer/Recover 基本上是 Golang 中對(duì)于其他編程語(yǔ)言中 throw/finally/catch 概念的替代品。它們有一些共同之處，但在一些重要細(xì)節(jié)上有所不同。

Defer

要充分理解 recover，我們首先需要談?wù)?nbsp;defer 語(yǔ)句。defer ;關(guān)鍵字前置于函數(shù)調(diào)用之前，使得該調(diào)用在當(dāng)前函數(shù)返回之前執(zhí)行。當(dāng)我們?cè)谝粋€(gè)函數(shù)中使用多個(gè) defer 語(yǔ)句時(shí)，它們按照后進(jìn)先出的順序執(zhí)行，這使得創(chuàng)建清理邏輯變得非常容易，如下例所示：

package main
import (
    "context"
    "database/sql"
    "fmt"
)
func readRecords(ctx context.Context) error {
    db, err := sql.Open("sqlite3", "file:test.db?cache=shared&mode=memory")
    if err != nil {
        return err
    }
    defer db.Close() // 這個(gè)函數(shù)調(diào)用將在 readRecords 函數(shù)返回時(shí)第三個(gè)執(zhí)行
    conn, err := db.Conn(ctx)
    if err != nil {
        return err
    }
    defer conn.Close() // 這個(gè)函數(shù)調(diào)用將在第二個(gè)執(zhí)行
    rows, err := conn.QueryContext(ctx, "SELECT id FROM users")
    if err != nil {
        return err
    }
    defer rows.Close() // 這個(gè)函數(shù)調(diào)用將在第一個(gè)執(zhí)行
    for rows.Next() {
        var id int64
        if err := rows.Scan(&id); err != nil {
            return err
        }
        fmt.Println("ID:", id)
    }
    return nil
}
func main() {
    readRecords(context.Background())
}

Panic

我們需要談?wù)摰牡诙€(gè)主題是 panic，它是一個(gè)導(dǎo)致當(dāng)前 goroutine 進(jìn)入 panic 模式的函數(shù)。當(dāng)前函數(shù)中的正常執(zhí)行流程被停止，僅執(zhí)行 defer 語(yǔ)句，然后對(duì)調(diào)用者函數(shù)執(zhí)行相同的操作，因此一直冒泡到堆棧的頂部（main 函數(shù)），然后使程序崩潰。panic 可以直接調(diào)用（傳遞一個(gè)值作為參數(shù)），也可以由運(yùn)行時(shí)錯(cuò)誤引起。例如，由于空指針解引用：

package main
import "fmt"
func main() {
    var x *string
    fmt.Println(*x)
}
// panic: runtime error: invalid memory address or nil pointer dereference

Recover

recover 是一個(gè)內(nèi)建函數(shù)，它使我們有可能在發(fā)生 panic 時(shí)重新獲得控制。它僅在被調(diào)用的延遲函數(shù)中產(chǎn)生效果。在延遲函數(shù)之外調(diào)用時(shí)，它總是返回 nil。如果我們處于 panic 模式，調(diào)用 recover 會(huì)返回傳遞給 panic 函數(shù)的值。基本示例：

package main
import "fmt"
func main() {
    defer func() {
        if r := recover(); r != nil {
            fmt.Printf("Recovered: %v\\n", r)
        }
    }()
    panic("spam, egg, sausage, and spam")
}
// Recovered: spam, egg, sausage, and spam

我們可以以同樣的方式從運(yùn)行時(shí)錯(cuò)誤中恢復(fù)：

package main
import "fmt"
func main() {
    defer func() {
        if r := recover(); r != nil {
            fmt.Printf("Recovered: %v\\n", r)
        }
    }()
    var x *string
    fmt.Println(*x)
}
// Recovered: runtime error: invalid memory address or nil pointer dereference

在這種情況下，recover 返回的值的類型是錯(cuò)誤（更準(zhǔn)確地說(shuō)是 runtime.errorString）。

有一個(gè)限制：我們不能直接從 recover 塊中返回值，因?yàn)樵?nbsp;recover 塊中的 return 語(yǔ)句僅從延遲函數(shù)中返回，而不是從周圍的函數(shù)中返回：

package main
import "fmt"
func foo() int {
    defer func() {
        if r := recover(); r != nil {
            fmt.Printf("Recovered: %v\\n", r)
            return 1 // "too many return values" 因?yàn)槲覀儍H從匿名函數(shù)返回
        }
    }()
    panic("spam, egg, sausage, and spam")
}
func main() {
    x := foo()
    fmt.Println(x)
}

如果我們想要更改函數(shù)返回的值，我們需要使用命名返回值：

package main
import "fmt"
func foo() (ret int) {
    defer func() {
        if r := recover(); r != nil {
            fmt.Printf("Recovered: %v\\n", r)
            ret = 1
        }
    }()
    panic("spam, egg, sausage, and spam")
}
func main() {
    x := foo()
    fmt.Println("value:", x)
}
// Recovered: spam, egg, sausage, and spam
// value: 1

一個(gè)更實(shí)際的例子，將 panic 轉(zhuǎn)換為普通錯(cuò)誤的轉(zhuǎn)換可能如下所示：

package main
import (
    "fmt"
    "github.com/google/uuid"
)
// processInput 嘗試將輸入字符串轉(zhuǎn)換為 uuid.UUID
// 它將 panic 轉(zhuǎn)換為錯(cuò)誤
func processInput(input string) (u uuid.UUID, err error) {
    defer func() {
        if r := recover(); r != nil {
            err = fmt.Errorf("panic: %v", r)
        }
    }()
    // 一些可能引發(fā) panic 的邏輯（也可以是第三方邏輯），例如：
    u = uuid.MustParse(input)
    return u, nil
}
func main() {
    u, err := processInput("xxx")
    if err != nil {
        fmt.Println(err)
    }
    fmt.Println(u)
}
// panic: uuid: Parse(xxx): invalid UUID length: 3
// 00000000-0000-0000-0000-000000000000

現(xiàn)在讓我們嘗試一些稍微

復(fù)雜的東西。假設(shè)我們?cè)?Kubernetes 中運(yùn)行，并且我們想要編寫(xiě)一個(gè)通用的 recover 函數(shù)，處理所有未捕獲的 panic 和運(yùn)行時(shí)錯(cuò)誤，并收集它們的堆棧跟蹤，以便我們可以以結(jié)構(gòu)化的方式記錄它們（例如，以 JSON 格式）。

package main
import (
    "fmt"
    "log"
    "os"
    "github.com/pkg/errors"
)
func foo() string {
    var s *string
    return *s
}
func handlePanic(r interface{}) error {
    var errWithStack error
    if err, ok := r.(error); ok {
        errWithStack = errors.WithStack(err)
    } else {
        errWithStack = errors.Errorf("%+v", r)
    }
    return errWithStack
}
func main() {
    logger := log.New(os.Stdout, "", 0)
    defer func() {
        if r := recover(); r != nil {
            err := handlePanic(r)
            logger.Println(
                "panic occurred",
                "msg", err.Error(),
                "stack", fmt.Sprintf("%+v", err),
            )
        }
    }()
    fmt.Println(foo())
}
// 輸出：
// panic occurred msg: runtime error: invalid memory address or nil pointer dereference
// stack: runtime error: invalid memory address or nil pointer dereference
// main.handlePanic
//        /tmp/sandbox239055659/prog.go:19
// main.main.func1...

以上就是今天的內(nèi)容！recover 函數(shù)并不是 Golang 開(kāi)發(fā)者的日常必備工具，但正如你所看到的，它在某些情況下非常有用，更多關(guān)于Golang Recover錯(cuò)誤處理的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: