Golang Gin解析JSON请求数据避免出现EOF错误

 更新时间:2022年04月29日 08:33:27   作者:EvaCcino  
这篇文章主要为大家介绍了Golang Gin 优雅地解析JSON请求数据,避免ShouldBindBodyWith出现EOF错误的源码分析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

JSON是前后端交互的重要数据类型之一,使用Gin Web框架可以很方便地将HTTP请求报文中JSON格式的Body数据解析到结构体Struct或字典Map数据结构中。

环境

go version go1.14.3 windows/amd64
github.com/gin-gonic/gin v1.6.3

1. 结论

参考 Fix #216: Enable to call binding multiple times in some formats #1341

使用场景函数
单次绑定ShouldBindJSON > BindJSON
多次绑定ShouldBindBodyWith

ShouldBindJSON方法是最常用解析JSON数据的方法之一,但在重复调用的情况下会出现EOF的报错,这个原因出在ShouldBindJSON在调用过一次之后context.request.body.sawEOF的值是false导致,所以如果要多次绑定多个变量,需要使用ShouldBindBodyWith。

至于为什么单次绑定不优选使用BindJSON方法,主要因为BindJSON方法会强制抛出错误,影响正常流程。

以下为范例:

// 以下是用于存储JSON数据的结构体
type MsgJson struct {
	Msg string `json:"msg"`
}
// 单次绑定使用 ShouldBindJSON 方法
func bindExample(c *gin.Context) {
    // ---> 声明结构体变量
	var a MsgJson
	// ---> 绑定数据
	if err := c.ShouldBindJSON(&a); err != nil {
		c.AbortWithStatusJSON(
			http.StatusInternalServerError,
			gin.H{"error": err.Error()})
		return
	}
	// --> 返回
	c.JSON(http.StatusOK, gin.H{"msg": "ok"})
	return
}
// 多次绑定优先使用 ShouldBindBodyWith 方法
func bindWithRightWay(c *gin.Context) {
    // ---> 声明两个结构体变量用于存储JSON数据
	var a, b MsgJson
	// ---> 第一次解析(注意第二个参数是 binding.JSON)
	if err := c.ShouldBindBodyWith(&a, binding.JSON); err != nil {
		c.AbortWithStatusJSON(
			http.StatusInternalServerError,
			gin.H{"error": err.Error()})
		return
	}
	// ---> 第二次解析
	if err := c.ShouldBindBodyWith(&b, binding.JSON); err != nil {
		c.AbortWithStatusJSON(
			http.StatusInternalServerError,
			gin.H{"error": err.Error()})
		return
	}
	// ---> 返回
	c.JSON(http.StatusOK, gin.H{"msg": "ok"})
	return
}

2. EOF错误复现

EOF错误出现在第二次使用ShouldBindJSON方法,在多次绑定的情况下,优先使用ShouldBindBodyWith,以下为错误示范:

type MsgJson struct {
	Msg string `json:"msg"`
}
func main() {
	r := gin.Default()
	r.POST("/v2", bindWithError)
	_ = r.Run("127.0.0.1:9001")
}
func bindWithError(c *gin.Context) {
	var a, b MsgJson
	if err := c.ShouldBindJSON(&a); err != nil {....}
	// ---> 注意,这里会出现EOF报错
	if err := c.ShouldBindJSON(&b); err != nil {....}
    .......
	return
}

Postman测试结果:

Goland断点调试:

3. ShouldBindBodyWith 源码分析

ShouldBindBodyWith和ShouldBindWith很像,但它保存了requests的Body到上下文,允许Body被继续调用。

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

func (c *Context) ShouldBindBodyWith(obj interface{}, bb binding.BindingBody) (err error) {
	var body []byte
	// ---> 先看上下文是否已经有Body的Bytes数据
	if cb, ok := c.Get(BodyBytesKey); ok {
		if cbb, ok := cb.([]byte); ok {
			body = cbb
		}
	}
	// ---> 如果Body不为空的情况下,读取Body数据并写入上下文
	if body == nil {
		body, err = ioutil.ReadAll(c.Request.Body)
		if err != nil {
			return err
		}
		c.Set(BodyBytesKey, body)
	}
	return bb.BindBody(body, obj)
}

流程图

以上就是Golang Gin解析JSON请求数据避免出现EOF错误的详细内容,更多关于Golang Gin解析JSON请求数据的资料请关注脚本之家其它相关文章!

相关文章

  • Golang常用环境变量说明与设置详解

    Golang常用环境变量说明与设置详解

    这篇文章主要介绍了Golang常用环境变量说明与设置,需要的朋友可以参考下
    2020-02-02
  • 浅谈go 协程的使用陷阱

    浅谈go 协程的使用陷阱

    这篇文章主要介绍了浅谈go 协程的使用陷阱,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • 一文详解Go语言fmt标准库的常用占位符使用

    一文详解Go语言fmt标准库的常用占位符使用

    这篇文章主要为大家详细介绍了Go语言中fmt标准库的常用占位符及其简单使用,文中的示例代码讲解详细,对我们学习Go语言有一定的帮助,需要的可以参考一下
    2022-12-12
  • golang编程开发使用sort排序示例详解

    golang编程开发使用sort排序示例详解

    这篇文章主要为大家介绍了go语言编程开发使用sort来排序示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步早日升职加薪
    2021-11-11
  • Go语言之Goroutine与信道异常处理

    Go语言之Goroutine与信道异常处理

    这篇文章主要给大家介绍得是Go语言Goroutine与信道异常处理,Goroutine 之间通信是通过 channel 通信的,想详细了解得小伙伴跟小编一起来学习下面文章内容吧
    2021-10-10
  • Golang对struct字段重新排序优化数据结构性能实践

    Golang对struct字段重新排序优化数据结构性能实践

    这篇文章主要为大家介绍了Golang对struct字段重新排序优化数据结构性能实践,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-12-12
  • 一文带你深入了解Golang中的自旋锁

    一文带你深入了解Golang中的自旋锁

    自旋锁是一种忙等待锁,当一个线程尝试获取一个已经被其它线程持有的锁时,这个线程会持续循环检查锁的状态(即“自旋”) ,直到锁被释放后获得所有权,下面我们就来深入了解下自旋锁的具体操作吧
    2024-01-01
  • 详解go-admin在线开发平台学习(安装、配置、启动)

    详解go-admin在线开发平台学习(安装、配置、启动)

    这篇文章主要介绍了go-admin在线开发平台学习(安装、配置、启动),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-02-02
  • goland服务热重启的配置文件

    goland服务热重启的配置文件

    这篇文章主要介绍了goland服务热重启的配置文件,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-12-12
  • Go语言实现可选参数的方法小结

    Go语言实现可选参数的方法小结

    这篇文章主要为大家详细介绍了Go语言实现可选参数的一些常见方法,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-02-02

最新评论