讲师中心 微信公众号
AI工具推荐 视频效率加速

如何使用Golang统一管理错误码_定义常量和错误信息映射

夏明同学_7320

夏明同学_7320

发布时间:2025-12-18 14:27:33

|

206人浏览过

|

来源于php中文网

原创

Go项目统一管理错误码的核心是:用iota常量定义错误码,用map[int]string映射错误信息,封装含Code和Message字段的自定义Err结构体实现error接口,并在业务中全程传递结构化错误。

如何使用golang统一管理错误码_定义常量和错误信息映射

在 Go 语言项目中,统一管理错误码的核心是:用常量定义错误码,用结构体或映射(map)关联错误码与可读的错误信息,并封装成易用的错误类型。这样做能避免硬编码、提升可维护性、支持国际化扩展,也方便日志记录和 API 返回。

定义错误码常量(推荐用 iota)

将所有业务错误码集中定义在一个包(如 pkg/errno)中,使用 iota 自动生成连续整数值,语义清晰且不易重复:

  • 为每个错误码赋予有意义的名称,如 ErrUserNotFound、ErrInvalidParam
  • 预留通用错误码区间(如 1000–1999 为用户模块,2000–2999 为订单模块),便于后续归类
  • 避免直接用数字散落在各处,防止歧义和误用

示例:

package errno

const (
    Success = iota // 0
    ErrUnknown
    ErrInvalidParam
    ErrUserNotFound
    ErrUserAlreadyExists
    // ... 其他错误码
)

构建错误信息映射表(code → message)

定义一个全局只读的 map[int]string,将错误码映射到默认提示语。该映射应在包初始化时完成,确保线程安全且不可篡改:

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

arcgis-js
arcgis-js

提供 ArcGIS Maps SDK for JavaScript 开发辅助,涵盖 2D/3D 地图视图、图层管理、数据可视化、空间分析等功能模块的参考和示例指导。

下载
  • 使用 var ErrMsgMap = map[int]string{...} 声明,键为错误码常量,值为中文(或英文)提示
  • 可配合 //go:embed 或配置文件实现动态加载,但初始版本建议硬编码保证启动性能和确定性
  • 对未定义的错误码,统一 fallback 到 "unknown error",避免 panic 或空字符串

示例:

var ErrMsgMap = map[int]string{
    Success:             "success",
    ErrUnknown:          "unknown error",
    ErrInvalidParam:     "invalid parameter",
    ErrUserNotFound:     "user not found",
    ErrUserAlreadyExists: "user already exists",
}

封装自定义错误类型(带 code 和 message)

实现 error 接口,并额外携带错误码字段,便于下游提取和分类处理:

  • 定义结构体如 Err,含 Code(int)、Message(string)字段
  • 实现 Error() 方法返回 Message,符合标准 error 行为
  • 提供构造函数如 New(code int) 和 WithMessage(code int, msg string),支持覆盖默认提示
  • 可扩展添加 Stack()、HTTPStatus() 等方法,适配不同场景

示例:

type Err struct {
    Code    int
    Message string
}

func (e *Err) Error() string { return e.Message }

func New(code int) error {
    msg, ok := ErrMsgMap[code]
    if !ok {
        msg = ErrMsgMap[ErrUnknown]
    }
    return &Err{Code: code, Message: msg}
}

func WithMessage(code int, msg string) error {
    return &Err{Code: code, Message: msg}
}

在业务中使用与最佳实践

错误码应贯穿请求生命周期:参数校验 → 服务调用 → 返回响应。关键点包括:

  • 控制器层用 errno.New(errno.ErrUserNotFound) 构造错误,不拼接字符串
  • 中间件统一拦截 *errno.Err 类型错误,提取 Code 和 Message 组装 JSON 响应(如 {"code": 404, "msg": "user not found"})
  • 日志中记录 err.Code 和原始上下文,方便排查;避免仅打 err.Error() 丢失结构化信息
  • 如需多语言,可将 ErrMsgMap 改为 map[int]map[string]string,按 locale 查找

热门AI工具

更多
切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

相关专题

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

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

519

2024.02.23

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

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

616

2024.02.23

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

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

1216

2024.02.23

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

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

791

2024.03.05

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

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

1786

2024.05.21

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

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

5074

2025.06.09

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

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

2354

2025.06.10

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

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

4226

2025.06.17

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

100

2026.10.28

热门下载

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

精品课程

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

共101课时 | 21.3万人学习

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

共39课时 | 4.9万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn