在前兩篇文章介紹路由的時候，我們了解到gin可用通過類似DefaultQuery或DefaultPostForm等方法擷取到前端送出過來的參數。參數不多的情況下也很好用，但是想想看，如果接口有很多個參數的時候再用這種方法就要調用很多次擷取參數的方法，本文将介紹一種新的接收參數的方法來解決這個問題：模型綁定。
gin中的模型綁定可以了解為：把請求的參數映射為一個具體的類型。gin支援JSON，XML，YAML和表單參數等多種參數格式，隻需要在對應的字段上聲明标簽。
綁定表單或者查詢字元串
type Person struct {
Name string `form:"name"`
Address string `form:"address"`
}
func startPage(c *gin.Context) {
var person Person
if c.ShouldBindQuery(&person) == nil {
log.Println(person.Name)
log.Println(person.Address)
}
c.String(200, "Success")
}
在結構體Name字段聲明form标簽，并調用ShouldBindQuery方法，gin會為我們綁定查詢字元串中的name和address兩個參數。注意雖然我們聲明了form标簽，ShouldBindQuery隻綁定查詢字元串中的參數。
如果你想綁定表單中的參數的話結構體不用改變，需要把ShouldBindQuery方更改為ShouldBind方法。ShouldBind方法會區分GET和POST請求，如果是GET請求綁定查詢字元串中的參數，如果是POST請求綁定表單參數中的内容，但是不能同時綁定兩種參數。
綁定json參數
type Person struct {
Name string `json:"name"`
Address string `json:"address"`
}
func startPage(c *gin.Context) {
var person Person
if c.ShouldBind(&person) == nil {
log.Println(person.Name)
log.Println(person.Address)
}
c.String(200, "Success")
}
json是一種常用的資料交換格式，尤其是在和web前端頁面互動的時候，似乎已經成為了一種事實标準。gin綁定json格式資料方法很簡單，隻需要設定字段的标簽為json并且調用ShouldBind方法。
其他類型參數綁定
路由參數在綁定時設定标簽為uri，并調用ShouldBindUri方法。
type Person struct {
Id string `uri:"id"`
}
func startPage(c *gin.Context) {
var person Person
if c.ShouldBindUri(&person) == nil {
log.Println(person.Id)
}
c.String(200, "Success")
}
綁定在HTTP Header中的參數，字段的标簽設定為header，調用方法為ShouldBindHeader。
還有不太常用的數組參數是字段标簽設定為form:"colors[]"，結構體例子如下：
type myForm struct {
Colors []string `form:"colors[]"`
}
檔案上傳這種場景我很少用模型綁定的方式擷取參數，在gin中對于這種場景也提供了模型綁定支援。
type ProfileForm struct {
Name string `form:"name"`
Avatar *multipart.FileHeader `form:"avatar"`
// Avatars []*multipart.FileHeader `form:"avatar"` 多檔案上傳
}
func main() {
router := gin.Default()
router.POST("/profile", func(c *gin.Context) {
var form ProfileForm
if err := c.ShouldBind(&form); err != nil {
c.String(http.StatusBadRequest, "bad request")
return
}
err := c.SaveUploadedFile(form.Avatar, form.Avatar.Filename)
if err != nil {
c.String(http.StatusInternalServerError, "unknown error")
return
}
c.String(http.StatusOK, "ok")
})
router.Run(":8080")
}
多種類型的模型綁定
如果我們有一個UpdateUser接口，PUT /user/:id，參數是{"nickname": "nickname...","mobile": "13322323232"}。代碼如下：
type ProfileForm struct {
Id int `uri:"id"`
Nickname string `json:"nickname"` // 昵稱
Mobile string `json:"mobile"` // 手機号
}
func main() {
router := gin.Default()
router.GET("/user/:id", func(c *gin.Context) {
var form ProfileForm
if err := c.ShouldBindUri(&form); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
if err := c.ShouldBindJSON(&form); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
c.String(http.StatusOK, "ok")
})
router.Run(":8080")
}
代碼裡調用了兩次bind方法才擷取到全部的參數。和gin社群溝通之後發現目前還不能調用一個方法同時綁定多個參數來源，目前gin版本為1.6.x，不知道未來會不會提供這種功能。
文章出處：基于gin的golang web開發：模型綁定