go 錯誤處理設計思考

微風伏面發表於2021-11-17
Go

前段時間準備對線上一個golang系統服務進行內部開源，對程式碼裡面的錯誤處理進行了一波優化。

優化的幾個原因：

  • 錯誤處理資訊隨意，未分類未定義。看到錯誤日誌不能第一時間定位
  • 錯誤的日誌重複，有時候一個錯誤經過了好幾層，每一層都會記錄，導致日誌混亂
  • 錯誤處理不統一，使用不統一，管理也不統一

優化的解決辦法：

  • 對錯誤進行分類，統一定義和使用
  • 每一個錯誤都有冒泡到包的頂層，處理與記日誌。使用方只需定義好自己的資訊

實施過程

錯誤分類：函式級，包模組級，系統api級。

函式級別：

還是採用 err != nil 的形式，並且做一個如下的包裝。

模組級別

統一返回到對應的goroutine頂層處理

服務對外級別

適當的code和健名的message

底層錯誤級別

考慮及時panic，暴露有用資訊

以下為程式碼設計：

點選檢視程式碼 
package ferrors

import (
	"fmt"
	"golang.org/x/xerrors"
)

//Errors 新的錯誤處理方式
type Errors struct {
	Code int64
	Msg  string
}

// Error 輸出錯誤資訊
func (e Errors) Error() string {
	return fmt.Sprintf("code: %d msg: %s at: %s", e.Code, e.Msg, "錯誤位置，堆疊資訊，可選")
}

// New 建立自定義錯誤
func New(code int64, str string, arg ...interface{}) *Errors {
	if len(arg) > 0 {
		str = fmt.Sprintf(str, arg...)
	}
	return &Errors{Code: code, Msg: str}
}

// newErr 建立通用錯誤
func newErr(code int64, err error) *Errors {
	switch err := err.(type) {
	case *Errors:
		return err
	case nil:
		return &Errors{Code: code, Msg: ""}
	default:
		return &Errors{Code: code, Msg: err.Error()}
	}
}
func NewErrNotFound(err error) error {
	return newErr(CodeMkNotFound, err)
}

// ErrorEcho example:使用 error wrapping
func ErrorEcho(err error) string {

	return fmt.Sprintf("the error %w", err)
}

//ErrorDump example: xerrors 列印堆疊資訊
func ErrorDump() {
	err := foo1()
	fmt.Printf("%v\n", err)
	fmt.Printf("%+v\n", err)
}

var myError = xerrors.New("myerror")

func foo() error {
	return myError
}
func foo1() error {
	return xerrors.Errorf("foo1 : %w", foo())
}

相關文章