Go中使用pkg/errors标注错误如何避免堆栈重复打印

该现象是用法不符合github.com/pkg/errors设计预期导致的，不属于包的bug，属于设计范围内的行为：

• 包内所有生成新错误的方法（New/Errorf/Wrap），都会在调用位置捕获堆栈信息附加到当前错误实例上
• 原实现用errors.Errorf配合%+v格式化内层错误，会直接把内层错误的完整输出（包括内层错误自带的全量堆栈）作为普通字符串拼接进当前层的错误消息，这部分内容会被当做无结构文本处理
• 最终用%+v打印最外层错误时，每一层错误自带的堆栈会依次输出，同时每层消息文本中嵌入的内层堆栈也会被原样打印，最终出现三次堆栈重复的问题。

全程使用github.com/pkg/errors即可实现需要的效果，不需要混用标准库，也不需要开发者记忆复杂的格式化规则，包本身会自动处理错误链的消息拼接和堆栈去重。

正确用法规则 #

• 初始创建根错误时，使用errors.New或errors.Errorf生成带堆栈的基础错误
• 上层调用链给已有错误追加标注信息时，优先使用errors.Wrap(err, "标注内容")；如果需要自定义消息格式，使用errors.Errorf配合%w占位符引用内层错误，禁止用%v/%+v把内层错误转成普通字符串拼接
• 最终打印错误时，统一对最外层错误用%+v格式化即可。

修正后的代码示例 #

package main

import (
    "log"

    "github.com/pkg/errors"
)

func myError() error {
    return errors.New("failing unconditionally")
}

func myError1() error {
    // Wrap方法自动持有内层错误的结构化引用，不会重复拷贝全量堆栈
    return errors.Wrap(myError(), "annotate with additional debug info")
}

func myError2() error {
    // Errorf配合%w占位符的效果和Wrap完全一致
    return errors.Errorf("extra debug info: %w", myError1())
}

func main() {
    if err := myError2(); err != nil {
        log.Printf("%+v", err)
    }
}

上述代码运行后，输出内容和期望效果完全一致：错误提示按包装层级顺序拼接，完整调用堆栈仅打印一次，无冗余内容。

实现原理 #

errors.Wrap和带%w占位符的errors.Errorf生成的包装错误，内部会保留内层错误的结构化引用，不会提前把内层错误渲染为无结构的字符串。当使用%+v格式化最外层错误时，包会递归遍历整条错误链：

1. 按顺序拼接所有层级的标注消息，生成完整的错误提示文本
2. 收集链路上所有的堆栈帧，自动去重后按真实调用顺序一次性输出
   只有当手动将内层错误通过%v/%+v转为字符串拼接时，包无法识别字符串中嵌入的堆栈内容，才会导致重复打印的问题。

内容的提问来源于stack exchange，提问作者Zizheng Wu