基本介绍

目前大多数的第三方WebServer库均没有默认对HTTP请求处理过程中产生的异常进行捕获,轻者错误产生后无法记录到日志造成排查错困难,重则异常造成进程直接崩溃,服务不可用。

当你选择goframe,你很幸运。裸奔谁都会,但作为一款企业级的基础开发框架,对严谨及安全性的要求大于性能,因此默认情况下,执行过程中产生的panic是有被Server自动捕获的,产生panic时当前执行流程会立即中止,但是绝对不会影响进程直接崩溃。

获取异常错误

HTTP执行流程中产生panic异常时,默认处理是记录到Server的日志文件中。当然,开发者也可以通过注册中间件方式手动捕获,然后自定义相关的错误处理。这一操作其实在中间件章节的示例中也有介绍,我们这里来再仔细说明下。

开发者不能通过recover方法来捕获异常,因为goframe框架的Server已经做了捕获,并且为保证默认情况下异常不会引起进程崩溃,因此不会再次往上抛异常。

该方法往往使用在流程控制组件中,如后置中间件或者HOOK钩子方法中。

我们这里使用一个全局的后置中间件来捕获异常,当异常产生后,捕获并写入到指定的日志文件中,返回固定友好的提示信息,避免敏感的报错信息暴露给调用端。

需要注意的是:

  • 即使开发者有自己捕获记录异常错误的日志,但是Server依旧会打印到Server自己的错误日志文件中。由开发者调用日志接口方法输出的日志属于业务日志(与业务相关),而Server自行管理的日志属于服务日志(类似于nginxerror.log)。
  • 由于goframe框架大部分的底层错误都包含有错误时的堆栈信息,如果对于error的具体堆栈信息感兴趣(具体调用链、报错文件路径、源码行号等),可以使用gerror来获取,具体请参考 章节。如果异常包含堆栈信息,默认情况下会打印到Servererror日志文件中。
  1. package main
  2. import (
  3. "github.com/gogf/gf/v2/frame/g"
  4. "github.com/gogf/gf/v2/net/ghttp"
  5. )
  6. func MiddlewareErrorHandler(r *ghttp.Request) {
  7. r.Middleware.Next()
  8. if err := r.GetError(); err != nil {
  9. // 记录到自定义错误日志文件
  10. g.Log("exception").Error(err)
  11. //返回固定的友好信息
  12. r.Response.ClearBuffer()
  13. r.Response.Writeln("服务器居然开小差了,请稍后再试吧!")
  14. }
  15. func main() {
  16. s := g.Server()
  17. s.Use(MiddlewareErrorHandler)
  18. s.Group("/api.v2", func(group *ghttp.RouterGroup) {
  19. group.ALL("/user/list", func(r *ghttp.Request) {
  20. panic("db error: sql is xxxxxxx")
  21. })
  22. s.SetPort(8199)
  23. s.Run()
  24. }

获取异常堆栈

WebServer本身在捕获异常时,如果抛出的异常信息并不包含堆栈内容,那么WebServer会自动获取抛出异常位点(即panic的位置)的堆栈并创建一个新的包含该堆栈信息的错误对象。我们来看一个示例。

  1. package main
  2. import (
  3. "github.com/gogf/gf/v2/frame/g"
  4. "github.com/gogf/gf/v2/net/ghttp"
  5. )
  6. func MiddlewareErrorHandler(r *ghttp.Request) {
  7. r.Middleware.Next()
  8. if err := r.GetError(); err != nil {
  9. r.Response.ClearBuffer()
  10. r.Response.Writef("%+v", err)
  11. }
  12. }
  13. func main() {
  14. s := g.Server()
  15. s.Use(MiddlewareErrorHandler)
  16. s.Group("/api.v2", func(group *ghttp.RouterGroup) {
  17. group.ALL("/user/list", func(r *ghttp.Request) {
  18. panic("db error: sql is xxxxxxx")
  19. })
  20. })
  21. s.SetPort(8199)
  22. s.Run()
  23. }

可以看到,我们通过的格式化打印来获取异常错误中的堆栈信息,具体原理请参考章节:。执行后,我们通过curl工具来测试下:

如果抛出的异常是一个通过gerror组件的错误对象,或者实现堆栈打印接口的错误对象,由于该异常的错误对象已经包含了详细的堆栈信息,那么WebServer将会直接返回该错误对象,不会自动创建错误对象。我们来看一个示例。

  1. package main
  2. import (
  3. "github.com/gogf/gf/v2/errors/gerror"
  4. "github.com/gogf/gf/v2/net/ghttp"
  5. )
  6. func MiddlewareErrorHandler(r *ghttp.Request) {
  7. r.Middleware.Next()
  8. if err := r.GetError(); err != nil {
  9. r.Response.ClearBuffer()
  10. r.Response.Writef("%+v", err)
  11. }
  12. }
  13. func DbOperation() error {
  14. // ...
  15. return gerror.New("DbOperation error: sql is xxxxxxx")
  16. }
  17. func UpdateData() {
  18. err := DbOperation()
  19. if err != nil {
  20. panic(gerror.Wrap(err, "UpdateData error"))
  21. }
  22. }
  23. func main() {
  24. s := g.Server()
  25. s.Use(MiddlewareErrorHandler)
  26. s.Group("/api.v2", func(group *ghttp.RouterGroup) {
  27. group.ALL("/user/list", func(r *ghttp.Request) {
  28. UpdateData()
  29. })
  30. })
  31. s.SetPort(8199)
  32. s.Run()

执行后,我们通过curl工具来测试下: