简介
本文接着上文(Golang GinWeb框架4-请求参数绑定和验证)继续探索GinWeb框架
只绑定查询字符串
使用SholdBindQuery方法只绑定查询参数, 而不会绑定post的数据. 请参考详情: Only Bind Query String(https://github.com/gin-gonic/gin/issues/742#issuecomment-315953017)
以下为示例代码与模拟测试请求:
- package main
- import (
- "log"
- "github.com/gin-gonic/gin"
- )
- type Person struct {
- Name string `form:"name"`
- Address string `form:"address"`
- }
- func main() {
- route := gin.Default()
- route.Any("/testing", startPage)
- route.Run(":8085")
- }
- func startPage(c *gin.Context) {
- var person Person
- // ShouldBindQuery is a shortcut for c.ShouldBindWith(obj, binding.Query)
- // ShouldBindQuery是c.ShouldBindWith(obj, binding.Query)方法的一个快捷绑定方法, 该方法只绑定请求字符串query string,而忽略Post提交的表单数据
- if c.ShouldBindQuery(&person) == nil {
- log.Println("====== Only Bind By Query String ======")
- log.Println(person.Name)
- log.Println(person.Address)
- }
- c.String(200, "Success")
- }
- //only bind query 模拟查询字符串请求
- //curl -X GET "localhost:8085/testing?name=eason&address=xyz"
- //only bind query string, ignore form data 模拟查询字符串请求和Post表单,这里的表单会被忽略
- //curl -X POST "localhost:8085/testing?name=eason&address=xyz" --data 'name=ignore&address=ignore' -H "Content-Type:application/x-www-form-urlencoded
绑定查询字符串或Post数据(表单)
详情请参考: https://github.com/gin-gonic/gin/issues/742#issuecomment-264681292
代码与请求示例:
- package main
- import (
- "log"
- "time"
- "github.com/gin-gonic/gin"
- )
- type Person struct {
- Name string `form:"name"`
- Address string `form:"address"`
- Birthday time.Time `form:"birthday" time_format:"2006-01-02" time_utc:"1"`
- CreateTime time.Time `form:"createTime" time_format:"unixNano"`
- UnixTime time.Time `form:"unixTime" time_format:"unix"`
- }
- func main() {
- route := gin.Default()
- //route.GET("/testing", startPage) //使用GET
- route.POST("/testing", startPage) //使用POST
- route.Run(":8085")
- }
- func startPage(c *gin.Context) {
- var person Person
- // If `GET`, only `Form` binding engine (`query`) used. 如果路由是GET方法,则只使用查询字符串引擎绑定
- // If `POST`, first checks the `content-type` for `JSON` or `XML`, then uses `Form` (`form-data`).
- // See more at https://github.com/gin-gonic/gin/blob/master/binding/binding.go#L48
- //如果是POST方式, ShouldBind方法检查请求类型头Content-Type来自动选择绑定引擎,比如Json/XML
- if c.ShouldBind(&person) == nil {
- log.Println(person.Name)
- log.Println(person.Address)
- log.Println(person.Birthday)
- log.Println(person.CreateTime)
- log.Println(person.UnixTime)
- }
- //if c.BindJSON(&person) == nil {
- // log.Println("====== Bind By JSON ======")
- // log.Println(person.Name)
- // log.Println(person.Address)
- //}
- c.String(200, "Success")
- }
- //模拟查询字符串参数请求:
- //curl -X GET "localhost:8085/testing?name=appleboy&address=xyz&birthday=1992-03-15&createTime=1562400033000000123&unixTime=1562400033"
- //模拟Post Json请求
- //curl -X POST localhost:8085/testing --data '{"name":"JJ", "address":"xyz"}' -H "Content-Type:application/json"
绑定URI
将结构体中标签指定的字段与URI中对应的字段进行绑定, 详情请参考: https://github.com/gin-gonic/gin/issues/846
代码与请求示例:
- package main
- import "github.com/gin-gonic/gin"
- type Person struct {
- ID string `uri:"id" binding:"required,uuid"` //指定URI标签
- Name string `uri:"name" binding:"required"`
- }
- func main() {
- route := gin.Default()
- //下面的URI中的name和id与Person结构中的标签分别对应
- route.GET("/:name/:id", func(c *gin.Context) {
- var person Person
- if err := c.ShouldBindUri(&person); err != nil {
- c.JSON(400, gin.H{"msg": err})
- return
- }
- c.JSON(200, gin.H{"name": person.Name, "uuid": person.ID})
- })
- route.Run(":8088")
- }
- //模拟请求
- //curl -v localhost:8088/thinkerou/987fbc97-4bed-5078-9f07-9141ba07c9f3
- //curl -v localhost:8088/thinkerou/not-uuid
绑定请求头
将请求头中的信息与结构体绑定
- package main
- import (
- "fmt"
- "github.com/gin-gonic/gin"
- )
- type testHeader struct {
- Rate int `header:"Rate"` //结构中添加header标签
- Domain string `header:"Domain"`
- }
- func main() {
- r := gin.Default()
- r.GET("/", func(c *gin.Context) {
- h := testHeader{}
- //ShouldBindHeader是c.ShouldBindWith(obj, binding.Header)的快捷方法
- if err := c.ShouldBindHeader(&h); err != nil {
- c.JSON(200, err)
- }
- fmt.Printf("%#v\n", h)
- c.JSON(200, gin.H{"Rate": h.Rate, "Domain": h.Domain})
- })
- r.Run()
- }
- //模拟请求
- // curl -H "rate:300" -H "domain:music" http://localhost:8080/
- // 参考输出:
- // {"Domain":"music","Rate":300}
绑定HTML复选框
详情请参考:https://github.com/gin-gonic/gin/issues/129#issuecomment-124260092,
将html与main.go放到一个目录,执行go run main.go运行后, 访问http://localhost:8080,勾选复选框,然后提交测试
main.go
- package main
- import (
- "github.com/gin-gonic/gin"
- )
- type myForm struct {
- Colors []string `form:"colors[]"` //标签中的colors[]数组切片与html文件中的name="colors[]"对应
- }
- func main() {
- r := gin.Default()
- //LoadHTMLGlob采用通配符模式匹配HTML文件,并将内容进行渲染,提供给前端访问
- r.LoadHTMLGlob("*.html")
- r.GET("/", indexHandler)
- r.POST("/", formHandler)
- r.Run(":8080")
- }
- func indexHandler(c *gin.Context) {
- c.HTML(200, "form.html", nil)
- }
- func formHandler(c *gin.Context) {
- var fakeForm myForm
- c.Bind(&fakeForm) //Bind方法根据请求头类型Content-Type, 自动选择合适的绑定引擎,如Json/XML
- c.JSON(200, gin.H{"color": fakeForm.Colors})
- }
- //将html与main.go放到一个目录,执行go run main.go运行后, 访问http://localhost:8080,勾选复选框,然后提交测试
form.html
使用ShouldBind方法结合结构体标签, 以及mime/multipart包完成多部分类型表单数据multipart/form-data或URL编码类型表单application/x-www-form-urlencoded数据进行绑定:
表单数据类型请参考:https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4
- package main
- import (
- "github.com/gin-gonic/gin"
- "mime/multipart"
- "net/http"
- )
- type ProfileForm struct {
- Name string `form:"name" binding:"required"`
- Avatar *multipart.FileHeader `form:"avatar" binding:"required"`
- // or for multiple files
- // Avatars []*multipart.FileHeader `form:"avatar" binding:"required"`
- }
- func main() {
- router := gin.Default()
- router.POST("/profile", func(c *gin.Context) {
- // you can bind multipart form with explicit binding declaration: 可以使用显示申明的方式,即用ShouldBindWith(&from, binding.Form)方法来绑定多部分类型表单multipart form
- // c.ShouldBindWith(&form, binding.Form)
- // or you can simply use autobinding with ShouldBind method:
- var form ProfileForm
- // in this case proper binding will be automatically selected
- // 这里使用ShouldBind方法自动选择绑定器进行绑定
- 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
- }
- // db.Save(&form)
- c.String(http.StatusOK, "ok")
- })
- router.Run(":8080")
- }
- //模拟测试:
- //curl -X POST -v --form name=user --form "avatar=@./avatar.png" http://localhost:8080/profile
参考文档
Gin官方仓库:https://github.com/gin-gonic/gin