fmt.errorf("%w")是go 1.13+包装错误的唯一推荐方式,它支持errors.is/errors.as检测和递归展开,而%s或字符串拼接会断开错误链,导致无法判断原始错误类型或提取底层错误。

fmt.Errorf("%w") 是 Go 1.13+ 包装错误的唯一推荐方式
Go 1.13 引入了 %w 动词和 errors.Is/errors.As,让错误包装真正可检测、可展开。不用 %w,只用 %s 或字符串拼接,就等于丢掉原始错误——后续无法用 errors.Is(err, io.EOF) 判断,也无法用 errors.As(err, &target) 提取底层错误。
常见错误现象:fmt.Errorf("read header failed: %v", err) 看似合理,但返回的错误不包含 Unwrap() 方法,errors.Is 查不到原错误,日志里也看不出调用链。
-
%w只接受单个error类型参数,不能写成fmt.Errorf("x: %w, y: %w", err1, err2) - 如果要包装多个错误(比如并发任务失败),得用自定义错误类型或
fmt.Errorf("x: %w; y: %w", err1, err2)——但注意:只有第一个%w被errors.Unwrap()识别,其余只是文本 -
%w后面的表达式必须是error类型,否则编译报错:cannot use "not an error" (type string) as type error
什么时候该用 fmt.Errorf("%w"),什么时候该用 errors.Wrap(来自 github.com/pkg/errors)?
如果你项目已升级到 Go 1.13+ 且不需兼容旧版本,直接用 fmt.Errorf("%w")。它标准、轻量、无依赖,且和 errors.Is / errors.As 深度协同。
github.com/pkg/errors 的 errors.Wrap 曾是事实标准,但它在 Go 1.13+ 中属于冗余封装:它的 Wrap 行为等价于 fmt.Errorf("%w"),而它的堆栈追踪能力(errors.WithStack)在标准库中并无对应替代——但要注意:标准库不记录堆栈,所以若你依赖堆栈定位问题,得自己加(比如用 debug.PrintStack() 或第三方如 golang.org/x/exp/slog 带位置的日志)。
立即学习“go语言免费学习笔记(深入)”;
- 新项目、Go ≥ 1.13 → 优先用
fmt.Errorf("%w") - 老项目还在用
pkg/errors且重度依赖堆栈 → 可暂时保留,但别混用:errors.Wrap(fmt.Errorf("%w", err), "msg")是典型冗余 - 想打印堆栈又不想引入第三方?可以用
runtime.Caller手动捕获,但别在每层都做——性能敏感路径慎用
errors.Is 和 errors.As 不起作用?大概率是没用 %w 或用了两次包装
典型现象:errors.Is(err, fs.ErrNotExist) 返回 false,明明原始错误就是它。原因往往是中间某层用了字符串格式化,断掉了错误链;或者用了两层 %w 包装,但只检查第一层。
errors.Is 会递归调用 Unwrap(),直到匹配或返回 nil;errors.As 同理。但如果某次包装是 fmt.Errorf("failed: %v", err),那这层就没有 Unwrap() 方法,链就断了。
- 检查每一层错误构造:只要出现
%v、%s、+ "string"拼接error,基本就断链了 - 两层包装如
fmt.Errorf("outer: %w", fmt.Errorf("inner: %w", os.ErrNotExist)),errors.Is(err, os.ErrNotExist)仍为true——没问题 - 但若中间夹了一个非
%w层:fmt.Errorf("middle: %v", fmt.Errorf("inner: %w", os.ErrNotExist)),则errors.Is查不到os.ErrNotExist
包装错误时要不要加额外信息?加,但别覆盖关键字段
加信息是对的,比如把文件名、ID、HTTP 状态码带上,方便排查。但别用模糊描述覆盖原始错误语义,例如把 os.ErrNotExist 包装成 "operation failed",等于抹掉错误类型。
好的做法是前缀式补充上下文:fmt.Errorf("reading config file %q: %w", filename, err)。这样既保留原始错误,又带出变量值。
- 避免用 “failed”、“error occurred” 这类无信息词——它们对调试毫无帮助
- 不要把错误转成新类型再包装,除非真有行为扩展需求(比如需要重试逻辑);否则纯属增加复杂度
- 日志中打印错误时,用
%+v(如果用了pkg/errors)或手动展开(标准库需循环errors.Unwrap)才能看到完整链;%v默认只显示最外层
fmt.Errorf,先问自己——下游是否需要靠这个错误做决策?如果答案是“是”,那就必须用 %w,且确保整条链上没人偷偷把它变成字符串。










