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

地址:  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
快速开始

构造错误链

1. func a() error {
2.    err := b()
3.    err = Wrap(err, "a failed reason")
4.    return err
5. }
7. func b() error {
8.    err := c()
9.    err = Wrap(err, "b failed reason")
10.    return err
11. }
13. func c() error {
14.    _, err := os.Open("test")
15.    if err != nil {
16.       return WrapWithCode(err, 123, "c failed reason")
17.    }
18.    return nil
19. }

复制代码

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

1. a failed reason
2. Caused by: b failed reason
3. Caused by: 123, c failed reason
4. Caused by: open test: no such file or directory
5. github.com/morrisxyang/errors.c
6.    /Users/morrisyang/Nutstore Files/go-proj/githuberrors/errors_test.go:94
7. github.com/morrisxyang/errors.b
8.    /Users/morrisyang/Nutstore Files/go-proj/githuberrors/errors_test.go:86
9. github.com/morrisxyang/errors.a
10.    /Users/morrisyang/Nutstore Files/go-proj/githuberrors/errors_test.go:80
11. ....堆栈信息省略

复制代码

核心方法

错误封装

• func New(msg string) error
  
• func Newf(format string, args ...interface{}) error
  
• func NewWithCode(code int, msg string) error
  
• func NewWithCodef(code int, format string, args ...interface{}) error
  
• func Wrap(e error, msg string) error
  
• func Wrapf(e error, format string, args ...interface{}) error
  
• func WrapWithCode(e error, code int, msg string) error
  
• func WrapWithCodef(e error, code int, format string, args ...interface{}) error
  

错误解析

• func Code(e error) int
  
• func EffectiveCode(e error) int
  
• func Msg(e error) string
  
• func As(err error, target interface{}) bool
  
• func Is(err, target error) bool
  
• func Cause(e error) error
  
• func Unwrap(err error) error
  

配置

• type Config
  
• 
  
  
  
  • func GetCfg() *Config
    
  
  
• func ResetCfg()
  
• func SetCfg(c *Config)
  

FAQ

• 多次 Wrap 错误会携带多次堆栈吗?
  可在调用链路上多次Wrap, 添加说明信息, 但只有最深层的Wrap操作会设置堆栈, 继续 Wrap, return err 等操作不会影响堆栈信息
  
• 在链路中某个错误设置了合适的错误码, 然后继续Wrap时没有设置, 如何获取?
  建议在合适的清晰的时机设置有效的错误码, 可以使用EffectiveCode获取链路中外层第一个有效的非0错误码, 由于系统调用等情况, 同一链路中可能有多个错误携带错误码, 此时默认外层的错误码应该对外暴露, 屏蔽了内层的详细信息.
  

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！