快捷導(dǎo)航

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

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

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

前言

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

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

設(shè)計(jì)思想

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

實(shí)現(xiàn)思路

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

對(duì)外提供的2個(gè)函數(shù)的實(shí)現(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
}

堆棧信息的實(shí)現(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 ""
}

錯(cuò)誤信息顯示配置的實(shí)現(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)
 }
}

測(cè)試

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()
}

錯(cuò)誤信息如下所示