0

0

怎样使用Golang的errors库包装错误 实现错误堆栈跟踪

P粉602998670

P粉602998670

发布时间:2025-08-13 12:33:01

|

747人浏览过

|

来源于php中文网

原创

go语言从1.13开始通过fmt.errorf的%w动词支持错误包装,可结合errors.is和errors.as进行错误判断,但标准库不记录堆栈信息,需借助github.com/pkg/errors等第三方库或使用runtime.callers手动实现堆栈追踪,推荐开发阶段使用pkg/errors并通过%+v输出堆栈,生产环境可结合日志库记录调用链,最终实现完整的错误上下文和追踪能力。

怎样使用Golang的errors库包装错误 实现错误堆栈跟踪

Go 语言从 1.13 版本开始在标准库

errors
中引入了错误包装(error wrapping)机制,允许你将一个错误“包装”进另一个错误中,同时保留原始错误的信息。结合
fmt.Errorf
%w
动词,可以实现错误的链式传递和堆栈追踪。虽然标准库本身不直接提供堆栈信息,但你可以通过组合
errors
包和第三方库(如
pkg/errors
)或使用
runtime.Callers
自行实现堆栈跟踪。

下面介绍如何使用标准库

errors
实现错误包装,并结合堆栈信息进行追踪。


1. 使用
fmt.Errorf
%w
实现错误包装

当你在一个函数中处理来自底层的错误,又想添加上下文信息时,可以使用

fmt.Errorf
配合
%w
来包装错误:

立即学习go语言免费学习笔记(深入)”;

package main

import (
    "errors"
    "fmt"
)

func readConfig() error {
    return errors.New("file not found")
}

func loadConfig() error {
    if err := readConfig(); err != nil {
        return fmt.Errorf("failed to read config: %w", err)
    }
    return nil
}

func runApp() error {
    if err := loadConfig(); err != nil {
        return fmt.Errorf("failed to load config: %w", err)
    }
    return nil
}

func main() {
    if err := runApp(); err != nil {
        fmt.Println(err)
    }
}

输出:

failed to load config: failed to read config: file not found

这展示了错误的链式传播。你可以使用

errors.Is
errors.As
来检查原始错误:

if errors.Is(err, errors.New("file not found")) {
    fmt.Println("original error is 'file not found'")
}

2. 添加堆栈信息:使用
github.com/pkg/errors

标准库的

errors
不记录堆栈。为了实现堆栈追踪,推荐使用流行的第三方库
github.com/pkg/errors
(现已归档,但仍广泛使用)或其维护分支如
github.com/ianlopshire/go-errors

安装:

文心快码
文心快码

文心快码(Comate)是百度推出的一款AI辅助编程工具

下载
go get github.com/pkg/errors

示例代码:

package main

import (
    "fmt"
    "github.com/pkg/errors"
)

func readConfig() error {
    return errors.New("file not found")
}

func loadConfig() error {
    if err := readConfig(); err != nil {
        return errors.Wrap(err, "failed to read config")
    }
    return nil
}

func runApp() error {
    if err := loadConfig(); err != nil {
        return errors.Wrap(err, "failed to load config")
    }
    return nil
}

func main() {
    if err := runApp(); err != nil {
        fmt.Printf("%+v\n", err) // %+v 显示堆栈
    }
}

输出会包含完整的调用堆栈:

failed to load config: failed to read config: file not found
stack trace:
  - failed to load config
    main.loadConfig
        /path/to/main.go:14
  - failed to read config
    main.readConfig
        /path/to/main.go:9

%+v
是关键,它会打印完整的堆栈信息。


3. 使用标准库 + 自定义堆栈(进阶)

如果你不想引入第三方库,也可以通过

runtime
手动捕获堆栈:

package main

import (
    "fmt"
    "runtime"
    "strings"
)

type withStack struct {
    error
    stack []uintptr
}

func (w *withStack) Format(s fmt.State, verb rune) {
    switch verb {
    case 'v':
        if s.Flag('+') {
            fmt.Fprintf(s, "%+v", w.Cause())
            w.printStack(s)
            return
        }
        fallthrough
    case 's':
        fmt.Fprintf(s, "%s", w.error)
    case 'q':
        fmt.Fprintf(s, "%q", w.error)
    }
}

func (w *withStack) printStack(s fmt.State) {
    for _, pc := range w.stack {
        fn := runtime.FuncForPC(pc)
        if fn == nil {
            continue
        }
        file, line := fn.FileLine(pc)
        fmt.Fprintf(s, "\n  %s:%d", trimPath(file), line)
    }
}

func (w *withStack) Cause() error { return w.error }

func trimPath(path string) string {
    pos := strings.LastIndex(path, "/")
    if pos == -1 {
        return path
    }
    return path[pos+1:]
}

func WithStack(err error) error {
    if err == nil {
        return nil
    }
    pc := make([]uintptr, 50)
    n := runtime.Callers(2, pc)
    return &withStack{
        error: err,
        stack: pc[:n],
    }
}

使用方式:

func readConfig() error {
    return fmt.Errorf("file not found")
}

func loadConfig() error {
    if err := readConfig(); err != nil {
        return WithStack(fmt.Errorf("failed to read config: %w", err))
    }
    return nil
}

func main() {
    if err := loadConfig(); err != nil {
        fmt.Printf("%+v\n", err)
    }
}

输出类似:

failed to read config: file not found
  main.loadConfig:20
  main.main:30

总结关键点

  • 标准库
    errors
    +
    %w
    :适合错误包装和链式判断(
    Is
    /
    As
    ),但无堆栈。
  • github.com/pkg/errors
    :提供
    Wrap
    %+v
    ,开箱即用的堆栈追踪,适合开发阶段。
  • 自定义堆栈:更轻量,避免依赖,但需自己维护。
  • 生产建议:开发阶段用
    pkg/errors
    ,上线后可通过日志记录堆栈,或结合 zap、logrus 等日志库输出。

基本上就这些。错误包装加堆栈,关键在于“包装时记录调用位置”,标准库没做这一步,需要你手动补上。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

174

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

224

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

335

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

206

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

388

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

193

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

188

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

191

2025.06.17

php源码安装教程大全
php源码安装教程大全

本专题整合了php源码安装教程,阅读专题下面的文章了解更多详细内容。

7

2025.12.31

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 2.3万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.5万人学习

Git中文开发手册
Git中文开发手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号