Golang错误处理中间件统一错误格式封装-Golang-PHP中文网

Golang错误处理中间件统一错误格式封装

P粉602998670

发布： 2025-09-08 10:28:01

原创

597人浏览过

定义统一错误响应结构体ErrorResponse，通过ErrorMiddleware中间件捕获panic并返回标准化JSON，结合sendErrorResponse函数封装错误输出，在handler中使用panic或sendErrorResponse主动返回错误，最后将中间件应用到路由，实现Go Web服务的统一错误处理。

golang错误处理中间件统一错误格式封装

在Go语言开发中，错误处理是Web服务不可或缺的一部分。使用中间件对错误进行统一处理，可以提升代码的可维护性和接口的规范性。通过封装统一的错误响应格式，前后端协作更高效，调试也更方便。

定义统一的错误响应格式

首先，定义一个结构体来表示API返回的标准化错误信息：

type ErrorResponse struct {
    Code    int         `json:"code"`
    Message string      `json:"message"`
    Data    interface{} `json:"data,omitempty"`
}

登录后复制

Code 表示业务或HTTP状态码，Message 是可读的提示信息，Data 可选，用于携带附加信息（如调试详情）。

实现错误处理中间件

中间件的作用是捕获后续处理函数中可能发生的错误，并返回标准化的JSON响应。

立即学习“go语言免费学习笔记（深入）”；

func ErrorMiddleware(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        // 使用defer+recover捕获panic
        defer func() {
            if err := recover(); err != nil {
                // 判断是否为已知错误类型，或直接作为服务器内部错误
                var errorMsg string
                switch e := err.(type) {
                case string:
                    errorMsg = e
                case error:
                    errorMsg = e.Error()
                default:
                    errorMsg = "unknown error"
                }

                sendErrorResponse(w, http.StatusInternalServerError, "Internal Server Error", nil)
            }
        }()

        next.ServeHTTP(w, r)
    })
}

// sendErrorResponse 封装响应输出
func sendErrorResponse(w http.ResponseWriter, code int, message string, data interface{}) {
    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(code)

    resp := ErrorResponse{
        Code:    code,
        Message: message,
        Data:    data,
    }

    json.NewEncoder(w).Encode(resp)
}

登录后复制

在业务中主动返回错误

在Handler中，可以通过 panic 自定义错误，或者调用统一函数返回错误，避免重复写JSON逻辑。

KAIZAN.ai

使用AI来改善客户服体验，提高忠诚度

查看详情

例如：

func userHandler(w http.ResponseWriter, r *http.Request) {
    userId := r.URL.Query().Get("id")
    if userId == "" {
        panic("user id is required")
    }

    // 模拟业务错误
    if userId == "0" {
        sendErrorResponse(w, http.StatusBadRequest, "Invalid user id", nil)
        return
    }

    fmt.Fprintf(w, `{"data": "user %s"}`, userId)
}

登录后复制

也可以定义错误类型，比如

BusinessError

登录后复制

，在中间件中做类型判断，实现更精细的控制。

集成到HTTP服务

将中间件应用到路由：

http.Handle("/user", ErrorMiddleware(http.HandlerFunc(userHandler)))
log.Println("Server starting on :8080")
log.Fatal(http.ListenAndServe(":8080", nil))

登录后复制

这样，无论是在处理过程中 panic，还是主动调用