[系列] - go-gin-api 路由中间件 - 捕获异常(四)

2019年9月10日 199点热度 0人点赞 0条评论

概述

首先同步下项目概况:

图片

上篇文章分享了,路由中间件 - 日志记录,这篇文章咱们分享:路由中间件 - 捕获异常。

当系统发生异常时,提示 “系统异常,请联系管理员!”,并发送 panic 告警邮件


图片

什么是异常?

在 Go 中异常就是 panic,它是在程序运行的时候抛出的,当 panic 抛出之后,如果在程序里没有添加任何保护措施的话,控制台就会在打印出 panic 的详细情况,然后终止运行。


我们可以将 panic 分为两种:

一种是有意抛出的,比如,

  1. panic("自定义的 panic 信息")

输出:

  1. 2019/09/10 20:25:27 http: panic serving [::1]:61547: 自定义的 panic 信息

  2. goroutine 8 [running]:

  3. ...

一种是无意抛出的,写程序马虎造成,比如,

  1. var slice = [] int {1, 2, 3, 4, 5}


  2. slice[6] = 6

输出:

  1. 2019/09/10 15:27:05 http: panic serving [::1]:61616: runtime error: index out of range

  2. goroutine 6 [running]:

  3. ...

想象一下,如果在线上环境出现了 panic,命令行输出的,因为咱们无法捕获就无法定位问题呀,想想都可怕,那么问题来了,怎么捕获异常?

怎么捕获异常?

当程序发生 panic 后,在 defer(延迟函数) 内部可以调用 recover 进行捕获。

不多说,直接上代码:

  1. defer func() {

  2. if err := recover(); err != nil {

  3. fmt.Println(err)

  4. }

  5. }()

在运行一下 “无意抛出的 panic ”,输出:

  1. runtime error: index out of range

OK,错误捕获到了,这时我们可以进行做文章了。

做啥文章,大家应该都知道了吧:

  • 获取运行时的调用栈(debug.Stack())

  • 获取当时的 Request 数据

  • 组装数据,进行发邮件

那么,Go 怎么发邮件呀,有没有开源包呀?

当然有,请往下看。

封装发邮件方法

使用包:gopkg.in/gomail.v2

直接上代码:

  1. func SendMail(mailTo string, subject string, body string) error {


  2. if config.ErrorNotifyOpen != 1 {

  3. return nil

  4. }


  5. m := gomail.NewMessage()


  6. //设置发件人

  7. m.SetHeader("From", config.SystemEmailUser)


  8. //设置发送给多个用户

  9. mailArrTo := strings.Split(mailTo, ",")

  10. m.SetHeader("To", mailArrTo...)


  11. //设置邮件主题

  12. m.SetHeader("Subject", subject)


  13. //设置邮件正文

  14. m.SetBody("text/html", body)


  15. d := gomail.NewDialer(config.SystemEmailHost, config.SystemEmailPort, config.SystemEmailUser, config.SystemEmailPass)


  16. err := d.DialAndSend(m)

  17. if err != nil {

  18. fmt.Println(err)

  19. }

  20. return err

  21. }

在这块我加了一个开关,想开想关,您随意。

现在会发送邮件了,再整个邮件模板就完美了。

自定义邮件模板

如图:

图片

这就是告警邮件的模板,还不错吧,大家还想记录什么,可以自定义去修改。

封装一个中间件

最后,封装一下。

直接上代码:

  1. func SetUp() gin.HandlerFunc {


  2. return func(c *gin.Context) {

  3. defer func() {

  4. if err := recover(); err != nil {


  5. DebugStack := ""

  6. for _, v := range strings.Split(string(debug.Stack()), "\n") {

  7. DebugStack += v + "<br>"

  8. }


  9. subject := fmt.Sprintf("【重要错误】%s 项目出错了!", config.AppName)


  10. body := strings.ReplaceAll(MailTemplate, "{ErrorMsg}", fmt.Sprintf("%s", err))

  11. body = strings.ReplaceAll(body, "{RequestTime}", util.GetCurrentDate())

  12. body = strings.ReplaceAll(body, "{RequestURL}", c.Request.Method + " " + c.Request.Host + c.Request.RequestURI)

  13. body = strings.ReplaceAll(body, "{RequestUA}", c.Request.UserAgent())

  14. body = strings.ReplaceAll(body, "{RequestIP}", c.ClientIP())

  15. body = strings.ReplaceAll(body, "{DebugStack}", DebugStack)


  16. _ = util.SendMail(config.ErrorNotifyUser, subject, body)


  17. utilGin := util.Gin{Ctx: c}

  18. utilGin.Response(500, "系统异常,请联系管理员!", nil)

  19. }

  20. }()

  21. c.Next()

  22. }

  23. }

当发生 panic 异常时,输出:

  1. {

  2. "code": 500,

  3. "msg": "系统异常,请联系管理员!",

  4. "data": null

  5. }

同时,还会收到一封 panic 告警邮件。

图片

便于截图,DebugStack 删减了一些信息。

到这,就结束了。

图片

备注

  • 发邮件的地方,可以调整为异步发送。

  • 文章中仅贴了部分代码,相关代码请查阅 github。

  • 测试发邮件时,一定要配置邮箱信息。

源码地址

https://github.com/xinliangnote/go-gin-api

go-gin-api 系列文章

图片

13100[系列] - go-gin-api 路由中间件 - 捕获异常(四)

root

这个人很懒,什么都没留下

文章评论