基于golang如何實現error工具包詳解

2020-04-01 18:53:37

字體：大中小

來源：轉載

供稿：網友

前言

對于一門編程語言的開發者，類庫包管理是一項考核編程語言成熟度的重要指標之一，Golang 也不例外。筆者在日常使用Golang語言開發系統程序時發現，在 Golang 的世界里，存在著大量的技術實現討論和各種自制的解決方案。

最近在開發Go項目，發現Go語言本身存在的error并沒有像觸發panic時顯示詳細的調試信息。對于復雜的系統而言，這會讓我們開發者需要一定的時間才能定位到錯誤。所以我們基本Go本身的error封裝了一個可以快速定位錯誤工具包。下面讓我們來看看這個工具包是怎么實現的。

設計思想

工具包提供Err和Errf兩個完善來登記錯誤，其用法分別類似于fmt.Print和fmt.Printf的使用方式，在參數的定義中添加了innerError參數來實現錯誤的傳遞，其值可為nil.
對外提供StackTrace函數，方便使用者獲取錯誤產生的堆棧信息。
通過SetConfig方式實現對錯誤信息顯示的配置，如在生產環境不需要打印堆棧信息。通過響應的配置即可關閉。

實現思路

工具包中主要是對堆棧信息的處理，就是如何才能定位到error的產生位置,通過查看官方文檔，我們發現通過runtime包中的Callers和CallersFrames函數可以獲取當前函數調用的堆棧信息。并且通過Skip參數和自定義過濾條件即可拿到error的產生位置。具體的實現過程如下：

對外提供的2個函數的實現

type Error struct { err  error msg  string fullMsg string stackTrace}func Errf(err error, format string, args ...interface{}) *Error { e := &Error{  err: err,  msg: fmt.Sprintf(format, args), } e.fullMsg = e.genFullMsg() return e}func Err(err error, args ...interface{}) *Error { e := &Error{  err: err,  msg: fmt.Sprint(args), } e.fullMsg = e.genFullMsg() return e}

堆棧信息的實現

type stackTrace struct { // stack info data string callers []uintptr}func (err *Error) getStackTrace() string { if strings.TrimSpace(err.data) == "" {  return err.genStackTrace(5) } return err.data}func (err *Error) StackTrace() string { return err.data}func (err *Error) genStackTrace(skip int) string { if config.isPrintStack == 1 {  var buffer bytes.Buffer  buffer.WriteString("StackTrace:/n")  var st [64]uintptr  n := runtime.Callers(skip, st[:])  err.callers = st[:n]  frames := runtime.CallersFrames(err.callers)  for {   frame, ok := frames.Next()   if !ok {    break   }   if !strings.Contains(frame.File, "runtime/") {    buffer.WriteString(fmt.Sprintf("%s/n/t%s:%d/n",     frame.Func.Name(), frame.File, frame.Line))   }  }  err.data = buffer.String()  return err.data } return ""}

錯誤信息顯示配置的實現

const ( //print stack info PRINTSTACK = 1)// global error config objectvar config *errConfig = &errConfig{}// error configtype errConfig struct { isPrintStack uint32}//set error config infofunc SetConfig(conf byte) { if (conf & PRINTSTACK) != 0 {  atomic.CompareAndSwapUint32(&config.isPrintStack, 0, 1) }}

測試

func init() { errors.SetConfig(errors.PRINTSTACK)}func main() { a := func() {  err := errors.Err(nil, "this is an inner error")  fmt.Print(err.StackTrace())  b := errors.Errf(err, "this is a %s message", "test").Error()  fmt.Println(b) } a()}

錯誤信息如下所示

golang,error,工具包