定义统一错误码结构,使用常量分组管理,按模块划分区间,通过工厂函数创建错误实例,封装判断工具,集成至HTTP响应,提升系统可观测性与可维护性。

在 Go 语言中实现一个清晰、可维护的错误码体系,对大型服务尤其是微服务架构非常重要。它能帮助开发、测试和运维快速定位问题,提升系统的可观测性和稳定性。以下是构建业务错误码标准的实用方案。
定义统一的错误码结构
业务错误码通常包含状态码、消息和可选的元信息。建议定义一个结构体来封装这些信息:
type ErrorCode struct {
Code int `json:”code”`
Message string `json:”message”`
}
其中 Code 是唯一标识错误的整数(如 10001),Message 是可读提示。可以扩展字段如 HTTPStatus 用于映射 HTTP 状态码。
使用常量定义业务错误码
将错误码集中定义为常量,避免魔法数字。按业务模块分组:
立即学习“go语言免费学习笔记(深入)”;
const (
ErrUserNotFound = 10001
ErrUserInvalidPhone = 10002
ErrOrderOutOfStock = 20001
ErrPaymentFailed = 30001
)
配套定义错误变量:
var (
UserNotFoundErr = NewBizError(ErrUserNotFound, “用户不存在”)
InvalidPhoneErr = NewBizError(ErrUserInvalidPhone, “手机号格式错误”)
)
通过工厂函数创建错误实例,确保一致性。
封装错误生成与判断工具
实现一个错误构造函数:
func NewBizError(code int, msg string) *ErrorCode {
return &ErrorCode{Code: code, Message: msg}
}
同时实现错误比较方法:
func Is(err error, target *ErrorCode) bool {
if e, ok := err.(*ErrorCode); ok {
return e.Code == target.Code
}
return false
}
这样可以在处理返回错误时精准判断类型,比如:
if errors.Is(err, UserNotFoundErr) {
// 处理用户不存在
}
集成到 HTTP 响应中
在 API 返回时,统一包装错误响应:
type Response struct {
Success bool `json:”success”`
Data interface{} `json:”data,omitempty”`
Error *ErrorCode `json:”error,omitempty”`
}
中间件可自动捕获业务错误并返回标准 JSON:
c.JSON(400, Response{Success: false, Error: InvalidPhoneErr})
前端根据 code 做不同提示,比如登录失败重定向,库存不足刷新页面。
基本上就这些。关键是统一结构、集中定义、便于比较和传输。错误码不宜过多,建议按模块划分区间(如 1xx 用户,2xx 订单),保持可扩展性。不复杂但容易忽略细节。
以上就是Golang如何实现错误码体系 定义业务错误标准的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1400311.html
微信扫一扫
支付宝扫一扫