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

 更新时间:2018年09月03日 17:12:11   作者:zcv8  
Go 语言使用 error 类型来返回函数执行过程中遇到的错误,下面这篇文章主要给大家介绍了关于如何基于golang实现error工具包的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下

前言

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

错误信息如下所示

 

结尾

该工具包只是对error信息和堆栈信息的封装,还存在含多不足的地方。如果各位有好的意见。欢迎指点。

总结:

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,如果有疑问大家可以留言交流,谢谢大家对脚本之家的支持。

相关文章

  • go语言实现一个简单的http客户端抓取远程url的方法

    go语言实现一个简单的http客户端抓取远程url的方法

    这篇文章主要介绍了go语言实现一个简单的http客户端抓取远程url的方法,实例分析了Go语言http操作技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-03-03
  • golang并发编程的实现

    golang并发编程的实现

    这篇文章主要介绍了golang并发编程的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-01-01
  • 使用go net实现简单的redis通信协议

    使用go net实现简单的redis通信协议

    本文主要介绍了go net实现简单的redis通信协议,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-12-12
  • Golang 实现超大文件读取的两种方法

    Golang 实现超大文件读取的两种方法

    这篇文章主要介绍了Golang 实现超大文件读取的两种方法,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-04-04
  • 详解go中panic源码解读

    详解go中panic源码解读

    这篇文章主要介绍了go中panic源码解读,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-04-04
  • K8s部署发布Golang应用程序的实现方法

    K8s部署发布Golang应用程序的实现方法

    本文主要介绍了K8s部署发布Golang应用程序的实现方法,文中通过示例代码介绍的非常详细,需要的朋友们下面随着小编来一起学习学习吧
    2021-07-07
  • Go语言常用字符串处理方法实例汇总

    Go语言常用字符串处理方法实例汇总

    这篇文章主要介绍了Go语言常用字符串处理方法,实例汇总了Go语言中常见的各种字符串处理技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-03-03
  • Golang Http 验证码示例实现

    Golang Http 验证码示例实现

    这篇文章主要介绍了Golang Http 验证码示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08
  • Go语言单链表实现方法

    Go语言单链表实现方法

    这篇文章主要介绍了Go语言单链表实现方法,实例分析了基于Go语言的单链表实现原理与使用技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-03-03
  • 利用Golang生成整数随机数方法示例

    利用Golang生成整数随机数方法示例

    这篇文章主要介绍了利用Golang生成整数随机数的相关资料,文中给出了详细的介绍和完整的示例代码,相信对大家具有一定的参考价值,需要的朋友们下面来一起看看吧。
    2017-04-04

最新评论