pkg/errors 是 Go 语言中的一个第三方库，主要用于改进错误处理。它提供了对 Go 原生错误处理的一些增强，比如支持堆栈追踪、错误的上下文信息附加、错误的包裹等。通过 pkg/errors，你可以更加清晰地了解错误的来源以及错误链的详细信息。
这个库最著名的特性是通过 Wrap 和 WithStack 方法来为错误附加堆栈信息，帮助开发者调试和定位错误源。
Life is like a journey
pkg/errors首先，确保你的 Go 环境已经配置好了，并且安装了 pkg/errors 库。你可以通过以下命令来安装：
go get github.com/pkg/errors
errorStringpkg/errors 的核心是通过 error 接口来处理错误的，但它有几个增强的结构体，比如 stack 和 withMessage，这使得它在错误处理中提供了更强大的功能。
首先我们来看下 errors.go 文件中的一部分代码，看看库的核心结构。
package errors
import (
"fmt"
"runtime"
"strings"
)
// errorString 是一个错误的实现，它是一个字符串错误。
// 这是 Go 原生错误处理的基础，但 `pkg/errors` 会对它进行增强。
type errorString struct {
s string
}
// Error 返回错误的字符串。
func (e *errorString) Error() string {
return e.s
}
// New 创建一个新的 errorString 实例。
func New(text string) error {
return &errorString{text}
}
在上面的代码中，errorString 结构体实现了 Go 标准库中的 error 接口，它仅包含一个 string 字段来保存错误消息。New 函数创建了一个新的错误实例。
接下来看 pkg/errors 如何为错误附加堆栈信息。最常用的 Wrap 和 WithStack 函数就是为了实现这个功能。
Wrap 函数Wrap 函数将一个现有的错误包装成一个新的错误，并可以为新的错误添加额外的上下文信息。
// Wrap 用于将现有错误包装为一个新错误，
// 如果传入的错误不为空，则返回一个包含原始错误的上下文的新错误。
// 如果传入的错误为空，则返回 nil。
func Wrap(err error, message string) error {
if err == nil {
return nil
}
return &withMessage{
err: err,
message: message,
}
}
Wrap 函数接受两个参数：一个原始的 error 和一个附加的消息。它会返回一个包含原始错误的新的错误实例，新的错误实例包含了附加的消息。
WithStack 函数WithStack 函数将堆栈追踪信息附加到错误上，这对于调试非常有用。
// WithStack 为错误添加堆栈信息
func WithStack(err error) error {
if err == nil {
return nil
}
return &withStack{err: err, stack: callers()}
}
WithStack 会将堆栈信息附加到传入的错误对象上。如果传入的错误是 nil，则返回 nil，否则返回一个包含堆栈追踪信息的新的错误对象。
callers 函数（定义在库内部）会获取当前的堆栈信息，返回一个堆栈追踪。
withMessage 结构体withMessage 是一个用于包装错误并添加消息的结构体，它实现了 error 接口。
type withMessage struct {
err error
message string
}
func (w *withMessage) Error() string {
return fmt.Sprintf("%s: %s", w.message, w.err.Error())
}
func (w *withMessage) Cause() error {
return w.err
}
withMessage 结构体有两个字段：
err：存储原始的错误。message：存储附加的错误消息。通过这种结构，pkg/errors 可以为错误链添加附加信息，同时保留原始错误。Error 方法返回的是一个字符串，格式化后包含了附加的消息和原始错误的信息。
withStack 结构体withStack 结构体实现了一个包含堆栈追踪信息的错误封装。它记录了在创建错误时的堆栈信息。
type withStack struct {
err error
stack []uintptr
}
func (w *withStack) Error() string {
return fmt.Sprintf("%s\nstack trace:\n%s", w.err.Error(), w.stackTrace())
}
func (w *withStack) Cause() error {
return w.err
}
func (w *withStack) stackTrace() string {
var sb strings.Builder
for _, pc := range w.stack {
fn := runtime.FuncForPC(pc)
file, line := fn.FileLine(pc)
sb.WriteString(fmt.Sprintf("%s:%d\n", file, line))
}
return sb.String()
}
withStack 的作用是为错误附加堆栈信息，它在 Error 方法中返回了错误的详细信息以及堆栈追踪。stackTrace 方法将堆栈信息格式化为可读的字符串。
pkg/errors 提供了一些实用的功能，尤其是在处理多层错误时。你可以使用 Wrap 和 WithStack 函数来增强错误的可调试性。
package main
import (
"fmt"
"github.com/pkg/errors"
)
func foo() error {
return errors.New("foo error")
}
func bar() error {
err := foo()
if err != nil {
return errors.Wrap(err, "bar error")
}
return nil
}
func main() {
err := bar()
if err != nil {
fmt.Printf("error: %v\n", err)
}
}
在上面的示例中，bar 函数调用了 foo，并使用 errors.Wrap 封装了 foo 返回的错误，添加了一个上下文信息。运行后输出的错误信息会显示如下：
error: bar error: foo error
package main
import (
"fmt"
"github.com/pkg/errors"
)
func foo() error {
return errors.New("foo error")
}
func bar() error {
err := foo()
if err != nil {
return errors.WithStack(errors.Wrap(err, "bar error"))
}
return nil
}
func main() {
err := bar()
if err != nil {
fmt.Printf("error: %+v\n", err) // %+v 会输出详细的堆栈信息
}
}
当运行该代码时，如果发生错误，WithStack 会为错误附加堆栈信息，输出类似如下内容：
error: bar error: foo error
stack trace:
main.foo
/path/to/your/code/main.go:10
main.bar
/path/to/your/code/main.go:14
main.main
/path/to/your/code/main.go:19
pkg/errors 库增强了 Go 中原生的错误处理功能，提供了以下几个显著的功能：
Wrap 可以为现有错误添加更多上下文信息。WithStack 可以为错误添加堆栈信息，有助于调试和定位问题。Cause 方法，您可以获取错误的原始原因。总的来说，pkg/errors 是一个非常实用的库，尤其适用于大型项目或者复杂的错误处理场景。它使得 Go 的错误处理更加灵活和透明，能够有效帮助开发者追踪和定位问题。