0

0

Golang Sentinel Error模式_定义预定义错误变量的最佳实践

P粉602998670

P粉602998670

发布时间:2026-02-18 13:46:03

|

388人浏览过

|

来源于php中文网

原创

应该,但需封装:用 var 声明顶层哨兵错误,优先 errors.new;需上下文或扩展时升级为自定义类型并实现 unwrap() 返回自身;包装必须用 %w,导出错误名以 err 开头且慎用。

golang sentinel error模式_定义预定义错误变量的最佳实践

Go 里该不该用 var ErrXXX = errors.New("xxx") 定义 Sentinel 错误?

应该,但得加一层封装。直接裸用 errors.New 创建的错误变量,无法携带上下文、不支持比较语义(比如 errors.Is)、也不利于后期扩展为带字段的错误类型。

常见错误现象:写了个 var ErrNotFound = errors.New("not found"),后来想在日志里加请求 ID,发现没法动态注入;或者调用方用 == 比较失败——因为 errors.New 每次都新建实例,地址不同。

  • 始终用 var 声明顶层错误变量,别在函数里重复 errors.New
  • 优先用 errors.New 而不是 fmt.Errorf 初始化 Sentinel 错误(后者隐含格式化开销,且易误加参数)
  • 如果未来可能需要携带字段(如码、追踪 ID),现在就定义为自定义类型,哪怕暂时只实现 Error() 方法

为什么 errors.Is 找不到你定义的 ErrXXX

因为 errors.Is 依赖错误链中的“底层哨兵值”匹配,而你可能无意中把它包掉了。比如用了 fmt.Errorf("wrap: %w", ErrNotFound) 是 OK 的,但 fmt.Errorf("wrap: %v", ErrNotFound) 就断链了——%v 触发 Error() 输出字符串,丢掉原始错误引用。

使用场景:HTTP handler 中判断是否返回 404,或重试逻辑里跳过特定错误。

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

LOGO.com
LOGO.com

在线生成Logo,100%免费

下载
  • 所有包装必须用 %w 动词,不能用 %s%v 或字符串拼接
  • 自定义错误类型若要支持 errors.Is,需在 Unwrap() 方法中返回哨兵变量(或 nil)
  • 测试时用 errors.Is(err, pkg.ErrNotFound),别用 err == pkg.ErrNotFound(后者只对未包装的顶层错误有效)

Sentinel 错误该放在 package 还是 internal/?

公开暴露的错误(调用方需要显式判断并处理的)必须放在 package 顶层;仅内部使用的哨兵错误应移入 internal/ 或私有变量(首字母小写),否则会污染导出 API。

性能影响:无。但兼容性影响大——一旦导出,就不能删、不能改类型、甚至不能改错误文本(有些下游用 strings.Contains(err.Error(), "timeout") 这种反模式硬匹配)。

  • 导出错误变量名必须以 Err 开头,如 ErrTimeout,符合 Go 社区惯例
  • 如果错误只在本包内判断(比如某个 retry loop),定义为小写变量 errInvalidState 即可
  • 不要为每个 HTTP 状态码都导出一个 ErrStatus400——状态码映射应由 handler 层统一处理,错误类型聚焦业务语义

要不要给 Sentinel 错误加错误码字段?

要,但别一开始就加结构体。先用纯 var + errors.New,等真出现多语言提示、监控分类、或需要和外部系统对齐码值时,再升级为带字段的类型。过早抽象反而增加调用方负担。

容易踩的坑:有人一上来就定义 type NotFoundError struct{ Code int; Msg string },结果发现 errors.Is(err, pkg.ErrNotFound) 失败——因为新类型没实现 Unwrap() 返回哨兵值。

  • 升级路径:从 var ErrNotFound = errors.New("not found") → 改为 var ErrNotFound = &notFoundError{},其中 notFoundError 是未导出类型
  • Unwrap() 方法必须返回 ErrNotFound 自身(或 nil),才能维持 errors.Is 链路
  • 错误码字段建议用常量定义(如 const CodeNotFound = 404),别硬编码在结构体里
事情说清了就结束。最常被忽略的是:Sentinel 错误的生命期比你想的长得多——它一旦导出,就变成 API 的一部分,改名、删掉、甚至改错信息,都可能让下游 panic。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

通义千问
通义千问

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

207

2024.02.23

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

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

238

2024.02.23

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

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

348

2024.02.23

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

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

212

2024.03.05

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

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

403

2024.05.21

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

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

344

2025.06.09

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

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

197

2025.06.10

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

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

950

2025.06.17

pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法
pixiv网页版官网登录与阅读指南_pixiv官网直达入口与在线访问方法

本专题系统整理pixiv网页版官网入口及登录访问方式,涵盖官网登录页面直达路径、在线阅读入口及快速进入方法说明,帮助用户高效找到pixiv官方网站,实现便捷、安全的网页端浏览与账号登录体验。

561

2026.02.13

热门下载

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

精品课程

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

共32课时 | 5.2万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.8万人学习

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

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