golang常用庫之pkg/errors包第三方錯誤處理包案例詳解

2022-03-23 13:03:05

golang常用庫之-pkg/errors包

背景

golang自帶了錯誤資訊包error

只提供了簡單的用法, 如errors.New(),和errors.Error()用來傳遞和獲取錯誤資訊.
明顯官方的包已經不能滿足了, 只能採取其他方法補救, 如:採用三方errors包。

關於官方errors包

Go 語言使用 error 型別來返回函數執行過程中遇到的錯誤，如果返回的 error 值為 nil，則表示未遇到錯誤，否則 error 會返回一個字串，用於說明遇到了什麼錯誤。

檢視golang的errors包你會發現其原始碼是：

package errors

// New returns an error that formats as the given text.
// Each call to New returns a distinct error value even if the text is identical.
func New(text string) error {
	return &errorString{text}
}
// errorString is a trivial implementation of error.
type errorString struct {
	s string
func (e *errorString) Error() string {
	return e.s

New方法通過傳入的text建立不同的errorString，這個結構體實現了Error()方法，這樣便可以動態的建立不同的錯誤型別。

New返回了一個實現error介面的errorString型別的指標。那為啥不是返回errorString的值型別？？

我們在呼叫errors.New("")來返回一個錯誤時， **可以通過比較指標，來比較error是否相等，實際上就是控制相同的錯誤我們只建立一個error物件。**否則物件複製一下，在比較就是false了。

而且指標才會與nil相比較，如果是字串"" 雖然錯誤內容為空，但是還是有錯誤的。

看過原始碼我們很清楚的知道內建的error型別包含的資訊十分有限

官方errors包使用demo

package main

import (
	"errors"
	"fmt"
)
func main()  {
	err := errors.New("errors！！！！！！！！！！")
	if err != nil {
		fmt.Print(err)
	}
}

什麼是pkg/errors包

github.com/pkg/errors

Golang 的 error 不會像 Java 那樣列印 stackTrack 資訊。回溯 err 很是不方便。

pkg/errors 是一個用的比較多，同時也比較靈活的一個golang 例外處理包，我們基於此包，可以靈活的處理軟體開發中的異常

位於github.com/pkg/errors 的errors包是Go標準庫的替代品。它提供了一些非常有用的操作用於封裝和處理錯誤。

經過 github.com/pkg/errors 這個包來處理 err，WithStack(err) 函數能夠列印 stack

pkg/errors包使用demo

%s,%v //功能一樣，輸出錯誤資訊，不包含堆疊
%q //輸出的錯誤資訊帶引號，不包含堆疊
%+v //輸出錯誤資訊和堆疊
如：
fmt.Println(fmt.Sprintf("%s", err))
fmt.Println(fmt.Sprintf("%q", err))
fmt.Println(fmt.Sprintf("%+v", err))

注意，使用 log.Errorf("%+v", err) 才會列印 stackTrack，使用 %v %s 不行。

package main

import (
	E "errors"
	"fmt"
	"github.com/pkg/errors"
)
func main() {
	err0 := t1()
	err := errors.Wrap(err0, "附加資訊")
	if err != nil {
		//列印錯誤需要%+v才能詳細輸出
		fmt.Printf("err :%+vn", err)
	}
	fmt.Println("Hello world")
}
func t1() error {
	return E.New("錯誤")

結果：

優秀開源專案使用案例

https://github.com/marmotedu/errors

作者基於 github.com/pkg/errors 包，增加對 error code 的支援，完全相容 github.com/pkg/errors。

效能跟 github.com/pkg/errors 基本持平。

該 errors 包匹配的錯誤碼設計請參考：marmotedu/sample-code

可以用於web服務 code message json返回效果。
如果返回結果中存在 code 欄位，則表示呼叫 API 介面失敗。例如：

{
  "code": 100101,
  "message": "Database error"
}

上述返回中 code 表示錯誤碼，message 表示該錯誤的具體資訊。每個錯誤同時也對應一個 HTTP 狀態碼，比如上述錯誤碼對應了 HTTP 狀態碼 500(Internal Server Error)。

參考

Golang的錯誤處理
參考URL: https://zhuanlan.zhihu.com/p/89821850

到此這篇關於golang常用庫之-pkg/errors包第三方錯誤處理包的文章就介紹到這了,更多相關golang pkg/errors包第三方錯誤處理包內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

golang常用庫之pkg/errors包第三方錯誤處理包案例詳解

目錄