荣耀头条

Go优雅的错误处理: 支持错误堆栈, 错误码, 错误链的工具库

2023-07-10 10:47 由 兜率宫中六色火苗 发表于 #后端开发

地址: https://github.com/morrisxyang/errors
如果觉得有用欢迎 Star 和 PR, 有问题请直接提issue

errors





简单的支持错误堆栈, 错误码, 错误链的工具库:

  • 支持携带堆栈, 嵌套构造错误链

  • 支持携带错误码, 方便接口返回

  • 支持自定义堆栈打印深度和错误链打印格式

  • 使用 CallersFrames 替代 FuncForPC 生成堆栈, 避免特殊情况line number错误等问题, 详见runtime: strongly encourage using CallersFrames over FuncForPC with Callers result

  • 简化堆栈信息, 一条链路多次Wrap操作只保留最深层堆栈, 只打印一次

安装和文档

安装使用 go get github.com/morrisxyang/errors

文档地址是 https://pkg.go.dev/github.com/morrisxyang/errors

快速开始

构造错误链

func a() error {
   err := b()
   err = Wrap(err, "a failed reason")
   return err
}

func b() error {
   err := c()
   err = Wrap(err, "b failed reason")
   return err
}

func c() error {
   _, err := os.Open("test")
   if err != nil {
      return WrapWithCode(err, 123, "c failed reason")
   }
   return nil
}

打印错误信息, %+v会打印堆栈, %v只打印错误信息

a failed reason
Caused by: b failed reason
Caused by: 123, c failed reason
Caused by: open test: no such file or directory
github.com/morrisxyang/errors.c
   /Users/morrisyang/Nutstore Files/go-proj/githuberrors/errors_test.go:94
github.com/morrisxyang/errors.b
   /Users/morrisyang/Nutstore Files/go-proj/githuberrors/errors_test.go:86
github.com/morrisxyang/errors.a
   /Users/morrisyang/Nutstore Files/go-proj/githuberrors/errors_test.go:80
....堆栈信息省略

核心方法

错误封装

错误解析

配置

FAQ

  1. 多次 Wrap 错误会携带多次堆栈吗?

    可在调用链路上多次Wrap, 添加说明信息, 但只有最深层的Wrap操作会设置堆栈, 继续 Wrap, return err 等操作不会影响堆栈信息

  2. 在链路中某个错误设置了合适的错误码, 然后继续Wrap时没有设置, 如何获取?

    建议在合适的清晰的时机设置有效的错误码, 可以使用EffectiveCode获取链路中外层第一个有效的非0错误码, 由于系统调用等情况, 同一链路中可能有多个错误携带错误码, 此时默认外层的错误码应该对外暴露, 屏蔽了内层的详细信息.

热门相关：峡谷正能量   裙上之臣   修真界败类   万古至尊   闺范