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

本篇文章主要是结合我之前面试的各种经历和实战开发中遇到的问题解决经验整理的，希望这篇《error.Wrapf()、errors.Errorf() 和 fmt.Errorf() 之间有什么区别？》对你有很大帮助！欢迎收藏，分享给更多的需要的朋友学习~

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

• errors.Wrapf()

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

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

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

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

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

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

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

解决方案

首先，更正：

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

也就是说，github.com/pkg/errors 非常受欢迎，并且由一些著名的 gophers 维护。然而，它在很大程度上（尽管不是完全**）被 Go 1.13's extended error support 废弃了。

了解这三个函数之间的区别需要一些历史课。 （我在 this video 中更详细地介绍了这段历史。）

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

go 1.13开发时，使用github.com/pkg/errors来影响新的api，但最终版本略有不同。他们决定使用新的 %w 动词来扩展 fmt.errorf 方法，而不是 wrap 和 wrapf 方法，这将为您执行错误包装。

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

    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 了。这是为了向后兼容。

*github.com/pkg/errors 软件包不再主动维护。该存储库已存档，不再接受更新，但仍可供使用。

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

只是一个小测试来说明 Flimzy's answer，这里是一个非常简短测试：

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
*/

今天关于《error.Wrapf()、errors.Errorf() 和 fmt.Errorf() 之间有什么区别？》的内容就介绍到这里了，是不是学起来一目了然！想要了解更多关于的内容请关注golang学习网公众号！