0

0

如何设计Golang自定义错误类型_Golang自定义错误类型创建与应用

P粉602998670

P粉602998670

发布时间:2026-02-23 18:36:11

|

533人浏览过

|

来源于php中文网

原创

应使用自定义错误结构体而非 errors.new 或 fmt.errorf,因其支持上下文携带、类型断言、错误分支区分;需实现 error() 方法,用指针类型定义,配合 errors.as/errors.is 判断,避免字符串比较或混用哨兵与结构体错误。

如何设计golang自定义错误类型_golang自定义错误类型创建与应用

为什么不能只用 errors.Newfmt.Errorf

当错误需要携带上下文(如请求ID、失败行号、重试次数)、支持类型断言、或需区分不同错误分支(比如数据库连接失败 vs 记录未找到)时,errors.New 返回的纯字符串错误就力不从心了。它无法被程序逻辑识别,也无法附加结构化字段。

常见错误现象:多个地方都返回 fmt.Errorf("user not found"),上层只能靠字符串匹配判断——脆弱、易错、无法加额外元数据。

  • 使用场景:API 错误码映射、重试策略判定、日志结构化打点、gRPC 状态码转换
  • 性能影响:自定义错误类型本身无额外开销;但若在错误中存储大量对象(如整个 *http.Request),会延长错误生命周期并阻碍 GC
  • 兼容性:所有自定义错误必须实现 Error() string 方法,否则无法满足 error 接口

如何定义可判断、可扩展的错误类型

推荐用结构体 + 实现 error 接口,并嵌入 fmt.Stringer 或直接实现 Error()。关键是要让错误可类型断言,且字段可读可查。

示例:

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

type UserNotFoundError struct {
    UserID   int64
    ReqID    string
    RetryNum int
}

func (e *UserNotFoundError) Error() string {
    return fmt.Sprintf("user not found: id=%d, req_id=%s", e.UserID, e.ReqID)
}

// 可选:支持 Unwrap 以兼容 errors.Is / errors.As(Go 1.13+)
func (e *UserNotFoundError) Unwrap() error { return nil }
  • 务必用指针类型定义(*UserNotFoundError)——值类型无法被 errors.As 正确识别
  • 如果错误需嵌套其他错误(如“DB 查询失败导致用户未找到”),在结构体中加 err error 字段,并在 Unwrap() 中返回它
  • 避免在错误结构体中放不可序列化字段(如 sync.Mutex、函数、channel),否则 JSON 序列化或日志采集会 panic

如何在业务中正确使用和判断自定义错误

核心是用 errors.Aserrors.Is 替代字符串比较,既安全又利于后期重构。

成新网络商城购物系统
成新网络商城购物系统

使用模板与程序分离的方式构建,依靠专门设计的数据库操作类实现数据库存取,具有专有错误处理模块,通过 Email 实时报告数据库错误,除具有满足购物需要的全部功能外,成新商城购物系统还对购物系统体系做了丰富的扩展,全新设计的搜索功能,自定义成新商城购物系统代码功能代码已经全面优化,杜绝SQL注入漏洞前台测试用户名:admin密码:admin888后台管理员名:admin密码:admin888

下载

错误创建:

return &UserNotFoundError{UserID: 123, ReqID: r.Header.Get("X-Request-ID")}

错误判断:

if err != nil {
    var notFoundErr *UserNotFoundError
    if errors.As(err, &notFoundErr) {
        log.Warn("user not found", "user_id", notFoundErr.UserID, "req_id", notFoundErr.ReqID)
        return http.StatusNotFound, nil
    }
}
  • errors.As 用于提取具体错误实例(含字段),errors.Is 用于判断是否为某类错误(常配合 Is() 方法或哨兵变量)
  • 不要用 == 比较两个自定义错误指针——它们永远不等,除非指向同一地址
  • 若需全局唯一哨兵错误(如 ErrInvalidInput),定义为变量而非结构体实例,避免每次分配

什么时候该用哨兵错误,什么时候该用结构体错误

哨兵错误(如 var ErrPermissionDenied = errors.New("permission denied"))适用于无上下文、无需携带字段、仅作流程分支的简单场景;结构体错误适用于需携带上下文、支持分类处理、或未来可能扩展字段的场景。

容易踩的坑:

  • 混用两者:比如对结构体错误用 errors.Is(err, ErrNotFound) —— 这永远返回 false,因为 ErrNotFound 是值,而实际错误是 *UserNotFoundError 实例
  • 过度设计:一个只在单个函数内返回、且绝不会被上层捕获的错误,没必要定义新类型,fmt.Errorf 足够
  • 忽略错误包装:调用下游函数后直接返回其错误(如 return db.QueryRow(...)),丢失当前层上下文;应使用 fmt.Errorf("query user: %w", err) 包装并保留原始错误链

真正难的是保持错误语义清晰——不是每个错误都需要自定义,但一旦定义,就要确保它能被稳定识别、安全解包、且字段含义不随版本模糊。

热门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、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

242

2024.02.23

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

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

349

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开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

405

2024.05.21

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

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

365

2025.06.09

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

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

200

2025.06.10

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

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

1071

2025.06.17

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

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

1127

2026.02.13

热门下载

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

精品课程

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

共32课时 | 5.4万人学习

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

共10课时 | 0.9万人学习

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

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