快捷導(dǎo)航

golang(gin)的全局統(tǒng)一異常處理方式,并統(tǒng)一返回json

更新時(shí)間：2024年01月16日 16:00:24 作者：劉海瓊寶寶

這篇文章主要介紹了golang(gin)的全局統(tǒng)一異常處理方式,并統(tǒng)一返回json,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

golang(gin)全局統(tǒng)一異常處理,并統(tǒng)一返回json

定義Recover中間件

package handler

import (
	"awesomeProject/Result"
	"github.com/gin-gonic/gin"
	"log"
	"net/http"
	"runtime/debug"
)

func Recover(c *gin.Context) {
	defer func() {
		if r := recover(); r != nil {
			//打印錯(cuò)誤堆棧信息
			log.Printf("panic: %v\n", r)
			debug.PrintStack()
			//封裝通用json返回
			//c.JSON(http.StatusOK, Result.Fail(errorToString(r)))
			//Result.Fail不是本例的重點(diǎn)，因此用下面代碼代替
			c.JSON(http.StatusOK, gin.H{
				"code": "1",
				"msg":  errorToString(r),
				"data": nil,
			})
			//終止后續(xù)接口調(diào)用，不加的話recover到異常后，還會(huì)繼續(xù)執(zhí)行接口里后續(xù)代碼
			c.Abort()
		}
	}()
	//加載完 defer recover，繼續(xù)后續(xù)接口調(diào)用
	c.Next()
}

// recover錯(cuò)誤，轉(zhuǎn)string
func errorToString(r interface{}) string {
	switch v := r.(type) {
	case error:
		return v.Error()
	default:
		return r.(string)
	}
}

使用Recover中間件

func main() {
	router := gin.Default()
	//注意 Recover 要盡量放在第一個(gè)被加載
	//如不是的話，在recover前的中間件或路由，將不能被攔截到
	//程序的原理是：
	//1.請(qǐng)求進(jìn)來(lái)，執(zhí)行recover
	//2.程序異常，拋出panic
	//3.panic被 recover捕獲，返回異常信息，并Abort,終止這次請(qǐng)求
	router.Use(handler.Recover)

	router.GET("/ping", func(c *gin.Context) {
		// 無(wú)意拋出 panic
		var slice = []int{1, 2, 3, 4, 5}
		slice[6] = 6
	})

	router.Run(":8080") // listen and serve on 0.0.0.0:8080 (for windows "localhost:8080")

}

golang中異常處理問(wèn)題

程序在運(yùn)行過(guò)程中如果出現(xiàn)了問(wèn)題，可以通過(guò)拋出異常、捕獲異常來(lái)進(jìn)行異常的處理，在golang中，異常的接口為error:

type error interface {
    Error() string
}

因此，只要一個(gè)結(jié)構(gòu)體實(shí)現(xiàn)了Error() string方法，就是實(shí)現(xiàn)了error接口：

type MyError struct {

}
func (err *MyError)Error() string{
    return "this is MyError"
}

golang中可以通過(guò)panic來(lái)拋出異常,recover來(lái)捕獲異常。如果不處理異常，最終會(huì)是程序整個(gè)退出

另外**捕獲異常必須在defer中進(jìn)行捕獲，否則捕獲異常recover不起作用**

type MyError struct {

}
func (err *MyError)Error() string{
    return "this is MyError"
}

func PanicError()  {
    fmt.Println("panic error")
    panic(MyError{})
}

func main() {
    defer func(){
        if err := recover() ; err != nil {

            fmt.Println("catch error ",err)
        }
    }()

    PanicError()
}

defer的機(jī)制，有點(diǎn)類似于java中的finall語(yǔ)句塊

go中多個(gè)defer語(yǔ)句與defer的順序相反執(zhí)行，可以理解是將defer放入到一個(gè)先進(jìn)后出的隊(duì)列中