Gin框架系列03：換個姿勢理解中間件

什么是中間件

中間件，英譯middleware，顧名思義，放在中間的物件，那么放在誰中間呢？本來，客戶端可以直接請求到服務端介面，

現在，中間件橫插一腳，它能在請求到達介面之前攔截請求，做一些特殊處理，比如日志記錄，故障處理等，這就是今天要講述的中間件，那么，它在Gin框架中是怎么使用的呢？

如何使用中間件

我們來看一下逢gin必調的方法Default，方法中有一個變數engine，它Use了Logger和Recovery兩個函式，這兩個函式就是gin框架的日志和故障處理中間件，

func Default() *Engine {
	debugPrintWARNINGDefault()
	engine := New()
	engine.Use(Logger(), Recovery())
	return engine
}

那就很清楚了，使用中間件就是呼叫Use方法就行了唄，問題是現在除了這兩個中間件還能去Use誰？不如咱先自己寫一個中間件吧，這樣比較容易理解，

寫一個中間件

寫啥呢，做產品講究MVP，那咱就寫個最簡單的倍訓，攔截請求后輸出平也最帥的日志，產品就可以交付了，

寫之前先研究一下官方的Logger和Recovery是怎么寫的，好比葫蘆畫瓢，

func Logger() HandlerFunc {
	return LoggerWithConfig(LoggerConfig{})
}

func Recovery() HandlerFunc {
	return RecoveryWithWriter(DefaultErrorWriter)
}

原來這兩個函式都回傳了HandlerFunc型別，那我們也模仿寫一個函式就好了，

func PingYe() gin.HandlerFunc {
	return func(c *gin.Context) {
		c.String(200, "平也最帥")
	}
}

很簡單，寫完了，可以在main函式中Use它了，

func main() {
	r := gin.Default()
	r.Use(PingYe())
	r.Run()
}

把專案跑起來，訪問localhsot:8080看一下，帥呆了，成功渲染資料，

是不是太簡單了？這就交差了？我還能打十個啊！？

看來我要把畢生所學都交給你了，

延伸閱讀

Next

假如我們定義了兩個中間件，一個是平也最帥，另一個是在哪里最帥，

func PingYe() gin.HandlerFunc {
	return func(c *gin.Context) {
		c.String(200, "平也最帥")
	}
}

func Where() gin.HandlerFunc {
	return func(c *gin.Context) {
		c.String(200, "在全宇宙")
	}
}

按順序把它們分別注冊到框架當中，這個時候我們猜測它會先輸出平也最帥再輸出在全宇宙對吧？對，確實是的，

func main() {
	r := gin.Default()
	r.Use(PingYe(), Where())
	r.Run()
}

但是，如果我在不更改注冊順序的前提下，怎么調換一下順序，先輸出在全宇宙再輸出平也最帥呢？這就用到了大名鼎鼎的Next方法，它的作用就是先執行以下一個中間件，執行完了再回來繼續執行接下來的邏輯，記得是在中間件中呼叫哦~

func PingYe() gin.HandlerFunc {
  return func(c *gin.Context) {
    c.Next()
    c.String(200, "平也最帥")
  }
}

Abort

當然，除了提供Next方法外，理論上也應該有個中斷操作吧，畢竟拿中間件來做授權驗證的話，驗證失敗后還是希望阻斷請求的，所以，Abort就是我們要找的那個方法，拿上面的例子，在平也最帥的下一行呼叫Abort方法后，Where中間件就不再生效了，于是平也只剩下了單純的帥氣，

func PingYe() gin.HandlerFunc {
	return func(c *gin.Context) {
		c.String(200, "平也最帥")
		c.Abort()
	}
}

區域中間件

剛才我講的中間件是會在所有的路由上生效的，有些不需要添加中間件的路由場景就無法適應了，所以，我們需要有能為區域添加中間件的能力，

我們先實作給某個介面單獨加中間件，所以先得定義兩個介面know與unknown，分別代表認識平也與不認識兩個場景，鑒于認識后才知道平也是全宇宙最帥的，所以要綁中間件，不認識就算了，實作方式非常簡單，往路由后面的引數拼命加中間件就好了，

r.GET("know", PingYe(), Where())
r.GET("unknown", func(c *gin.Context) {
  c.String(200, "???")
})

除了針對某個介面添加中間件外，還可以針對一組介面添加，同樣呼叫Use方法即可，

v1 := r.Group("v1")
v1.Use(PingYe(), Where())
{
  v1.GET("/know", func(c *gin.Context) {
    c.String(200, "know")
  })
  v1.GET("/unknown", func(c *gin.Context) {
    c.String(200, "unknown")
  })
}

HTTP基本認證

基本認證，又稱BasicAuth，加了基本認證的介面，會讓你在訪問介面時提供用戶名與密碼，

對于瀏覽器用戶，為了用戶的體驗會自動彈出登錄框，而在其他場景下是沒有的，那在哪里輸入賬號密碼呢？實際上，它是通過頭資訊傳輸的，頭資訊里有一個固定的格式來代表基本認證，

Authorization: Basic <憑證>

憑證部分是是用戶名和密碼組合的base64編碼，兩者以冒號方式拼接，然鵝，gin框架的BaseAuth中間件早已準備好了一切，它可以短短幾行代碼就能決議基本認證的資訊，

func main() {
	r := gin.Default()
	r.Use(gin.BasicAuth(gin.Accounts{
		"pingye": "123",
	}))
	r.GET("/secrets", func(c *gin.Context) {
		user := c.MustGet(gin.AuthUserKey).(string)
		c.String(200, user+"已登錄成功")
	})
	r.Run()
}

示例中的部分代碼可能有些同學不太明白，比如BasicAuth方法中的引數，因為基本認證需要賬號和密碼對吧，所以我們可以利用gin.Accounts方便的配置好需要驗證的賬號密碼，gin.Accounts是一個map型別，鍵代表用戶名，值代表密碼，當然可以設定不止一個鍵值對，根據你的喜好自行設定，

代碼中還出現了c.MustGet方法，這個方法的作用就是一定要取到某個引數，取不到就不干了panic，取的是什么呢？就是gin.AuthUserKey，在官方中的解釋是基本認證中用戶憑證的cookie名稱，

// AuthUserKey is the cookie name for user credential in basic auth.
const AuthUserKey = "user"

Go語言庫示例開源專案「golang-examples」歡迎star~

https://github.com/pingyeaa/golang-examples

感謝大家的觀看，如果覺得文章對你有所幫助，歡迎關注公眾號「平也」，聚焦Go語言與技術原理，

標籤：Go

上一篇：Gin框架系列02：路由與引數

下一篇：go語言專案 - 客戶資訊關系系統