0

0

Go语言如何创建自定义错误类型_Golang自定义错误实现技巧

P粉602998670

P粉602998670

发布时间:2026-01-27 10:07:02

|

127人浏览过

|

来源于php中文网

原创

当错误需携带上下文、支持类型断言或扩展方法时,errors.New/fmt.Errorf 不足;应定义实现error接口的导出结构体(如*NotFoundError),用errors.As安全识别,并注意nil指针、JSON序列化及包路径一致性。

go语言如何创建自定义错误类型_golang自定义错误实现技巧

为什么直接用 errors.Newfmt.Errorf 不够用

当错误需要携带上下文(比如请求 ID、失败的文件路径、重试次数)、支持类型断言判断错误种类,或需实现 Error() 以外的方法(如 Timeout()Retryable())时,基础错误构造函数就力不从心了。Go 的错误本质是接口:type error interface { Error() string },只要满足这个契约就能当错误用——所以自定义类型只需实现它,但更进一步,它还能带字段、方法和行为。

如何定义可判断类型的自定义错误结构体

关键点不是“怎么写结构体”,而是“怎么让调用方能安全识别并处理它”。推荐方式是导出错误类型,并让其实现 error 接口:

type NotFoundError struct {
    Path string
    Code int
}

func (e *NotFoundError) Error() string {
    return fmt.Sprintf("not found: %s (code %d)", e.Path, e.Code)
}

func (e *NotFoundError) IsNotFound() bool {
    return true
}

使用时可类型断言:

if err != nil {
    var nf *NotFoundError
    if errors.As(err, &nf) {
        log.Printf("missing resource: %s", nf.Path)
        return
    }
}
  • 必须用指针类型(*NotFoundError)实现 error,否则 errors.As 无法匹配
  • 不要在 Error() 中 panic 或访问未初始化字段,日志/HTTP 中间件可能随时调用它
  • 若错误类型仅用于标识(无额外字段),可用私有结构体 + 导出变量,更轻量:
var ErrInvalidToken = &invalidTokenError{}

type invalidTokenError struct{}

func (*invalidTokenError) Error() string { return "invalid auth token" }

何时该用 fmt.Errorf 包裹而不是新建类型

包裹(wrap)适用于“错误链”场景:底层出错,上层加一层上下文,但不改变错误语义。此时用 fmt.Errorf("read config: %w", err),再配合 errors.Is/errors.As 判断原始错误。

唱鸭
唱鸭

音乐创作全流程的AI自动作曲工具,集 AI 辅助作词、AI 自动作曲、编曲、混音于一体

下载

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

  • %w 才会保留原始错误;用 %s 就断链了
  • 如果包裹后还需暴露新字段(如重试策略),就得组合:自定义类型内部嵌入原错误 + 实现 Unwrap()
  • 避免层层包裹却不检查——日志里看到一长串“failed to … because failed to … because …”却没法针对性处理

常见陷阱:JSON 序列化自定义错误和 nil 指针

自定义错误结构体若含指针字段(如 *string),且未初始化,在 JSON 编码时可能 panic 或输出 null,而调用方误以为字段存在。更隐蔽的问题是:返回 nil *MyError 仍满足 error 接口(因为接口值本身非 nil),但解引用会 panic。

  • 初始化所有字段,或用零值安全的类型(如 string 代替 *string
  • Error() 方法开头加 if e == nil { return "(nil error)" } 防止 panic
  • 别把自定义错误直接塞进 json.Marshal 当响应体——它不是数据结构,是运行时诊断信息;真要透出细节,显式定义 AsMap() 方法

最易被忽略的是:错误类型的包路径变更会导致 errors.As 失败——跨模块时务必注意导入路径一致性,别因重命名包让下游的类型断言永远为 false。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
什么是中间件
什么是中间件

中间件是一种软件组件,充当不兼容组件之间的桥梁,提供额外服务,例如集成异构系统、提供常用服务、提高应用程序性能,以及简化应用程序开发。想了解更多中间件的相关内容,可以阅读本专题下面的文章。

178

2024.05.11

Golang 中间件开发与微服务架构
Golang 中间件开发与微服务架构

本专题系统讲解 Golang 在微服务架构中的中间件开发,包括日志处理、限流与熔断、认证与授权、服务监控、API 网关设计等常见中间件功能的实现。通过实战项目,帮助开发者理解如何使用 Go 编写高效、可扩展的中间件组件,并在微服务环境中进行灵活部署与管理。

214

2025.12.18

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

418

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

string转int
string转int

在编程中,我们经常会遇到需要将字符串(str)转换为整数(int)的情况。这可能是因为我们需要对字符串进行数值计算,或者需要将用户输入的字符串转换为整数进行处理。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

422

2023.08.02

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

235

2023.09.22

Python 自然语言处理(NLP)基础与实战
Python 自然语言处理(NLP)基础与实战

本专题系统讲解 Python 在自然语言处理(NLP)领域的基础方法与实战应用,涵盖文本预处理(分词、去停用词)、词性标注、命名实体识别、关键词提取、情感分析,以及常用 NLP 库(NLTK、spaCy)的核心用法。通过真实文本案例,帮助学习者掌握 使用 Python 进行文本分析与语言数据处理的完整流程,适用于内容分析、舆情监测与智能文本应用场景。

9

2026.01.27

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

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

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