pkg/errors的用法


目前實現最優雅,打印堆棧良好的包。
參考: https://studygolang.com/articles/17430?fr=sidebar

 

下載安裝

go get -x github.com/pkg/errors

跟蹤堆棧信息的函數使用

// 新生成一個錯誤, 帶堆棧信息
func New(message string) error

//只附加新的信息
func WithMessage(err error, message string) error

//只附加調用堆棧信息
func WithStack(err error) error

//同時附加堆棧和信息
func Wrap(err error, message string) error

打印出堆棧信息

%s,%v //功能一樣,輸出錯誤信息,不包含堆棧
%q //輸出的錯誤信息帶引號,不包含堆棧
%+v //輸出錯誤信息和堆棧
如:
fmt.Println(fmt.Sprintf("%s", err))
fmt.Println(fmt.Sprintf("%q", err))
fmt.Println(fmt.Sprintf("%+v", err))

測試

新建三個文件,a.go, b.go, c.go 還有一個入口文件main.go

調用順序是main.go -> c.go -> b.go -> c.go 由c.go里一個函數返回一個error信息

關鍵代碼如下


func C() error {
    _, err := os.Open("abc")
    if err != nil {
        err = errors.WithStack(err)
        return err
    }
    return nil
}

入口函數打印信息

func main() {
    err := a.A()
    if err != nil {
        fmt.Println(PrintMessage(err)) // 打印普通信息
        fmt.Println(PrintStack(err)) // 打印信息附帶堆棧信息
        return
    }
    fmt.Println("ok")
}
// 打印普通信息,沒有堆棧信息
func PrintMessage(err error) string {
    return err.Error()
}

// 打印詳細信息,附帶堆棧信息。
func PrintStack(err error) string {
    errMsg := fmt.Sprintf("%+v", err)
    return CleanPath(errMsg)
}

// 脫敏
func CleanPath(s string) string {
    return strings.ReplaceAll(s, GetCurrentPath() + "/", "")
}

// 獲取當前項目目錄
func GetCurrentPath() string {
    getwd, err := os.Getwd()
    if err != nil {
        return ""
    }
    return strings.Replace(getwd, "\\", "/", -1)
}

輸出信息

很清晰的顯示 c.go -> b.go -> a.go -> main.go的執行順序(這里與調用順序剛好相反嘛)
open abc: The system cannot find the file specified.
learn_error/c.C
    c/c.go:11
learn_error/b.B
    b/b.go:6
learn_error/a.A
    a/a.go:6
main.main
    main.go:11

總結

關鍵代碼

import (
    "github.com/pkg/errors"
    "os"
)

func C() error {
    _, err := os.Open("abc")
    if err != nil {
        err = errors.WithStack(err) // 對err進行包裝,附帶堆棧信息處理。
        return err
    }
    return nil
}

 

 如果和其他庫進行協作,考慮使用 errors.wrap或者 errors.wrapf保存堆棧信息。同樣適用於和標准庫協作的時候。

 

 

 

 直接返回錯誤,而不是每個錯誤產生的地方到處打日志。

 在程序的頂部或者是工作的goroutine頂部(請求入口),使用%+v把推展詳情記錄

 

 

 

 
 
Errors before  go  1.13
最簡單的錯誤檢查

 

 有時候我們需要對sentinel error 進行檢查

 

 實現了error interface的已定義error sttuct,進行斷言使用獲取更豐富的上下文

 

 

go1.13errors包包含兩個用於檢查錯誤的新函數 IsAs

 

 

 

 

 

 

用%w包裝錯誤

使用fmt.Errorf 向錯誤添加附加信息 

 

在GO1.13中fmt.Errorf支持新的#w謂詞

 

 

用%w包裝錯誤可用於errors.Is 以及errors.As:

 

 

 

 

 

 

 
 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM