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

在 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语言免费学习笔记(深入)”;
- 使用
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 查找










