官方文档地址(中文):https://gin-gonic.com/zh-cn/docs/
注:本教程采用工作区机制,所以一个项目下载了Gin框架,其余项目就无需重复下载,想了解的读者可阅读第一节:Gin操作指南:开山篇。
本节演示POST绑定,包括模型绑定和验证;Multipart-Urlencoded绑定;Multipart-Urlencoded表单;绑定HTML复选框;绑定 Uri。在开始之前,我们需要在02请求参数处理“目录下创建子目录:
mkdir 模型绑定和验证 Multipart-Urlencoded绑定 Multipart-Urlencoded表单
绑定HTML复选框 绑定 Uri
一、模型绑定和验证
要将请求体绑定到结构体中,使用模型绑定。 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 会报错。
package main
import (
"net/http" // 导入net/http包,用于HTTP状态码常量
"github.com/gin-gonic/gin" // 导入gin框架
)
// 绑定 JSON
type Login struct {
// User 字段,绑定来自表单、JSON、XML的值,并且为必填字段
User string `form:"user" json:"user" xml:"user" binding:"required"`
// Password 字段,绑定来自表单、JSON、XML的值,并且为必填字段
Password string `form:"password" json:"password" xml:"password" binding:"required"`
}
func main() {
// 创建一个默认的 Gin 路由器实例
router := gin.Default()
// 绑定 JSON ({"user": "manu", "password": "123"})
router.POST("/loginJSON", func(c *gin.Context) {
var json Login // 定义一个 Login 结构体变量用于存储绑定的数据
// 绑定请求体中的 JSON 数据到 json 变量
if err := c.ShouldBindJSON(&json); err != nil {
// 如果绑定失败,返回 HTTP 400 错误和错误信息
c.JSON(http.StatusBadRequest, gin.H{
"error": err.Error()})
return
}
// 检查用户输入的用户名和密码是否正确
if json.User != "manu" || json.Password != "123" {
// 如果用户名或密码不正确,返回 HTTP 401 未授权状态
c.JSON(http.StatusUnauthorized, gin.H{
"status": "unauthorized"})
return
}
// 如果登录成功,返回 HTTP 200 状态和登录成功信息
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 // 定义一个 Login 结构体变量用于存储绑定的数据
// 绑定请求体中的 XML 数据到 xml 变量
if err := c.ShouldBindXML(&xml); err != nil {
// 如果绑定失败,返回 HTTP 400 错误和错误信息
c.JSON(http