Golang实现自定义recovery中间件

 更新时间:2023年09月06日 08:27:46   作者:路多辛  
在 Golang 的 Web 项目中,自定义 recovery 中间件是一种常见的做法,用于捕获并处理应用程序的运行时错误,下面我们就来看看具体如何实现吧

为什么需要实现自定义 recovery 中间件

在 Golang 的 Web 项目中,自定义 recovery 中间件是一种常见的做法,用于捕获并处理应用程序的运行时错误,以避免整个应用程序崩溃并返回对应格式的响应数据。

很多三方 web 框架(例如 gin、echo)都提供了官方实现的 recovery 中间件,但是官方实现的中间件并不一定能满足自己的需求。例如 gin 官方提供的 recovery 中间件,发生 panic 后会将当前请求的标准状态码置为 500,body 置为空。但是这样的返回数据与格式可能会和自己的项目要求不一致。例如,项目发生 panic 后是要求标准状态码依然返回 200,body 值为 {"code":-1, "data":nil,"msg":"xxx"},这种场景下,就需要实现自己的 recovery 中间件了。

如何实现自定义 recovery 中间件

如果使用 gin 框架的话,就非常简单了,因为 gin 提供了完善的中间件功能,遵守 gin 的要求实现满足自己项目的功能就可以了,简单示例代码如下:

package main
import (
    "github.com/gin-gonic/gin"
    "log"
    "net/http"
    "runtime"
)
func Recovery() gin.HandlerFunc {
    return func(c *gin.Context) {
        defer func() {
            if err := recover(); err != nil {
                const size = 64 << 10
                stack := make([]byte, size)
                stack = stack[:runtime.Stack(stack, false)]
                log.Printf("[GinPanic] %s\n", string(stack))
                c.JSON(http.StatusOK, struct {
                    Code int         `json:"code"`
                    Data interface{} `json:"data"`
                    Msg  string      `json:"msg"`
                }{
                    Code: -1,
                    Data: nil,
                    Msg:  "server panic",
                })
                c.Abort()
            }
        }()
        c.Next()
    }
}

使用示例如下:

package main
import (
    "github.com/gin-gonic/gin"
    "runtime"
)
func main() {
    r := gin.New()
    r.Use(Recovery())
    r.GET("/test", func(c *gin.Context) {
        panic("Oops! Something went wrong.")
    })
    r.Run(":8080")
}

运行起来后,访问 /test 触发 panic 后返回了预期的结果,如下:

$ curl http://127.0.0.1:8080/test
{"code":-1,"data":null,"msg":"server panic"}

接下来再看一个基于原生包  net/http 的一个示例,代码如下:

package main
import (
    "fmt"
    "log"
    "net/http"
    "runtime/debug"
)
// 自定义的recovery中间件
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.Println("[Recovery] Panic:", err)
                // 打印堆栈跟踪信息
                log.Printf("[Recovery] Stack Trace:\n%s\n", debug.Stack())
                // 返回一个适当的错误响应给客户端
                fmt.Fprintf(w, `{"code":-1,"data":null,"msg":"server panic"}`)
            }
        }()
        // 继续处理下一个中间件或路由处理函数
        next.ServeHTTP(w, r)
    })
}
// 示例的处理函数
func helloHandler(w http.ResponseWriter, r *http.Request) {
    panic("Oops! Something went wrong.") // 模拟一个错误
    w.Write([]byte("Hello, Recovery Middleware!"))
}
func main() {
    // 创建一个多路复用器
    mux := http.NewServeMux()
    // 注册中间件
    mux.Handle("/test", recoveryMiddleware(http.HandlerFunc(helloHandler)))
    // 创建服务器
    server := &http.Server{
        Addr:    ":8080",
        Handler: mux,
    }
    // 启动服务器
    log.Println("Server is running on http://localhost:8080")
    log.Fatal(server.ListenAndServe())
}

小结

Web 应用程序在运行时遇到错误并抛出 panic 时,自定义的 recovery 中间件将会捕获panic 并记录对应的错误和堆栈信息,避免应用程序崩溃,并向客户端发送适当的错误响应数据。对于文本的示例,可以根据自己的实际需求进行调整和扩展来实现自定义的 recovery 中间件。

到此这篇关于Golang实现自定义recovery中间件的文章就介绍到这了,更多相关go recovery内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • golang服务报错: write: broken pipe的解决方案

    golang服务报错: write: broken pipe的解决方案

    在开发在线客服系统的时候,看到日志里有一些错误信息,下面这篇文章主要给大家介绍了关于golang服务报错: write: broken pipe的解决方案,需要的朋友可以参考下
    2022-09-09
  • go语言通过反射获取和设置结构体字段值的方法

    go语言通过反射获取和设置结构体字段值的方法

    这篇文章主要介绍了go语言通过反射获取和设置结构体字段值的方法,实例分析了Go语言反射的使用技巧,需要的朋友可以参考下
    2015-03-03
  • golang 并发编程之生产者消费者详解

    golang 并发编程之生产者消费者详解

    这篇文章主要介绍了golang 并发编程之生产者消费者详解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-05-05
  • Go语言列表List获取元素的4种方式

    Go语言列表List获取元素的4种方式

    Golang的列表元素的获取可以使用内置的 Front 函数获取头结点,使用 Back 函数获取尾结点,使用 Prev 获取前一个结点,使用 Next 获取下一个结点,本文就介绍了Go语言列表List获取元素的4种方式,感兴趣的可以了解一下
    2022-04-04
  • Golang实现对map的并发读写的方法示例

    Golang实现对map的并发读写的方法示例

    这篇文章主要介绍了Golang实现对map的并发读写的方法示例,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-03-03
  • Go语言之使用pprof工具查找goroutine(协程)泄漏

    Go语言之使用pprof工具查找goroutine(协程)泄漏

    这篇文章主要介绍了Go语言之使用pprof工具查找goroutine(协程)泄漏,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • Go语言LeetCode题解682棒球比赛

    Go语言LeetCode题解682棒球比赛

    这篇文章主要为大家介绍了Go语言LeetCode题解682棒球比赛示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-12-12
  • go使用errors.Wrapf()代替log.Error()方法示例

    go使用errors.Wrapf()代替log.Error()方法示例

    这篇文章主要为大家介绍了go使用errors.Wrapf()代替log.Error()的方法示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • Golang实现Dijkstra算法过程详解

    Golang实现Dijkstra算法过程详解

    Dijkstra 算法是一种用于计算无向图的最短路径的算法,它是基于贪心策略的,每次选择当前距离起始节点最近的未访问节点进行访问,并更新其相邻节点的距离值,以得到最短路径,这篇文章主要介绍了Golang实现Dijkstra算法,需要的朋友可以参考下
    2023-05-05
  • Go语言实现请求超时处理的方法总结

    Go语言实现请求超时处理的方法总结

    这篇文章主要为大家详细介绍了Go语言中实现请求的超时控制的方法,主要是通过timer和timerCtx来实现请求的超时控制,希望对大家有所帮助
    2023-05-05

最新评论