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

在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逻辑。
例如:
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错误处理中间件 统一错误格式封装的详细内容,更多请关注创想鸟其它相关文章!
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/1404105.html
微信扫一扫
支付宝扫一扫