Gin 模型绑定与验证 - Blume's Skylog

归档38

数据结构与算法11 云原生与运维8 后端开发8 编程语言7 前端开发4

539 字

3 分钟

Gin 模型绑定与验证

2025-09-02

编程语言

Gin

参数校验

使用时，需要在要绑定的所有字段上，设置相应的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 会报错。

如果结构体的某个字段本身也是一个结构体（嵌套结构体），为了正确验证，该结构体的字段也需要添加 binding:"required" 标签。

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
}
6

7
func main() {
8
  router := gin.Default()
9

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
    }
17

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

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

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
    }
38

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

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

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
    }
55

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

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

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