Golang自定义error类型_实现error接口添加更多错误信息

老雪吖_5669

老雪吖_5669

2026-02-24

224人浏览

原创

Go自定义error必须实现Error()方法,否则if err != nil不生效;还需实现Unwrap()和Is()以支持errors.As()和errors.Is(),并注意JSON序列化字段导出与标签。

golang自定义error类型_实现error接口添加更多错误信息

Go里自定义error类型必须实现Error()方法

Go的error接口就一个方法:Error() string。只要你的结构体实现了它,就是合法的error。别想绕过这个——不实现它,哪怕字段再丰富,if err != nil也永远进不去分支。

常见错误是只加了字段、忘了写Error(),或者返回空字符串,结果日志里打印出来是或空白,排查时一头雾水。

  • 必须返回有意义的字符串,通常拼接关键字段(比如code、message、traceID)
  • 不要在Error()里做耗时操作(如调用fmt.Sprintf拼接大量上下文),影响错误路径性能
  • 如果需要携带原始错误,用Unwrap()方法(Go 1.13+),否则上层调用errors.Is()或errors.As()会失败
type AppError struct {
    Code    int
    Message string
    TraceID string
    Err     error // 原始底层错误
}
func (e *AppError) Error() string {
    return fmt.Sprintf("code=%d msg=%s trace=%s", e.Code, e.Message, e.TraceID)
}
func (e *AppError) Unwrap() error { return e.Err }

带堆栈信息的error要用fmt.Errorf加%w或errors.Join

单纯实现Error()没法自动捕获调用栈。想让panic或日志里看到出错位置,得靠fmt.Errorf的%w动词包装,或者用errors.Join组合多个错误。

典型坑:自己写了Error()方法,又手动调用fmt.Errorf("wrap: %v", err)但没加%w,导致errors.Is()失效,且堆栈断在包装处,不是原始出错点。

  • fmt.Errorf("failed to read: %w", ioErr) → 保留原始堆栈和可判定性
  • fmt.Errorf("failed to read: %v", ioErr) → 堆栈丢失,errors.Is(ioErr)返回false
  • 多个错误合并用errors.Join(err1, err2),比拼接字符串更利于下游解析

区分业务错误和系统错误:用errors.Is判断而不是==

自定义error类型一旦涉及多实例(比如不同Code的AppError),就不能用==比较。因为每次&AppError{Code: 404}都是新地址,err == someErr永远为false。

Golang Uber Dig
Golang Uber Dig

使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器,提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象,支持命名依赖等

下载

正确方式是给错误类型定义导出的变量(哨兵错误),或用errors.Is()配合Is()方法。

  • 定义哨兵:var ErrNotFound = &AppError{Code: 404, Message: "not found"}
  • 实现Is(target error) bool方法,支持按Code或语义匹配
  • 调用方统一用errors.Is(err, ErrNotFound)或errors.Is(err, context.Canceled)
func (e *AppError) Is(target error) bool {
    if t, ok := target.(*AppError); ok {
        return e.Code == t.Code
    }
    return false
}

JSON序列化自定义error时字段名要对齐json:标签

很多服务把error结构体直接json.Marshal返回给前端,这时字段名大小写、是否导出、json:标签都直接影响输出。常见问题:字段全小写没加json:,结果序列化出来是空对象{};或者用了json:"-" 却忘了去掉敏感字段(比如Err里的内部错误详情)。

  • 所有要暴露的字段必须首字母大写(导出)
  • 显式加json:标签控制键名,避免意外驼峰或下划线
  • 敏感字段(如原始Err、调试用Stack)加上json:"-"或设为小写不导出
  • 测试一下json.Marshal(&AppError{Code: 500})输出是否符合API文档约定

最常被忽略的是Unwrap()和Is()这两个方法——它们不写,errors.As()就抽不出你的自定义类型,errors.Is()也判不准。不是“能跑就行”,而是“不用它们,下游根本没法可靠处理”。

golang免费学习笔记(深入):立即使用
在学习笔记中,你将探索golang的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

golang

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2024.02.23

519

5

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

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

2024.02.23

616

5

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

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

2024.02.23

1216

5

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

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

2024.03.05

791

5

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

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

2024.05.21

1786

6

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

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

2025.06.09

5114

18

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

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

2025.06.10

2354

13

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

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

2025.06.17

4226

17

golang数组大全
golang数组大全

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

2025.06.20

5386

22

热门下载

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

精品课程

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