go-zero 框架处理全局错误并封装标准错误码的核心做法是自定义 logic 层的 handle 方法,并在 api 配置中指定全局错误处理器。通过实现 errorx.codeerr 结构体,可以将业务逻辑中的异常统一转换为包含 http 状态码、错误码和错误信息的 json 响应,从而避免在每个接口中重复编写错误处理逻辑。

如何定义全局错误处理器以拦截所有 API 响应?
要实现全局错误拦截,需要在 goctl 生成的 server.go 文件中配置 GlobalError 选项。该选项接收一个实现了 errorx.ServerHandler 接口的函数。当 logic 层返回任何非 nil 的错误时,框架会自动调用此函数进行格式化输出。开发者只需在 logic 中返回标准的 CodeErr 实例,即可确保所有 API 响应格式一致。

package server
import (
"github.com/zeromicro/go-zero/core/logx"
"github.com/zeromicro/go-zero/rest/httpx"
"your-project/internal/handler"
"your-project/internal/config"
)
// GlobalErrorHandler 全局错误处理函数
func GlobalErrorHandler(err error) (int, any) {
// 假设我们有一个统一的错误类型 CodeErr
if codeErr, ok := err.(*errorx.CodeErr); ok {
return http.StatusOK, map[string]any{
"code": codeErr.ErrCode,
"message": codeErr.ErrMsg,
}
}
// 未知错误默认返回 500
logx.Error(err)
return http.StatusInternalServerError, map[string]any{
"code": 50000,
"message": "Internal Server Error",
}
}
func StartServer(c config.Config) {
srv := rest.MustNewServer(c.RestConf, rest.WithGlobalErrorHandler(GlobalErrorHandler))
handler.RegisterHandlers(srv)
defer logx.Stop()
srv.Start()
}
在上述代码中,rest.WithGlobalErrorHandler 是关键配置。它注册了 GlobalErrorHandler 函数。该函数检查传入的 err 是否为 *errorx.CodeErr 类型。如果是,则提取其中的 ErrCode 和 ErrMsg 字段,并返回 HTTP 200 状态码(通常业务错误不改变 HTTP 状态码,除非是网络层错误)及对应的 JSON 结构。如果不是预期的业务错误,则记录日志并返回通用的 500 错误。
如何在 Logic 层统一使用标准错误码结构?
在 logic 层中,不应直接返回原始的 errors.New 或数据库驱动错误,而应将其包装为 CodeErr。这要求定义一套标准的错误码常量,并在每个可能出错的分支中显式返回这些结构化错误。这样可以保证前端或调用方能根据 code 字段进行具体的业务判断,如“用户不存在”、“余额不足”等。

package logic
import (
"context"
"errors"
"github.com/zeromicro/go-zero/core/logx"
"github.com/zeromicro/go-zero/errorx"
"your-project/internal/svc"
"your-project/internal/models"
)
const (
ErrUserNotFound = 10001
ErrInsufficientBalance = 10002
)
func GetUser(ctx context.Context, c *svc.ServiceContext, id int64) (*models.User, error) {
user, err := c.DB.User.FindOne(ctx, id)
if err != nil {
if errors.Is(err, gorm.ErrRecordNotFound) {
// 将数据库错误转换为标准业务错误
return nil, errorx.NewCodeErr(ErrUserNotFound, "User not found")
}
// 其他数据库错误
return nil, errorx.NewCodeErr(50000, "Database error")
}
return user, nil
}
func Transfer(ctx context.Context, c *svc.ServiceContext, fromID, toID, amount int64) error {
fromUser, _ := c.DB.User.FindOne(ctx, fromID)
if fromUser.Balance < amount {
return errorx.NewCodeErr(ErrInsufficientBalance, "Insufficient balance")
}
// ... 执行转账逻辑
return nil
}
这段代码展示了 logic 层的具体实践。GetUser 函数中,当 gorm 返回 ErrRecordNotFound 时,不再直接向上抛出原始错误,而是使用 errorx.NewCodeErr 创建一个新的错误对象,赋予特定的业务错误码 ErrUserNotFound。同样,Transfer 函数在余额不足时返回 ErrInsufficientBalance。这种处理方式使得错误信息标准化,便于前端解析和展示。
当 Logic 层返回未定义的普通 error 时全局处理器会如何处理?
如果 logic 层意外返回了一个未实现 CodeErr 接口的普通 error 对象,或者发生了未捕获的 panic,全局错误处理器中的类型断言会失败。此时,代码会进入 else 分支,即 if codeErr, ok := err.(*errorx.CodeErr); ok 之后的部分。在这种情况下,系统会将错误记录到日志中,并返回一个默认的 50000 错误码和 “Internal Server Error” 消息。HTTP 状态码也会变为 500。这是一种安全兜底机制,防止因未处理的异常导致服务崩溃或返回不规范的响应。


















