地址: 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 reasonCaused by: b failed reasonCaused by: 123, c failed reasonCaused by: open test: no such file or directorygithub.com/morrisxyang/errors.c   /Users/morrisyang/Nutstore Files/go-proj/githuberrors/errors_test.go:94github.com/morrisxyang/errors.b   /Users/morrisyang/Nutstore Files/go-proj/githuberrors/errors_test.go:86github.com/morrisxyang/errors.a   /Users/morrisyang/Nutstore Files/go-proj/githuberrors/errors_test.go:80....堆栈信息省略

外围办法

谬误封装

  • 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

  1. 屡次 Wrap 谬误会携带屡次堆栈吗?

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

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

    倡议在适合的清晰的机会设置无效的错误码, 能够应用EffectiveCode获取链路中外层第一个无效的非0错误码, 因为零碎调用等状况, 同一链路中可能有多个谬误携带错误码, 此时默认外层的错误码应该对外裸露, 屏蔽了内层的详细信息.