• 欢迎来到本博客,希望可以y一起学习与分享

Gin参数验证shouldbind/Bind区别及多次绑定 request body

笔记 benz 1个月前 (05-14) 9次浏览 0个评论 扫描二维码
文章目录[隐藏]

模型绑定分类

gin 对模型绑定出错的处理分了两个大类

  • Bind*方法,以及MustBindWith方法 出错会将返回code置为400
  • ShouldBind* 方法,出错不会设置返回code,可以自己控制返回的code,一般来说,直接调 ShouldBind方法就行了,它会自动判断 Content-Type 选择相应的绑定

Must bind

包含的方法:Bind, BindJSON, BindXML, BindQuery等。

这些方法底层使用 MustBindWith,如果存在绑定错误,请求将被以下指令中止 c.AbortWithError(400, err).SetType(ErrorTypeBind),响应状态代码会被设置为400,请求头Content-Type被设置为text/plain; charset=utf-8。注意,如果你试图在此之后设置响应代码,将会发出一个警告 [GIN-debug] [WARNING] Headers were already written. Wanted to override status code 400 with 422,如果你希望更好地控制行为,请使用ShouldBind相关的方法。

Should bind

包含的方法:ShouldBind,ShouldBindJSON,ShoudBindXML,ShouldBindQuery,ShouldBIndYAML等。

这些方法底层使用 ShouldBindWith,如果存在绑定错误,则返回错误,开发人员可以正确处理请求和错误。

小结

当我们使用绑定方法时,Gin会根据Content-Type推断出使用哪种绑定器,如果你确定你绑定的是什么,你可以使用MustBindWith或者BindingWith

模型绑定方法总结

强制绑定

  • func (c *Context) MustBindWith(obj interface{}, b binding.Binding) error 通用的强制绑定方法,出错则置返回code为400,一般不直接用此方法
  • func (c *Context) Bind(obj interface{}) error 调用 MustBindWith 自动根据请求类型来判断绑定
  • func (c *Context) BindHeader(obj interface{}) error 调用 MustBindWith 绑定请求头,tag使用header
  • func (c *Context) BindJSON(obj interface{}) error 调用 MustBindWith 绑定json,tag使用json
  • func (c *Context) BindQuery(obj interface{}) error 调用 MustBindWith 绑定 Query Param,tag使用form
  • func (c *Context) BindUri(obj interface{}) error 调用 MustBindWith 绑定Path路径参数,tag使用uri
  • func (c *Context) BindXML(obj interface{}) error 调用 MustBindWith 绑定xml,tag使用xml
  • func (c *Context) BindYAML(obj interface{}) error 调用 MustBindWith 绑定yaml,tag使用yaml

非强制绑定

  • func (c *Context) ShouldBindWith(obj interface{}, b binding.Binding) error 通用的绑定方法
  • func (c *Context) ShouldBind(obj interface{}) error 调用 ShouldBindWith 自动根据请求类型判断绑定
  • 其余方法这里不列出,都是在上述方法基础上加 Should 并且都是调用 ShouldBindWith, 下面说两个不一样的

多次绑定 request body 数据

这里说一个需要注意的问题,如果是数据存储于 Body 里面的,gin是封装的标准库的http,而 Body 是io.ReadCloser 类型的,只能读取一次,之后就关闭,内容只允许读一次,也就是说,上述的 Bind 凡是读 Body 的,都不能再读第二次,这个可以用其他办法解决,这里暂且只说一个,那就是
func (c *Context) ShouldBindBodyWith(obj interface{}, bb binding.BindingBody) (err error) 方法,这个方法允许调用多次,因为它将内容暂时存在了 gin.Context 当中,比如绑定json如下代码所示:
ctx.ShouldBindBodyWith(&objA, binding.JSON)

还有个注意点就是,绑定的结构体,如果包含有子结构体,对于 form 传参来说,是不会有什么影响的,比如 a=1&b=2&c=3 , a b c 可以分别在不同的结构体中,可以是结构体指针也可以是结构体,具体可以参考 这里

这是官方文档的一个示例,一般情况第二次读取 request body 的数据就会出现 EOF 的错误,因为 c.Request.Body 不可以重用

gin 1.4 之后官方提供了一个 ShouldBindBodyWith 的方法,可以支持重复绑定,原理就是将 body 的数据缓存了下来,但是二次取数据的时候还是得用 ShouldBindBodyWith 才行,直接用 ShouldBind 还是会报错的。

ShouldBindBodyWith 源码分析

ShouldBindBodyWithShouldBindWith很像,但它保存了requestsBody到上下文,允许Body被继续调用。

注意:这个方法会先读取Body然后绑定,如果只绑定一次,建议使用ShouldBindWith来获得更好的性能(因为后者会直接读取并写到指定变量,而没有写入上下文)。

流程图

参考

GO语言web框架Gin之完全指南(一)
Go Web 小技巧(三)Gin 参数绑定


文章 Gin参数验证shouldbind/Bind区别及多次绑定 request body 转载需要注明出处
喜欢 (0)

您必须 登录 才能发表评论!