基于golang如何實現(xiàn)error工具包詳解

更新時間：2018年09月03日 17:12:11 作者：zcv8

Go 語言使用 error 類型來返回函數執(zhí)行過程中遇到的錯誤，下面這篇文章主要給大家介紹了關于如何基于golang實現(xiàn)error工具包的相關資料，文中通過示例代碼介紹的非常詳細，需要的朋友可以參考下

前言

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

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

設計思想

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

實現(xiàn)思路

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

對外提供的2個函數的實現(xiàn)

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
}

堆棧信息的實現(xiàn)

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 ""
}

錯誤信息顯示配置的實現(xiàn)

const (
 //print stack info
 PRINTSTACK = 1
)

// global error config object
var config *errConfig = &errConfig{}

// error config
type errConfig struct {
 isPrintStack uint32
}

//set error config info
func 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()
}

錯誤信息如下所示