Skip to main content

错误处理

Error 规范#

Eagle 为微服务提供了统一的 Error 模型:

type Error struct {    code    int      `json:"code"`    msg     string   `json:"msg"`    details []string `json:"details"`}
  • code 业务错误码，用于外部展示
  • msg 错误信息，可以帮助用户轻松地理解和解决API错误
  • details 具体的错误原因，可以用来更详细的错误判定
  1. 强制规范错误的使用，避免了开发中直接透传 Go 的 error, 从而导致一些敏感信息泄露
  2. Error中的 StatusCode 方法会将错误码转换为 HTTP 状态码，方便监控和告警处理

错误码定义#

系统错误#

框架定好了一些常用的错误，可以直接使用。

// github.com/go-eagle/eagle/pkg/errors/code.goSuccess               = NewError(0, "Success")ErrInternalServer     = NewError(10001, "Internal server error")ErrBind               = NewError(10002, "Bind request error")ErrInvalidParam       = NewError(10003, "Invalid params")ErrSignParam          = NewError(10004, "Invalid sign")ErrValidation         = NewError(10005, "Validation failed")ErrDatabase           = NewError(10006, "Database error")ErrToken              = NewError(10007, "Gen token error")ErrInvalidToken       = NewError(10108, "Invalid token")ErrTokenTimeout       = NewError(10109, "Token timeout")ErrTooManyRequests    = NewError(10110, "Too many request")ErrInvalidTransaction = NewError(10111, "Invalid transaction")ErrEncrypt            = NewError(10112, "Encrypting the user password error")ErrLimitExceed        = NewError(10113, "Beyond limit")ErrServiceUnavailable = NewError(10114, "Service Unavailable")

业务错误#

业务错误码可以单独定义，可以放到一个文件或者根据功能分离到多个文件。

示例：用户错误码定义

// github.com/go-eagle/eagle/internal/ecode/user.goErrUserNotFound          = errcode.NewError(20101, "The user was not found.")ErrPasswordIncorrect     = errcode.NewError(20102, "账号或密码错误")ErrAreaCodeEmpty         = errcode.NewError(20103, "手机区号不能为空")ErrPhoneEmpty            = errcode.NewError(20104, "手机号不能为空")...

使用方式#

在handler中返回错误，有以下两种方式

方式一: errors.New()#

在底层(service)通过 errors.New() 的方式返回时

var req FollowRequestif err := c.ShouldBindJSON(&req); err != nil {  log.Warnf("follow bind param err: %v", err)  response.Error(c, errcode.ErrBind.WithDetails(err.Error()))  return}

方式二: 错误码#

底层(service)通过 系统 或 自定义 错误码返回，比如 errcode.ErrInternalServer 或 ecode.ErrUserNotFound

var req FollowRequestif err := c.ShouldBindJSON(&req); err != nil {  log.Warnf("follow bind param err: %v", err)  response.Error(c, err)  return}