使用 /pkg/errors 和 golang 1.13 格式动词 %w 进行错误处理

欢迎各位小伙伴来到编程网，相聚于此都是缘哈哈哈！今天我给大家带来《使用 /pkg/errors 和 golang 1.13 格式动词 %w 进行错误处理》，这篇文章主要讲到等等知识，如果你对Golang相关的知识非常感兴趣或者正在自学，都可以关注我，我会持续更新相关文章！当然，有什么建议也欢迎在评论留言提出！一起学习！

我想用堆栈跟踪注释错误，因此我使用 /pkg/errors 包。

Go 1.13 添加了 %w - 格式化动词来换行错误。

以下不使用 %w 的程序会打印一个漂亮的堆栈跟踪：

https://play.golang.org/p/eAwMrwqjCWX

以下仅使用 %w not 稍作修改的程序：

https://play.golang.org/p/am34kdC0E3o

我应该如何将 %w 与错误包装和堆栈跟踪一起使用？

解决方案

原因是 errors.errorf 初始化了新的 fundamental 错误类型（在 pkg/errors 中）。如果您查看它的方法 format(s fmt.state, verb rune) （当您执行 log.printf 时触发）：

func (f *fundamental) format(s fmt.state, verb rune) {
    switch verb {
    case 'v':
        if s.flag('+') {
            io.writestring(s, f.msg)
            f.stack.format(s, verb)
            return
        }
        fallthrough
    case 's':
        io.writestring(s, f.msg)
    case 'q':
        fmt.fprintf(s, "%q", f.msg)
    }
}

所以你看到它只是打印 io.writestring(s, f.msg)。 另外，errorf 是：

func errorf(format string, args ...interface{}) error {
    return &fundamental{
        msg:   fmt.sprintf(format, args...),
        stack: callers(),
    }
}

由于该行：fmt.sprintf(format, args...)，您会看到 go vet 的错误（您无法将 %w 传递给 sprintf），并且在错误消息的打印中您只是请参阅：

es gab einen fehler: %!w(*errors.fundamental=&{failing unconditionally 0xc0000a2000})

而当使用 wrap 方法时，您会得到 withstack 错误类型，其 format 方法是：

func (w *withstack) format(s fmt.state, verb rune) {
    switch verb {
    case 'v':
        if s.flag('+') {
            fmt.fprintf(s, "%+v", w.cause())
            w.stack.format(s, verb)
            return
        }
        fallthrough
    case 's':
        io.writestring(s, w.error())
    case 'q':
        fmt.fprintf(s, "%q", w.error())
    }
}

感谢这一行 fmt.fprintf(s, "%+v", w.cause())，您可以看到一个很好的递归堆栈跟踪。

基本上，您需要像这样使用 %w：

fmt.errorf("got error: %w", err)

但是如果您想打印堆栈，这将无济于事。

您可以做的也许是自己实现一个用于递归打印堆栈跟踪的函数，该函数将在 fmt 或 pkg/errors 的错误链上工作：

type stackTracer interface {
             StackTrace() errors.StackTrace
}

type unwrapper interface {
    Unwrap() error
}

func printStack(err error) {
    if err == nil {
        return
    }
    
    if ster, ok := err.(stackTracer); ok {
        fmt.Printf("%+v", ster)
    }
    
    
    if wrapped, ok := err.(unwrapper); ok {
        printStack(wrapped.Unwrap())
    }
}

https://play.golang.org/p/OsEPD6guWtO

今天关于《使用 /pkg/errors 和 golang 1.13 格式动词 %w 进行错误处理》的内容介绍就到此结束，如果有什么疑问或者建议，可以在编程网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！