errors.Wrapf()、errors.Errorf() 和 fmt.Errorf() 之间有什么区别？

Question

这三个函数与 Go 的标准包有什么区别：

• errors.Wrapf()

Wrapf 在调用 Wrapf 和格式说明符时返回一个错误注释错误，并带有堆栈跟踪。如果 err 为 nil，则 Wrapf 返回 nil。

• errors.Errorf(), 通过%w格式变量提供错误

Errorf 根据格式说明符进行格式化，并将字符串作为满足错误的值返回。Errorf 还会记录调用它时的堆栈跟踪。

• fmt.Errorf(), 通过%w格式变量提供错误

Errorf 根据格式说明符进行格式化，并将字符串作为满足错误的值返回。

如果格式说明符包含带有错误操作数的 %w 动词，则返回的错误将实现返回操作数的 Unwrap 方法。包含多个 %w 动词或为其提供未实现错误接口的操作数是无效的。%w 动词是 %v 的同义词。

什么时候应该使用一个而不是其他的？

Answer 1

首先，更正：

github.com/pkg/errors是不是标准库的一部分！标准errors包的 API 小得多。

也就是说，github.com/pkg/errors它非常受欢迎，并由一些著名的 Gophers 维护。然而，它在很大程度上（虽然不是完全*）被Go 1.13 的扩展错误支持所淘汰。

理解这三个函数之间的区别需要一些历史课。

在 Go 1.13 之前，没有官方认可的方法来“包装”错误。 github.com/pkg/errors用Wrap和Wrapf方法填补了这一空白。这允许使用附加上下文（包括堆栈跟踪）包装错误，同时以原始形式保留原始错误。

在 Go 1.13 开发时，github.com/pkg/errors用于影响新 API，但最终版本略有不同。他们决定用一个新动词来扩展该方法，而不是Wrap和Wrapf方法，这将为您执行错误包装。fmt.Errorf%w

这意味着以下代码位大致*等效：

    import "github.com/pkg/errors"

    /* snip */

    return errors.Wrapf(err, "bad things")

    // +build go1.13

    import "fmt"

    /* snip */
    return fmt.Errorf("bad things: %w", err)

当 Go 1.13 出来时，%w动词被添加到fmt.Errorf，github.com/pkg/errors效仿并添加了相同的支持，所以现在Wrapf实际上已经过时了。

因此，这将我们带到了当今的建议：

1. 如果您想在错误中进行堆栈跟踪，请使用github.com/pkg/errors.Errorf来包装错误。
2. 如果您不关心堆栈跟踪，请使用fmt.Errorf标准库。
3. 永远不要再用errors.Wrapf了。这是为了向后兼容。

*标准库的error包仍然不包含堆栈跟踪，因此github.com/pkg/errors仍然很受欢迎。

Answer 2

只是一个小测试来说明Flimzy 的答案，这是一个非常简短的测试：

func errorsWrapF() {
    wrap_err := errors.Wrapf(errors.New("a random error"), "wrapper")
    fmt.Printf("%+v\n", wrap_err)
}
/* would print:
a random error
main.errorsWrapF
        /home/tests/gosandbox/error/main.go:18
main.main
        /home/tests/gosandbox/error/main.go:11
runtime.main
        /usr/local/go/src/runtime/proc.go:204
runtime.goexit
        /usr/local/go/src/runtime/asm_amd64.s:1374
wrapper
main.errorsWrapF
        /home/tests/gosandbox/error/main.go:19
main.main
        /home/tests/gosandbox/error/main.go:11
runtime.main
        /usr/local/go/src/runtime/proc.go:204
runtime.goexit
        /usr/local/go/src/runtime/asm_amd64.s:1374
*/


func errorsErrorF() {
    err := errors.Errorf("a random error because of %w", errors.New("a random error"))
    fmt.Printf("%+v\n", err)
}
/* would print:
a random error because of a random error
main.errorsErrorF
        /home/tests/gosandbox/error/main.go:27
main.main
        /home/tests/gosandbox/error/main.go:10
runtime.main
        /usr/local/go/src/runtime/proc.go:204
runtime.goexit
        /usr/local/go/src/runtime/asm_amd64.s:1374
*/



func fmtErrorF() {
    err := fmt.Errorf("a random error because of %w", errors.New("a random error"))
    fmt.Printf("%+v\n", err)
}
/* would print:
a random error because of a random error
*/