0

0

如何在Golang中实现Web应用错误处理_统一返回错误信息

P粉602998670

P粉602998670

发布时间:2025-12-30 17:07:02

|

812人浏览过

|

来源于php中文网

原创

统一错误处理需拦截业务错误、标准化响应结构、防止信息泄露并正确映射HTTP状态码;通过ErrorResponse结构定义业务码与消息,用中间件捕获panic和error,handler返回(interface{}, error),由ResultHandler统一渲染,并按AppError.Code映射合理HTTP状态码。

如何在golang中实现web应用错误处理_统一返回错误信息

在 Golang Web 开发中,统一错误处理的核心是拦截业务错误、标准化响应结构、避免敏感信息泄露,并保持 HTTP 状态码语义正确。不推荐直接在每个 handler 里写 if err != nil + json.NewEncoder(w).Encode(...),那样重复且易出错。

定义统一错误响应结构

先设计一个前端友好的 JSON 错误格式,包含状态码、错误码、消息和可选的详情:

type ErrorResponse struct {
    Code    int    `json:"code"`    // 业务错误码,如 1001
    Message string `json:"message"` // 用户可见提示
    TraceID string `json:"trace_id,omitempty` // 用于日志追踪(可选)
}

注意:HTTP 状态码(如 400、500)由 w.WriteHeader() 控制,不要和 Code 字段混淆。前者告诉客户端“请求是否成功”,后者告诉前端“具体哪类业务失败”。

封装中间件统一捕获 panic 和错误

用中间件包裹 handler,集中处理两类异常:

立即学习go语言免费学习笔记(深入)”;

Rationale
Rationale

Rationale 是一款可帮助企业主、经理和个人做出艰难的决定的AI工具

下载
  • 显式返回的 error(例如校验失败、DB 查询为空)
  • 未捕获的 panic(如空指针、数组越界)
func ErrorHandler(next http.Handler) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        defer func() {
            if err := recover(); err != nil {
                http.Error(w, "Internal Server Error", http.StatusInternalServerError)
                log.Printf("PANIC: %v, trace: %s", err, debug.Stack())
            }
        }()

        // 包装 ResponseWriter,捕获 WriteHeader 调用(可选:用于日志或重写状态码)
        rw := &responseWriter{ResponseWriter: w, statusCode: http.StatusOK}
        next.ServeHTTP(rw, r)

        // 如果 handler 显式返回了 error(需配合自定义 context 或返回值约定),此处可扩展处理
        // 更推荐:handler 返回 (interface{}, error),由中间件判断并渲染
    })
}

让 handler 返回 error 并交由中间件渲染

修改 handler 签名,使其返回 (interface{}, error),再用中间件做最终响应:

type Result struct {
    Data  interface{} `json:"data,omitempty"`
    Error *ErrorResponse `json:"error,omitempty"`
}

func UserHandler(w http.ResponseWriter, r *http.Request) (interface{}, error) {
    id := chi.URLParam(r, "id")
    if id == "" {
        return nil, &AppError{Code: 1001, Message: "用户 ID 不能为空"}
    }
    user, err := db.GetUser(id)
    if err != nil {
        return nil, &AppError{Code: 1002, Message: "用户不存在"}
    }
    return user, nil
}

// 中间件解析 result 并写入响应
func ResultHandler(handler func(http.ResponseWriter, *http.Request) (interface{}, error)) http.Handler {
    return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        data, err := handler(w, r)
        if err != nil {
            // 假设 AppError 实现了 error 接口,并携带 Code/Message
            appErr, ok := err.(*AppError)
            if !ok {
                appErr = &AppError{Code: 5000, Message: "未知错误"}
            }
            w.Header().Set("Content-Type", "application/json; charset=utf-8")
            w.WriteHeader(appErr.HTTPStatus()) // 如 400 → 400,500 → 500
            json.NewEncoder(w).Encode(Result{Error: &ErrorResponse{
                Code:    appErr.Code,
                Message: appErr.Message,
                TraceID: getTraceID(r),
            }})
            return
        }
        w.Header().Set("Content-Type", "application/json; charset=utf-8")
        w.WriteHeader(http.StatusOK)
        json.NewEncoder(w).Encode(Result{Data: data})
    })
}

区分错误类型,合理设置 HTTP 状态码

不同错误应映射到不同 HTTP 状态码,帮助前端做差异化处理:

  • 客户端错误(参数缺失、格式错误、权限不足)→ 400 Bad Request / 401 Unauthorized / 403 Forbidden
  • 资源未找到404 Not Found
  • 服务端内部错误(DB 挂了、第三方超时)→ 500 Internal Server Error503 Service Unavailable

建议封装一个 AppError 类型,内置 HTTPStatus() 方法,避免硬编码状态码:

type AppError struct {
    Code    int
    Message string
    status  int // 对应 HTTP 状态码
}

func (e *AppError) HTTPStatus() int {
    switch e.Code {
    case 1001, 1002:
        return http.StatusBadRequest
    case 1003:
        return http.StatusForbidden
    case 1004:
        return http.StatusNotFound
    default:
        return http.StatusInternalServerError
    }
}

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

173

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

224

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

335

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

206

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

388

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

193

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

187

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

191

2025.06.17

桌面文件位置介绍
桌面文件位置介绍

本专题整合了桌面文件相关教程,阅读专题下面的文章了解更多内容。

0

2025.12.30

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.1万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号