Golang网络服务错误统一响应方法-Golang-PHP中文网

Golang网络服务错误统一响应方法

P粉602998670

发布： 2025-09-23 17:13:01

原创

186人浏览过

定义统一响应结构体包含code、message、data字段，通过writeError/writeSuccess函数封装错误与成功响应，结合RecoveryMiddleware中间件捕获panic，确保所有错误返回格式一致，提升API可维护性与前端处理效率。

golang网络服务错误统一响应方法

在构建 Golang 网络服务时，统一错误响应格式能提升 API 的可维护性和前端处理的一致性。核心思路是定义标准的响应结构，在发生错误时通过中间件或封装函数返回统一格式的 JSON 响应。

定义统一响应结构

创建一个通用的响应结构体，包含状态码、消息和数据字段：

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

登录后复制

使用 omitempty 可确保没有数据时该字段不出现，使响应更简洁。

封装错误响应函数

在 handler 中避免直接写 JSON，而是通过工具函数返回标准化错误：

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

func writeError(w http.ResponseWriter, code int, message string) {
    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(code)
    json.NewEncoder(w).Encode(Response{
        Code:    code,
        Message: message,
    })
}

func writeSuccess(w http.ResponseWriter, data interface{}) {
    w.Header().Set("Content-Type", "application/json")
    w.WriteHeader(http.StatusOK)
    json.NewEncoder(w).Encode(Response{
        Code:    0,
        Message: "success",
        Data:    data,
    })
}

登录后复制

结合中间件自动处理 panic 和错误

使用中间件捕获未处理的 panic，并转换为统一错误响应：

挖错网

一款支持文本、图片、视频纠错和AIGC检测的内容审核校对平台。

查看详情

func RecoveryMiddleware(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        defer func() {
            if err := recover(); err != nil {
                log.Printf("Panic: %v", err)
                writeError(w, http.StatusInternalServerError, "internal server error")
            }
        }()
        next.ServeHTTP(w, r)
    })
}

登录后复制

将中间件应用于路由，确保所有请求都受保护。

在业务逻辑中主动返回错误

handler 中根据业务判断调用 writeError：

http.HandleFunc("/user", func(w http.ResponseWriter, r *http.Request) {
    if r.Method != "GET" {
        writeError(w, http.StatusMethodNotAllowed, "method not allowed")
        return
    }
    // 正常逻辑
    writeSuccess(w, map[string]string{"name": "alice"})
})

登录后复制

这样无论参数校验、权限检查还是数据库错误，都能以相同格式返回。

基本上就这些。关键在于集中处理响应逻辑，避免散落在各处，同时配合中间件兜底，保证错误不会暴露内部细节。统一结构也便于前端统一拦截处理。

以上就是Golang网络服务错误统一响应方法的详细内容，更多请关注php中文网其它相关文章！