go-gin-api 路由中間件 - 捕獲例外

概述

首先同步下專案概況：


上篇文章分享了，路由中間件 - 日志記錄，這篇文章咱們分享：路由中間件 - 捕獲例外，

當系統發生例外時，提示 “系統例外，請聯系管理員！”，并發送 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()    
        }    
    }

這里我還準備了一分學習圖和資料，如下：

鏈接：https://pan.baidu.com/s/1v5gm7n0L7TGyejCmQrMh2g 提取碼：x2p5

免費分享，但是X度限制嚴重，如若鏈接失效點擊鏈接或搜索加群 群號518475424，

當發生 panic 例外時，輸出：

 

   {    
        "code": 500,    
        "msg": "系統例外，請聯系管理員！",    
        "data": null    
    }

同時，還會收到一封 panic 告警郵件，



便于截圖，DebugStack 刪減了一些資訊，

到這，就結束了，

備注

    發郵件的地方，可以調整為異步發送，

    文章中僅貼了部分代碼，相關代碼請查閱 github，

    測驗發郵件時，一定要配置郵箱資訊，

標籤：Go

上一篇：Dart語言學習(七)Dart Map型別

下一篇：交流啊