错误堆栈

示例:

可以看到,调用端可以通过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
  • 示例:

获取当前error

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

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

Next/Unwrap 获取下一层error

  • 说明:Next/Unwrap方法用于获取层级错误的下一级错误error接口对象。当下一层级不存在时,返回nil。其中Unwrap方法是Next方法的别名,是Golang v1.17版本开始支持的错误堆栈遍历方法。
  • 格式:

    1. Next(err error) error
  • 示例1:简单的错误层级访问示例。

  • 示例2:常见遍历逻辑代码示例。

    1. func IsGrpcErrorNotFound(err error) bool {
    2. if err != nil {
    3. for e := err; e != nil; e = gerror.Unwrap(e) {
    4. if s, ok := status.FromError(e); ok && s != nil && s.Code() == codes.NotFound {
    5. return true
    6. }
    7. }
    8. }
    9. return false

Cause 获取根错误error

  • 说明:通过Cause方法我们可以获得error对象的根错误信息(原始错误)。 注意参数为标准库error类型,当该参数为gerror模块生成的error时, 或者开发者自定义的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: