当前位置:首页 > 文章列表 > Golang > Go教程 > Golang错误处理中间件封装教程

Golang错误处理中间件封装教程

2025-09-01 09:35:48 0浏览 收藏

在Go Web服务开发中,统一的错误处理机制至关重要。本文提供一份**Golang错误处理中间件统一封装指南**,旨在提升代码可维护性和接口规范性。通过定义`ErrorResponse`结构体,实现标准化的错误响应格式,方便前后端协作与调试。利用`ErrorMiddleware`中间件捕获`panic`,结合`sendErrorResponse`函数,封装错误输出,确保无论程序发生何种错误,都能返回统一的JSON格式。本文还将介绍如何在handler中使用`panic`或`sendErrorResponse`主动返回错误,并将中间件应用到路由,从而实现Go Web服务的统一错误处理,让你的API服务更加健壮可靠。

定义统一错误响应结构体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响应。

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逻辑。

例如:

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,还是主动调用 sendErrorResponse,客户端收到的都是统一格式的JSON错误响应。

基本上就这些。通过中间件 + panic recover + 统一封装,可以实现简洁、统一的Golang错误处理机制,适合中小型API服务快速落地。

到这里,我们也就讲完了《Golang错误处理中间件封装教程》的内容了。个人认为,基础知识的学习和巩固,是为了更好的将其运用到项目中,欢迎关注golang学习网公众号,带你了解更多关于中间件,panic,Golang错误处理,ErrorResponse,统一封装的知识点!

HTML表格单元格垂直居中技巧HTML表格单元格垂直居中技巧
上一篇
HTML表格单元格垂直居中技巧
EV剪辑如何关闭视频原声
下一篇
EV剪辑如何关闭视频原声
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • PubMedQA数据集详解:生物医学问答基准、功能与应用指南
    PubMedQA
    深入了解PubMedQA生物医学问答数据集,涵盖其核心功能、使用方法及在临床决策、药物研发等场景的应用,助力提升NLP模型性能。
    193次使用
  • H2O EvalGPT:开源LLM大模型评估与排行榜工具
    H2O EvalGPT
    H2O EvalGPT是H2O.ai推出的开源LLM评估平台,提供详细的大模型性能排行榜、行业特定基准测试及A/B测试功能,助您快速选择最适合项目的高性能大语言模型。
    249次使用
  • LMArena是什么?伯克利AI模型评估平台使用指南与功能解析
    LMArena
    LMArena是加州大学伯克利分校推出的AI模型匿名评测平台。通过盲测投票机制,用户可对比不同大模型回答并生成实时排行榜,助力开发者优化模型及用户选择最佳AI工具。
    205次使用
  • 斯坦福HELM:大语言模型Holistic Evaluation整体评估框架详解
    HELM
    深入了解斯坦福推出的HELM(Holistic Evaluation of Language Models)大模型评测体系。本文解析其核心功能、安装配置步骤及应用场景,涵盖准确性、公平性、鲁棒性等多维度指标,助力开发者全面优化语言模型性能。
    190次使用
  • CMMLU中文大模型评估基准:功能、使用教程与应用场景解析
    CMMLU
    深入了解CMMLU中文评估基准,涵盖67个学科主题,提供数据集下载、Zero-shot/Five-shot评估方法及排行榜,助力优化中文语言模型性能。
    180次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码