由于这个问题问得比较多,因此专门为大家撰写了这一章节。

基本介绍

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

吐槽:由于作者公司产品也有在用gin,某几次生产事故便因为开发者不严谨的代码panic造成进程崩溃退出。解决方案是所有相关项目必须手动创建recover中间件进行捕获。

当你选择gf,你很幸运。为保证严谨性,默认情况下,执行过程中产生的panic是有被Server自动捕获的,产生panic时当前执行流程会立即中止,但是绝对不会影响进程直接崩溃。

自定义异常处理

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

相关方法

异常的捕获我们通过Request对象中的GetError方法获取。

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

  1. // GetError returns the error occurs in the procedure of the request.
  2. // It returns nil if there's no error.
  3. func (r *Request) GetError() error

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

使用示例

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

需要注意的是:

  • 即使开发者有自己捕获记录异常错误的日志,但是Server依旧会打印到Server自己的错误日志文件中。由开发者调用日志接口方法输出的日志属于业务日志(与业务相关),而Server自行管理的日志属于服务日志(类似于nginxerror.log)。
  • 由于gf框架大部分的底层错误都包含有错误时的堆栈信息,如果对于error的具体堆栈信息感兴趣(具体调用链、报错文件路径、源码行号等),可以使用gerror来获取,具体请参考 错误处理-堆栈特性 章节。如果异常包含堆栈信息,默认情况下会打印到Servererror日志文件中。
  1. package main
  2. import (
  3. "github.com/gogf/gf/frame/g"
  4. "github.com/gogf/gf/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. }
  16. func main() {
  17. s := g.Server()
  18. s.Use(MiddlewareErrorHandler)
  19. s.Group("/api.v2", func(group *ghttp.RouterGroup) {
  20. group.ALL("/user/list", func(r *ghttp.Request) {
  21. panic("db error: sql is xxxxxxx")
  22. })
  23. })
  24. s.SetPort(8199)
  25. s.Run()
  26. }

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

  1. $ curl -v "http://127.0.0.1:8199/api.v2/user/list"
  2. > GET /api.v2/user/list HTTP/1.1
  3. > Host: 127.0.0.1:8199
  4. > User-Agent: curl/7.61.1
  5. > Accept: */*
  6. >
  7. < HTTP/1.1 500 Internal Server Error
  8. < Server: GF HTTP Server
  9. < Date: Sun, 19 Jul 2020 07:44:30 GMT
  10. < Content-Length: 52
  11. < Content-Type: text/plain; charset=utf-8
  12. <
  13. 服务器居然开小差了,请稍后再试吧!