概述
首先同步下項目概況:
上篇文章分享了,路由中間件 - 日志記錄,這篇文章咱們分享:路由中間件 - 捕獲異常。當系統發生異常時,提示 “系統異常,請聯系管理員!”,同時並發送 panic 告警郵件。
什么是異常?
在 Go 中異常就是 panic,它是在程序運行的時候拋出的,當 panic 拋出之后,如果在程序里沒有添加任何保護措施的話,控制台就會在打印出 panic 的詳細情況,然后終止運行。
我們可以將 panic 分為兩種:
一種是有意拋出的,比如,
panic("自定義的 panic 信息")
輸出:
2019/09/10 20:25:27 http: panic serving [::1]:61547: 自定義的 panic 信息
goroutine 8 [running]:
...
一種是無意拋出的,寫程序馬虎造成,比如,
var slice = [] int {1, 2, 3, 4, 5}
slice[6] = 6
輸出:
2019/09/10 15:27:05 http: panic serving [::1]:61616: runtime error: index out of range
goroutine 6 [running]:
...
想象一下,如果在線上環境出現了 panic,命令行輸出的,因為咱們無法捕獲就無法定位問題呀,想想都可怕,那么問題來了,怎么捕獲異常?
怎么捕獲異常?
當程序發生 panic 后,在 defer(延遲函數) 內部可以調用 recover 進行捕獲。
不多說,直接上代碼:
defer func() {
if err := recover(); err != nil {
fmt.Println(err)
}
}()
在運行一下 “無意拋出的 panic ”,輸出:
runtime error: index out of range
OK,錯誤捕獲到了,這時我們可以進行做文章了。
做啥文章,大家應該都知道了吧:
- 獲取運行時的調用棧(debug.Stack())
- 獲取當時的 Request 數據
- 組裝數據,進行發郵件
那么,Go 怎么發郵件呀,有沒有開源包呀?
當然有,請往下看。
封裝發郵件方法
使用包:gopkg.in/gomail.v2
直接上代碼:
func SendMail(mailTo string, subject string, body string) error {
if config.ErrorNotifyOpen != 1 {
return nil
}
m := gomail.NewMessage()
//設置發件人
m.SetHeader("From", config.SystemEmailUser)
//設置發送給多個用戶
mailArrTo := strings.Split(mailTo, ",")
m.SetHeader("To", mailArrTo...)
//設置郵件主題
m.SetHeader("Subject", subject)
//設置郵件正文
m.SetBody("text/html", body)
d := gomail.NewDialer(config.SystemEmailHost, config.SystemEmailPort, config.SystemEmailUser, config.SystemEmailPass)
err := d.DialAndSend(m)
if err != nil {
fmt.Println(err)
}
return err
}
在這塊我加了一個開關,想開想關,您隨意。
現在會發送郵件了,再整個郵件模板就完美了。
自定義郵件模板
如圖:
這就是告警郵件的模板,還不錯吧,大家還想記錄什么,可以自定義去修改。
封裝一個中間件
最后,封裝一下。
直接上代碼:
func SetUp() gin.HandlerFunc {
return func(c *gin.Context) {
defer func() {
if err := recover(); err != nil {
DebugStack := ""
for _, v := range strings.Split(string(debug.Stack()), "\n") {
DebugStack += v + "<br>"
}
subject := fmt.Sprintf("【重要錯誤】%s 項目出錯了!", config.AppName)
body := strings.ReplaceAll(MailTemplate, "{ErrorMsg}", fmt.Sprintf("%s", err))
body = strings.ReplaceAll(body, "{RequestTime}", util.GetCurrentDate())
body = strings.ReplaceAll(body, "{RequestURL}", c.Request.Method + " " + c.Request.Host + c.Request.RequestURI)
body = strings.ReplaceAll(body, "{RequestUA}", c.Request.UserAgent())
body = strings.ReplaceAll(body, "{RequestIP}", c.ClientIP())
body = strings.ReplaceAll(body, "{DebugStack}", DebugStack)
_ = util.SendMail(config.ErrorNotifyUser, subject, body)
utilGin := util.Gin{Ctx: c}
utilGin.Response(500, "系統異常,請聯系管理員!", nil)
}
}()
c.Next()
}
}
當發生 panic 異常時,輸出:
{
"code": 500,
"msg": "系統異常,請聯系管理員!",
"data": null
}
同時,還會收到一封 panic 告警郵件。
便於截圖,DebugStack 刪減了一些信息。
到這,就結束了。
備注
- 發郵件的地方,可以調整為異步發送。
- 文章中僅貼了部分代碼,相關代碼請查閱 github。
- 測試發郵件時,一定要配置郵箱信息。
源碼地址
https://github.com/xinliangnote/go-gin-api