Recovery
Recovery 中间件是 Hertz 框架预置的中间件,为 Hertz 框架提供 panic 恢复的功能。
Recovery 中间件是 Hertz 框架预置的中间件,使用 server.Default()
可以默认注册该中间件,为 Hertz 框架提供 panic 恢复的功能。
如果你不使用 server.Default()
,你也可以通过以下方式注册 Recovery 中间件:
h := server.New()
h.Use(recovery.Recovery())
Recovery 中间件会恢复 Hertz 框架运行中的任何 panic,在 panic 发生之后,Recover 中间件会默认打印出 panic 的时间、内容和堆栈信息,同时通过 *app.RequestContext
将返回响应的状态码设置成 500。
导入
import "github.com/cloudwego/hertz/pkg/app/middlewares/server/recovery"
示例代码
package main
import (
"context"
"fmt"
"net/http"
"time"
"github.com/cloudwego/hertz/pkg/app"
"github.com/cloudwego/hertz/pkg/app/server"
)
func main() {
h := server.Default(server.WithHostPorts(":8080"))
h.GET("/test", func(ctx context.Context, c *app.RequestContext) {
panic("test")
c.String(http.StatusOK, "test interface")
})
h.Spin()
}
配置
Recovery 中间件提供了默认的 panic 处理函数 defaultRecoveryHandler()
。
同时你也可以通过 WithRecoveryHandler()
函数来自定义出现 panic 后的处理函数,函数签名如下:
func WithRecoveryHandler(f func(ctx context.Context, c *app.RequestContext, err interface{}, stack []byte))
如果你在发生 panic 之后希望能够获取客户端信息,示例代码如下:
package main
import (
"context"
"fmt"
"github.com/cloudwego/hertz/pkg/app/middlewares/server/recovery"
"github.com/cloudwego/hertz/pkg/common/hlog"
"github.com/cloudwego/hertz/pkg/protocol/consts"
"net/http"
"time"
"github.com/cloudwego/hertz/pkg/app"
"github.com/cloudwego/hertz/pkg/app/server"
)
func MyRecoveryHandler(ctx context.Context, c *app.RequestContext, err interface{}, stack []byte) {
hlog.SystemLogger().CtxErrorf(ctx, "[Recovery] err=%v\nstack=%s", err, stack)
hlog.SystemLogger().Infof("Client: %s", c.Request.Header.UserAgent())
c.AbortWithStatus(consts.StatusInternalServerError)
}
func main() {
h := server.New()
h.Use(recovery.Recovery(recovery.WithRecoveryHandler(MyRecoveryHandler)))
h.GET("/ping", func(ctx context.Context, c *app.RequestContext) {
panic("test")
c.String(http.StatusOK, "pong "+fmt.Sprint(time.Now().Unix()))
})
h.Spin()
}
最后修改
November 11, 2024
: chore: update project descriptions (#1166) (1716eba)