基于golang如何实现error工具包详解

程序员文章站 2022-06-16 22:05:17

前言对于一门编程语言的开发者，类库包管理是一项考核编程语言成熟度的重要指标之一，golang 也不例外。笔者在日常使用golang语言开发系统程序时发现，在 gol...

前言

对于一门编程语言的开发者，类库包管理是一项考核编程语言成熟度的重要指标之一，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 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()
}

错误信息如下所示

基于golang如何实现error工具包详解