blackteay/gin
3
0
Fork 0
mirror of https://github.com/gin-gonic/gin.git synced 2025-10-18 14:52:18 +08:00
Code Issues Projects Releases Wiki Activity

Fix ShouldBindBodyWith method

Browse Source
This commit is contained in:
Shintaro Ikeda 2020-09-18 17:22:12 +09:00
parent 3100b7cb05
commit 5d5b60cf0a
3 changed files with 22 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1989,9 +1989,9 @@ func SomeHandler(c *gin.Context) {
} }
``` ```
* `c.ShouldBindBodyWith` stores body into the context before binding. This has * `c.ShouldBindBodyWith` stores body into the context before binding, and it
a slight impact to performance, so you should not use this method if you are does not consume the request body. This has a slight impact to performance,
enough to call binding at once. so you should not use this method if you are enough to call binding at once.
* This feature is only needed for some formats -- `JSON`, `XML`, `MsgPack`, * This feature is only needed for some formats -- `JSON`, `XML`, `MsgPack`,
`ProtoBuf`. For other formats, `Query`, `Form`, `FormPost`, `FormMultipart`, `ProtoBuf`. For other formats, `Query`, `Form`, `FormPost`, `FormMultipart`,
can be called by `c.ShouldBind()` multiple times without any damage to can be called by `c.ShouldBind()` multiple times without any damage to

5
context.go
View File

@ -5,6 +5,7 @@
package gin package gin
import ( import (
"bytes"
"errors" "errors"
"fmt" "fmt"
"io" "io"
@ -706,7 +707,7 @@ func (c *Context) ShouldBindWith(obj interface{}, b binding.Binding) error {
// ShouldBindBodyWith is similar with ShouldBindWith, but it stores the request // ShouldBindBodyWith is similar with ShouldBindWith, but it stores the request
// body into the context, and reuse when it is called again. // body into the context, and reuse when it is called again.
// //
// NOTE: This method reads the body before binding. So you should use // NOTE: This method copies the body before binding. So you should use
// ShouldBindWith for better performance if you need to call only once. // ShouldBindWith for better performance if you need to call only once.
func (c *Context) ShouldBindBodyWith(obj interface{}, bb binding.BindingBody) (err error) { func (c *Context) ShouldBindBodyWith(obj interface{}, bb binding.BindingBody) (err error) {
var body []byte var body []byte
@ -720,6 +721,8 @@ func (c *Context) ShouldBindBodyWith(obj interface{}, bb binding.BindingBody) (e
if err != nil { if err != nil {
return err return err
} }
c.Request.Body.Close()
c.Request.Body = ioutil.NopCloser(bytes.NewBuffer(body))
c.Set(BodyBytesKey, body) c.Set(BodyBytesKey, body)
} }
return bb.BindBody(body, obj) return bb.BindBody(body, obj)

15
context_test.go
View File

@ -1761,6 +1761,21 @@ func TestContextShouldBindBodyWith(t *testing.T) {
assert.NoError(t, c.ShouldBindBodyWith(&objB, tt.bindingB)) assert.NoError(t, c.ShouldBindBodyWith(&objB, tt.bindingB))
assert.Equal(t, typeB{"BAR"}, objB) assert.Equal(t, typeB{"BAR"}, objB)
} }
// not affect the request body
{
// After it binds, other bind methods can bind without EOF error.
w := httptest.NewRecorder()
c, _ := CreateTestContext(w)
c.Request, _ = http.NewRequest(
"POST", "http://example.com", bytes.NewBufferString(tt.bodyA),
)
objA := typeA{}
assert.NoError(t, c.ShouldBindBodyWith(&objA, tt.bindingA))
assert.Equal(t, typeA{"FOO"}, objA)
anotherOjbA := typeA{}
assert.NoError(t, c.ShouldBindWith(&anotherOjbA, tt.bindingA))
assert.Equal(t, typeA{"FOO"}, anotherOjbA)
}
} }
} }