go - 使用/pkg/errors 与 golang 1.13 格式动词 %w 一起处理错误

Question

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

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

以下不使用 %w 的程序打印了一个很好的堆栈跟踪:

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

以下仅使用 %w 未稍作修改的程序:

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

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

Answer 1

原因是 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