Gin 如何对请求参数模型绑定和验证

要将请求体 (request body) 绑定到结构体中,要使用 模型绑定

Gin 目前支持 JSONXMLYAMTOML 和标准表单 (application/x-www-url-encoded) 的绑定 (foo=bar&boo=baz)

Gin 框架使用 go-playground/validator/v10 进行验证。你可以点击 这里 查看所有的验证器以及它们的使用方法。

Gin 继承了对 go-playground/validator/v10 的使用,不过也做了一些小的变更,但原理都是一样的: 需要在要绑定的所有字段上,设置相应的 tag。例如,使用 JSON 绑定时,设置字段标签为 json:"fieldname"

Gin 框架提供了两类绑定方法:

  • 第一类: - 必须绑定 (Must Bind),BindXXX() 方法,如果绑定出错则会直接抛出 400 错误:

方法有: Bind(), BindJSON(), BindXML(), BindQuery(), BindYAML(), BindHeader(), BindTOML()

这些方法具体的实现调用了 `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` 等效方法

> 一句话总结:不要用我,不要用我,不要用我!!
  • 第一类: 应该绑定 (Should bind),ShouldXXX() 等方法,如果绑定出错则会抛出异常

  • 方法有: ShouldBind(), ShouldBindJSON(), ShouldBindXML(), ShouldBindQuery(), ShouldBindYAML(), ShouldBindHeader(), ShouldBindTOML(),

这些方法具体的实现调用了 ShouldBindWith()。 如果发生绑定错误,Gin 会返回错误并由开发者处理错误和请求。

一句话总结:用我,用我,用我

使用 BindXXX() 方法时,Gin 会尝试根据 Content-Type 推断如何绑定。 如果你明确知道要绑定的内容是什么格式,可以使用 MustBindWith() 或 ShouldBindWith()

你在绑定字段的时候也可以指定哪些字段是必须 required 的,通过设置 binding:"required" tag 实现。但是,但是,一个字段的 tag 加上了 binding:"required",一旦绑定时是空值,Gin 会报错。

package main

import (
    "net/http"

    "github.com/gin-gonic/gin"
)

// 绑定 JSON
type Login struct {
    User     string `form:"user" json:"user" xml:"user"  binding:"required"`
    Password string `form:"password" json:"password" xml:"password" binding:"required"`
}

func main() {
    router := gin.Default()

    // Example for binding JSON ({"user": "manu", "password": "123"})
    router.POST("/loginJSON", func(c *gin.Context) {
        var json Login
        if err := c.ShouldBindJSON(&json); err != nil {
            c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
            return
        }

        if json.User != "manu" || json.Password != "123" {
            c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
            return
        }

        c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
    })

    // 绑定 XML (
    //  <?xml version="1.0" encoding="UTF-8"?>
    //  <root>
    //    <user>manu</user>
    //    <password>123</password>
    //  </root>)
    router.POST("/loginXML", func(c *gin.Context) {
        var xml Login
        if err := c.ShouldBindXML(&xml); err != nil {
            c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
            return
        }

        if xml.User != "manu" || xml.Password != "123" {
            c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
            return
        }

        c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
    })

    // 绑定 HTML 表单 (user=manu&password=123)
    router.POST("/loginForm", func(c *gin.Context) {
        var form Login
        // 根据 Content-Type Header 自动判断使用那种绑定器。
        if err := c.ShouldBind(&form); err != nil {
            c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
            return
        }

        if form.User != "manu" || form.Password != "123" {
            c.JSON(http.StatusUnauthorized, gin.H{"status": "unauthorized"})
            return
        }

        c.JSON(http.StatusOK, gin.H{"status": "you are logged in"})
    })

    // 在 0.0.0.0:8080 端口上监听并启动服务
    router.Run(":8080")
}

Gin 服务运行后,使用下面的 cURL 命令来测试:

curl -v -X POST \
  http://localhost:8080/loginJSON \
  -H 'content-type: application/json' \
  -d '{ "user": "manu" }'

输出结果一般为

> POST /loginJSON HTTP/1.1
> Host: localhost:8080
> User-Agent: curl/7.51.0
> Accept: */*
> content-type: application/json
> Content-Length: 18
>
* upload completely sent off: 18 out of 18 bytes
< HTTP/1.1 400 Bad Request
< Content-Type: application/json; charset=utf-8
< Date: Fri, 04 Aug 2017 03:51:31 GMT
< Content-Length: 100
<
{"error":"Key: 'Login.Password' Error:Field validation for 'Password' failed on the 'required' tag"}

忽略验证

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

关于   |   FAQ   |   我们的愿景   |   广告投放   |  博客

  简单教程,简单编程 - IT 入门首选站

Copyright © 2013-2022 简单教程 twle.cn All Rights Reserved.