错误堆栈

标准库的error错误实现比较简单,无法进行堆栈追溯,对于产生错误时的上层调用者来讲不是很友好,无法获得错误的调用链详细信息。gerror支持错误堆栈记录,通过New/NewfWrap/Wrapf等方法均会自动记录当前错误产生时的堆栈信息。

示例:

  1. package main
  2. import (
  3. "fmt"
  4. "github.com/gogf/gf/v2/errors/gerror"
  5. )
  6. func OpenFile() error {
  7. return gerror.New("permission denied")
  8. }
  9. func OpenConfig() error {
  10. return gerror.Wrap(OpenFile(), "configuration file opening failed")
  11. }
  12. func ReadConfig() error {
  13. return gerror.Wrap(OpenConfig(), "reading configuration failed")
  14. }
  15. func main() {
  16. fmt.Printf("%+v", ReadConfig())
  17. }
  18. // Output:
  19. // reading configuration failed: configuration file opening failed: permission denied
  20. // 1. reading configuration failed
  21. // 1). main.ReadConfig
  22. // /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/v2/geg/errors/gerror/gerror2.go:18
  23. // 2). main.main
  24. // /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/v2/geg/errors/gerror/gerror2.go:25
  25. // 2. configuration file opening failed
  26. // 1). main.OpenConfig
  27. // /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/v2/geg/errors/gerror/gerror2.go:14
  28. // 2). main.ReadConfig
  29. // /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/v2/geg/errors/gerror/gerror2.go:18
  30. // 3). main.main
  31. // /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/v2/geg/errors/gerror/gerror2.go:25
  32. // 3. permission denied
  33. // 1). main.OpenFile
  34. // /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/v2/geg/errors/gerror/gerror2.go:10
  35. // 2). main.OpenConfig
  36. // /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/v2/geg/errors/gerror/gerror2.go:14
  37. // 3). main.ReadConfig
  38. // /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/v2/geg/errors/gerror/gerror2.go:18
  39. // 4). main.main
  40. // /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/v2/geg/errors/gerror/gerror2.go:25

可以看到,调用端可以通过Wrap方法将底层的错误信息进行层级叠加,并且包含完整的错误堆栈信息。

HasStack 判断是否实现堆栈

  • 说明:通过HasStack方法我们可以判断给定的error接口对象是否实现(包含)了堆栈信息。
  • 格式:

    1. HasStack(err error) bool
  • 示例:

    1. func ExampleHasStack() {
    2. err1 := errors.New("sql error")
    3. err2 := gerror.New("write error")
    4. fmt.Println(gerror.HasStack(err1))
    5. fmt.Println(gerror.HasStack(err2))
    6. // Output:
    7. // false
    8. // true
    9. }

Stack 获取堆栈信息

  • 说明:通过Stack方法我们可以获得error对象的完整堆栈信息,返回堆栈列表字符串。 注意参数为标准库error类型,当该参数为gerror模块生成的error时, 或者开发者自定义的error对象实现了该接口时支持打印,否则,返回空字符串。
  • 格式:

    1. Stack(err error) string
  • 示例:

    1. func ExampleStack() {
    2. var err error
    3. err = errors.New("sql error")
    4. err = gerror.Wrap(err, "adding failed")
    5. err = gerror.Wrap(err, "api calling failed")
    6. fmt.Println(gerror.Stack(err))
    7. // Output:
    8. // 1. api calling failed
    9. // 1). main.main
    10. // /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/.example/other/test.go:14
    11. // 2. adding failed
    12. // 1). main.main
    13. // /Users/john/Workspace/Go/GOPATH/src/github.com/gogf/gf/.example/other/test.go:13
    14. // 3. sql error
    15. }

Current 获取当前error

  • 说明:Current方法用于获取当前层级的错误信息,通过error接口对象返回。
  • 格式:

    1. Current(err error) error
  • 示例:

    1. func ExampleCurrent() {
    2. var err error
    3. err = errors.New("sql error")
    4. err = gerror.Wrap(err, "adding failed")
    5. err = gerror.Wrap(err, "api calling failed")
    6. fmt.Println(err)
    7. fmt.Println(gerror.Current(err))
    8. // Output:
    9. // api calling failed: adding failed: sql error
    10. // api calling failed
    11. }

Next 获取下一层error

  • 说明:Next方法用于获取层级错误的下一级错误error接口对象。当下一层级不存在时,返回nil
  • 格式:

    1. Next(err error) error
  • 示例:

    1. func ExampleNext() {
    2. var err error
    3. err = errors.New("sql error")
    4. err = gerror.Wrap(err, "adding failed")
    5. err = gerror.Wrap(err, "api calling failed")
    6. fmt.Println(err)
    7. err = gerror.Next(err)
    8. fmt.Println(err)
    9. err = gerror.Next(err)
    10. fmt.Println(err)
    11. // Output:
    12. // api calling failed: adding failed: sql error
    13. // adding failed: sql error
    14. // sql error
    15. }

Cause 获取根error

  • 说明:通过Cause方法我们可以获得error对象的根错误信息(原始错误)。 注意参数为标准库error类型,当该参数为gerror模块生成的error时, 或者开发者自定义的error对象实现了该接口方法时支持打印,否则,返回输出的error对象。
  • 格式:

    1. Next(err error) error
  • 示例:

    1. package main
    2. import (
    3. "fmt"
    4. "github.com/gogf/gf/v2/errors/gerror"
    5. )
    6. func OpenFile() error {
    7. return gerror.New("permission denied")
    8. }
    9. func OpenConfig() error {
    10. return gerror.Wrap(OpenFile(), "configuration file opening failed")
    11. }
    12. func ReadConfig() error {
    13. return gerror.Wrap(OpenConfig(), "reading configuration failed")
    14. }
    15. func main() {
    16. fmt.Println(gerror.Cause(ReadConfig()))
    17. }
    18. // Output:
    19. // permission denied