模型绑定和验证

要将请求体绑定到结构体中，使用模型绑定。 Gin目前支持JSON、XML、YAML和标准表单值的绑定（foo=bar＆boo=baz）。

Gin使用 go-playground/validator/v10 进行验证。 查看标签用法的全部文档.

使用时，需要在要绑定的所有字段上，设置相应的tag。 例如，使用 JSON 绑定时，设置字段标签为 json:"fieldname"。

Gin提供了两类绑定方法：

  • Type - Must bind
    • Methods - Bind, BindJSON, BindXML, BindQuery, BindYAML
    • Behavior - 这些方法属于 MustBindWith 的具体调用。 如果发生绑定错误，则请求终止，并触发 c.AbortWithError(400, err).SetType(ErrorTypeBind)。响应状态码被设置为 400 并且 Content-Type 被设置为 text/plain; charset=utf-8。 如果您在此之后尝试设置响应状态码，Gin会输出日志 [GIN-debug] [WARNING] Headers were already written. Wanted to override status code 400 with 422。 如果您希望更好地控制绑定，考虑使用 ShouldBind 等效方法。
  • Type - Should bind
    • Methods - ShouldBind, ShouldBindJSON, ShouldBindXML, ShouldBindQuery, ShouldBindYAML
    • Behavior - 这些方法属于 ShouldBindWith 的具体调用。 如果发生绑定错误，Gin 会返回错误并由开发者处理错误和请求。

使用 Bind 方法时，Gin 会尝试根据 Content-Type 推断如何绑定。 如果你明确知道要绑定什么，可以使用 MustBindWith 或 ShouldBindWith。

你也可以指定必须绑定的字段。 如果一个字段的 tag 加上了 binding:"required"，但绑定时是空值, Gin 会报错。

  1. // 绑定 JSON
  2. type Login struct {
  3.     User     string `form:"user" json:"user" xml:"user"  binding:"required"`
  4.     Password string `form:"password" json:"password" xml:"password" binding:"required"`
  5. }
  7. func main() {
  8.     router := gin.Default()
  10.     // 绑定 JSON ({"user": "manu", "password": "123"})
  11.     router.POST("/loginJSON", func(c *gin.Context) {
  12.         var json Login
  13.         if err := c.ShouldBindJSON(&json); err != nil {
  14.             c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  15.             return
  16.         }
  18.         if json.User != "manu" || json.Password != "123" {
  19.             c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
  20.             return
  21.         } 
  23.         c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
  24.     })
  26.     // 绑定 XML (
  27.     //    <?xml version="1.0" encoding="UTF-8"?>
  28.     //    <root>
  29.     //        <user>manu</user>
  30.     //        <password>123</password>
  31.     //    </root>)
  32.     router.POST("/loginXML", func(c *gin.Context) {
  33.         var xml Login
  34.         if err := c.ShouldBindXML(&xml); err != nil {
  35.             c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  36.             return
  37.         }
  39.         if xml.User != "manu" || xml.Password != "123" {
  40.             c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
  41.             return
  42.         } 
  44.         c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
  45.     })
  47.     // 绑定 HTML 表单 (user=manu&password=123)
  48.     router.POST("/loginForm", func(c *gin.Context) {
  49.         var form Login
  50.         // 根据 Content-Type Header 推断使用哪个绑定器。
  51.         if err := c.ShouldBind(&form); err != nil {
  52.             c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
  53.             return
  54.         }
  56.         if form.User != "manu" || form.Password != "123" {
  57.             c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
  58.             return
  59.         } 
  61.         c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
  62.     })
  64.     // 监听并在 0.0.0.0:8080 上启动服务
  65.     router.Run(":8080")
  66. }

示例请求

  1. $ curl -v -X POST \
  2.   http://localhost:8080/loginJSON \
  3.   -H 'content-type: application/json' \
  4.   -d '{ "user": "manu" }'
  5. > POST /loginJSON HTTP/1.1
  6. > Host: localhost:8080
  7. > User-Agent: curl/7.51.0
  8. > Accept: */*
  9. > content-type: application/json
  10. > Content-Length: 18
  11. >
  12. * upload completely sent off: 18 out of 18 bytes
  13. < HTTP/1.1 400 Bad Request
  14. < Content-Type: application/json; charset=utf-8
  15. < Date: Fri, 04 Aug 2017 03:51:31 GMT
  16. < Content-Length: 100
  17. <
  18. {"error":"Key: 'Login.Password' Error:Field validation for 'Password' failed on the 'required' tag"}

忽略验证

使用上述的 curl 命令运行上面的示例时会返回错误。 因为示例中 Password 使用了 binding:"required"。 如果 Password 使用 binding:"-"， 再次运行上面的示例就不会返回错误。

Last modified 19.05.2021 : chore: update example (81f837f)