概述
很多讀者在后臺向我要 Gin 框架實戰系列的 Demo 原始碼，在這里再說明一下，原始碼我都更新到 GitHub 上，地址：https://github.com/xinliangnote/Go
開始今天的文章，為什么要自定義錯誤處理？默認的錯誤處理方式是什么？
那好，咱們就先說下默認的錯誤處理，
默認的錯誤處理是 errors.New("錯誤資訊")，這個資訊通過 error 型別的回傳值進行回傳，
舉個簡單的例子：
func hello(name string) (str string, err error) {
if name == "" {
err = errors.New("name 不能為空")
return
}
str = fmt.Sprintf("hello: %s", name)
return
}
當呼叫這個方法時：
var name = ""
str, err := hello(name)
if err != nil {
fmt.Println(err.Error())
return
}
這就是默認的錯誤處理，下面還會用這個例子進行說，
這個默認的錯誤處理，只是得到了一個錯誤資訊的字串，
然而...
我還想得到發生錯誤時的 時間、 檔案名、 方法名、 行號 等資訊，
我還想得到錯誤時進行告警，比如 短信告警、 郵件告警、 微信告警 等，
我還想呼叫的時候，不那么復雜，就和默認錯誤處理類似，比如：
alarm.WeChat("錯誤資訊")
return
這樣，我們就得到了我們想要的資訊（ 時間、 檔案名、 方法名、 行號），并通過 微信 的方式進行告警通知我們，
同理， alarm.Email("錯誤資訊")、 alarm.Sms("錯誤資訊") 我們得到的資訊是一樣的，只是告警方式不同而已，
還要保證，我們業務邏輯中，獲取錯誤的時候，只獲取錯誤資訊即可，
上面這些想出來的，就是今天要實作的，自定義錯誤處理，我們就實作之前，先說下 Go 的錯誤處理，
錯誤處理
package main
import (
"errors"
"fmt"
)
func hello(name string) (str string, err error) {
if name == "" {
err = errors.New("name 不能為空")
return
}
str = fmt.Sprintf("hello: %s", name)
return
}
func main() {
var name = ""
fmt.Println("param:", name)
str, err := hello(name)
if err != nil {
fmt.Println(err.Error())
return
}
fmt.Println(str)
}
輸出：
param: Tom
hello: Tom
當 name = "" 時，輸出：
param:
name 不能為空
建議每個函式都要有錯誤處理，error 應該為最后一個回傳值，
咱們一起看下官方 errors.go
// Copyright 2011 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Package errors implements functions to manipulate errors.
package errors
// New returns an error that formats as the given text.
func New(text string) error {
return &errorString{text}
}
// errorString is a trivial implementation of error.
type errorString struct {
s string
}
func (e *errorString) Error() string {
return e.s
}
上面的代碼，并不復雜，參照上面的，咱們進行寫一個自定義錯誤處理，
自定義錯誤處理
咱們定義一個 alarm.go，用于處理告警，
廢話不多說，直接看代碼，
package alarm
import (
"encoding/json"
"fmt"
"ginDemo/common/function"
"path/filepath"
"runtime"
"strings"
)
type errorString struct {
s string
}
type errorInfo struct {
Time string `json:"time"`
Alarm string `json:"alarm"`
Message string `json:"message"`
Filename string `json:"filename"`
Line int `json:"line"`
Funcname string `json:"funcname"`
}
func (e *errorString) Error() string {
return e.s
}
func New (text string) error {
alarm("INFO", text)
return &errorString{text}
}
// 發郵件
func Email (text string) error {
alarm("EMAIL", text)
return &errorString{text}
}
// 發短信
func Sms (text string) error {
alarm("SMS", text)
return &errorString{text}
}
// 發微信
func WeChat (text string) error {
alarm("WX", text)
return &errorString{text}
}
// 告警方法
func alarm(level string, str string) {
// 當前時間
currentTime := function.GetTimeStr()
// 定義 檔案名、行號、方法名
fileName, line, functionName := "?", 0 , "?"
pc, fileName, line, ok := runtime.Caller(2)
if ok {
functionName = runtime.FuncForPC(pc).Name()
functionName = filepath.Ext(functionName)
functionName = strings.TrimPrefix(functionName, ".")
}
var msg = errorInfo {
Time : currentTime,
Alarm : level,
Message : str,
Filename : fileName,
Line : line,
Funcname : functionName,
}
jsons, errs := json.Marshal(msg)
if errs != nil {
fmt.Println("json marshal error:", errs)
}
errorJsonInfo := string(jsons)
fmt.Println(errorJsonInfo)
if level == "EMAIL" {
// 執行發郵件
} else if level == "SMS" {
// 執行發短信
} else if level == "WX" {
// 執行發微信
} else if level == "INFO" {
// 執行記日志
}
}
看下如何呼叫：
package v1
import (
"fmt"
"ginDemo/common/alarm"
"ginDemo/entity"
"github.com/gin-gonic/gin"
"net/http"
)
func AddProduct(c *gin.Context) {
// 獲取 Get 引數
name := c.Query("name")
var res = entity.Result{}
str, err := hello(name)
if err != nil {
res.SetCode(entity.CODE_ERROR)
res.SetMessage(err.Error())
c.JSON(http.StatusOK, res)
c.Abort()
return
}
res.SetCode(entity.CODE_SUCCESS)
res.SetMessage(str)
c.JSON(http.StatusOK, res)
}
func hello(name string) (str string, err error) {
if name == "" {
err = alarm.WeChat("name 不能為空")
return
}
str = fmt.Sprintf("hello: %s", name)
return
}
訪問：http://localhost:8080/v1/product/add?name=a
{
"code": 1,
"msg": "hello: a",
"data": null
}
未拋出錯誤，不會輸出資訊，
訪問：http://localhost:8080/v1/product/add
{
"code": -1,
"msg": "name 不能為空",
"data": null
}
拋出了錯誤，輸出資訊如下：
{"time":"2019-07-23 22:19:17","alarm":"WX","message":"name 不能為空","filename":"絕對路徑/ginDemo/router/v1/product.go","line":33,"funcname":"hello"}
可能這會有同學說：“用上一篇分享的資料系結和驗證，將傳入的引數進行 binding:"required" 也可以實作呀”，
我只能說：“同學呀，你不理解我的良苦用心，這只是個例子，大家可以在一些復雜的業務邏輯判斷場景中使用自定義錯誤處理”，
到這里，報錯時我們收到了 時間、 錯誤資訊、 檔案名、 行號、 方法名 了，
呼叫起來，也比較簡單，
雖然標記了告警方式，還是沒有進行告警通知呀，
我想說，在這里存盤資料到佇列中，再執行異步任務具體去消耗，這塊就不實作了，大家可以去完善，
讀取 檔案名、 方法名、 行號 使用的是 runtime.Caller()，
我們還知道，Go 有 panic 和 recover，它們是干什么的呢，接下來咱們就說說，
panic 和 recover
當程式不能繼續運行的時候，才應該使用 panic 拋出錯誤，
當程式發生 panic 后，在 defer(延遲函式) 內部可以呼叫 recover 進行控制，不過有個前提條件，只有在相同的 Go 協程中才可以，
panic 分兩個，一種是有意拋出的，一種是無意的寫程式馬虎造成的，咱們一個個說，
有意拋出的 panic：
package main
import (
"fmt"
)
func main() {
fmt.Println("-- 1 --")
defer func() {
if r := recover(); r != nil {
fmt.Printf("panic: %s\n", r)
}
fmt.Println("-- 2 --")
}()
panic("i am panic")
}
輸出：
-- 1 --
panic: i am panic
-- 2 --
無意拋出的 panic：
package main
import (
"fmt"
)
func main() {
fmt.Println("-- 1 --")
defer func() {
if r := recover(); r != nil {
fmt.Printf("panic: %s\n", r)
}
fmt.Println("-- 2 --")
}()
var slice = [] int {1, 2, 3, 4, 5}
slice[6] = 6
}
輸出：
-- 1 --
panic: runtime error: index out of range
-- 2 --
上面的兩個我們都通過 recover 捕獲到了，那我們如何在 Gin 框架中使用呢？如果收到 panic 時，也想進行告警怎么實作呢？
既然想實作告警，先在 ararm.go 中定義一個 Panic() 方法，當專案發生 panic 例外時，呼叫這個方法，這樣就實作告警了，
// Panic 例外
func Panic (text string) error {
alarm("PANIC", text)
return &errorString{text}
}
那我們怎么捕獲到呢？
使用中間件進行捕獲，寫一個 recover 中間件，
package recover
import (
"fmt"
"ginDemo/common/alarm"
"github.com/gin-gonic/gin"
)
func Recover() gin.HandlerFunc {
return func(c *gin.Context) {
defer func() {
if r := recover(); r != nil {
alarm.Panic(fmt.Sprintf("%s", r))
}
}()
c.Next()
}
}
路由呼叫中間件：
r.Use(logger.LoggerToFile(), recover.Recover())
//Use 可以傳遞多個中間件，
驗證下吧，咱們先拋出兩個例外，看看能否捕獲到？
還是修改 product.go 這個檔案吧，
有意拋出 panic：
package v1
import (
"fmt"
"ginDemo/entity"
"github.com/gin-gonic/gin"
"net/http"
)
func AddProduct(c *gin.Context) {
// 獲取 Get 引數
name := c.Query("name")
var res = entity.Result{}
str, err := hello(name)
if err != nil {
res.SetCode(entity.CODE_ERROR)
res.SetMessage(err.Error())
c.JSON(http.StatusOK, res)
c.Abort()
return
}
res.SetCode(entity.CODE_SUCCESS)
res.SetMessage(str)
c.JSON(http.StatusOK, res)
}
func hello(name string) (str string, err error) {
if name == "" {
// 有意拋出 panic
panic("i am panic")
return
}
str = fmt.Sprintf("hello: %s", name)
return
}
訪問：http://localhost:8080/v1/product/add
界面是空白的，
拋出了例外，輸出資訊如下：
{"time":"2019-07-23 22:42:37","alarm":"PANIC","message":"i am panic","filename":"絕對路徑/ginDemo/middleware/recover/recover.go","line":13,"funcname":"1"}
很顯然，定位的檔案名、方法名、行號不是我們想要的，
需要調整 runtime.Caller(2)，這個代碼在 alarm.go的alarm 方法中，
將 2 調整成 4 ，看下輸出資訊：
{"time":"2019-07-23 22:45:24","alarm":"PANIC","message":"i am panic","filename":"絕對路徑/ginDemo/router/v1/product.go","line":33,"funcname":"hello"}
這就對了，
無意拋出 panic：
// 上面代碼不變
func hello(name string) (str string, err error) {
if name == "" {
// 無意拋出 panic
var slice = [] int {1, 2, 3, 4, 5}
slice[6] = 6
return
}
str = fmt.Sprintf("hello: %s", name)
return
}
訪問：http://localhost:8080/v1/product/add
界面是空白的，
拋出了例外，輸出資訊如下：
{"time":"2019-07-23 22:50:06","alarm":"PANIC","message":"runtime error: index out of range","filename":"絕對路徑/runtime/panic.go","line":44,"funcname":"panicindex"}
很顯然，定位的檔案名、方法名、行號也不是我們想要的，
將 4 調整成 5 ，看下輸出資訊：
{"time":"2019-07-23 22:55:27","alarm":"PANIC","message":"runtime error: index out of range","filename":"絕對路徑/ginDemo/router/v1/product.go","line":34,"funcname":"hello"}
這就對了，
奇怪了，這是為什么？
在這里，有必要說下 runtime.Caller(skip) 了，
skip 指的呼叫的深度，
為 0 時，列印當前呼叫檔案及行數，
為 1 時，列印上級呼叫的檔案及行數，
依次類推...
在這塊，呼叫的時候需要注意下，我現在還沒有好的解決方案，
我是將 skip（呼叫深度），當一個引數傳遞進去，
比如：
// 發微信
func WeChat (text string) error {
alarm("WX", text, 2)
return &errorString{text}
}
// Panic 例外
func Panic (text string) error {
alarm("PANIC", text, 5)
return &errorString{text}
}
具體的代碼就不貼了，
但是，有意拋出 Panic 和 無意拋出 Panic 的呼叫深度又不同，怎么辦？
1、盡量將有意拋出的 Panic 改成拋出錯誤的方式，
2、想其他辦法搞定它，
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/114450.html
標籤：PHP