Gin是一個用Golang編寫的HTTP網路框架。它的特點是類似於Martini的API,效能更好。在golang web開發領域是一個非常熱門的web框架。
啟動一個Gin web伺服器
使用下面的命令安裝Gin
go get -u github.com/gin-gonic/gin
在程式碼裡新增依賴
import "github.com/gin-gonic/gin"
快速啟動一個Gin伺服器的程式碼如下
package main
import "github.com/gin-gonic/gin"
func main() {
r := gin.Default()
r.GET("/ping", func(c *gin.Context) {
c.JSON(200, gin.H{
"message": "pong",
})
})
r.Run()
}
核心api gin.Default()返回一個Engine物件,呼叫Engine物件的Run方法會在本機8080埠啟動web伺服器。如果不想繫結8080埠或者8080埠已被佔用的話,可以給Run方法傳遞你要繫結的埠r.Run(":8081")。程式碼中的r.GET就是本文要講解核心內容:路由。
路由
Gin支援http方法: GET, POST, PUT, PATCH, DELETE,HEAD, OPTIONS。分別對應了不同的方法。
func main() {
router := gin.Default()
router.GET("/someGet", getting)
router.POST("/somePost", posting)
router.PUT("/somePut", putting)
router.DELETE("/someDelete", deleting)
router.PATCH("/somePatch", patching)
router.HEAD("/someHead", head)
router.OPTIONS("/someOptions", options)
router.Run()
}
這些路由方法的第一個引數設定相對地址,第二個方法是訪問該地址時執行的方法。在Gin中叫做handler。handler方法的原型如下。
type HandlerFunc func(*Context)
Gin還可以設定路由字首。例如有v1/login,v1/logout兩個地址可以使用Gin的Grouping routes功能設定路由字首。
func main() {
router := gin.Default()
v1 := router.Group("/v1")
{
v1.POST("/login", loginEndpoint)
v1.POST("/logout", logoutEndpoint)
}
router.Run()
}
獲取引數
func main() {
router := gin.Default()
router.GET("/user/:name", func(c *gin.Context) {
name := c.Param("name")
c.String(http.StatusOK, "Hello %s", name)
})
router.GET("/user/:name/*action", func(c *gin.Context) {
name := c.Param("name")
action := c.Param("action")
message := name + " is " + action
c.String(http.StatusOK, message)
})
router.GET("/welcome", func(c *gin.Context) {
firstname := c.DefaultQuery("firstname", "Guest")
lastname := c.Query("lastname")
c.String(http.StatusOK, "Hello %s %s", firstname, lastname)
})
router.POST("/form_post", func(c *gin.Context) {
message := c.PostForm("message")
nick := c.DefaultPostForm("nick", "anonymous")
c.JSON(200, gin.H{
"status": "posted",
"message": message,
"nick": nick,
})
})
router.Run(":8080")
}
可以看到獲取引數的方法可以分為路由引數、查詢字串和表單。
路由引數使用c.Param("name")取值。訪問/user/john時會呼叫/user/:name對應的handler,根據規則當訪問/user/或者/user並不會呼叫這個hanlder。
訪問/user/john/或者/user/john/send時會呼叫/user/:name/*action對應的handler。如果沒有對/user/john設定過路由的話,訪問/user/john會重定向到/user/john/。
使用DefaultQuery或者Query獲取查詢字串中的引數,DefaultQuery在沒有獲取到引數時可以設定一個預設值。在本例中訪問/welcome?firstname=Jane&lastname=Doe會呼叫/welcome對應的handler。
獲取表單引數Gin同樣也為我們提供了兩種方法PostForm和DefaultPostForm。和獲取查詢字串的方法一樣,DefaultPostForm也可以在沒有獲取到引數時設定一個預設值。
Gin的Api總體來說還是很直觀的,例如上文中沒有提到的c.JSON從命名就可以看出會輸出一段JSON。c.String直接輸出字串。http.StatusOK定義在http包中,這是一個值為200的常量。gin.H不太一樣,這是一個自定義的資料型別map[string]interface{}可以用於返回JSON。