refactor(binding): 1/3 LoC removed & 1x perf increased

Author: xiaost

go.mod

@@ -10,7 +10,6 @@ require (
 	github.com/fsnotify/fsnotify v1.5.4
 	github.com/nyaruka/phonenumbers v1.0.55
 	github.com/stretchr/testify v1.8.1
-	github.com/tidwall/gjson v1.14.4
 	golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
 	golang.org/x/sys v0.24.0
 	google.golang.org/protobuf v1.27.1
@@ -28,8 +27,6 @@ require (
 	github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d // indirect
 	github.com/smartystreets/goconvey v1.6.4 // indirect
 	github.com/stretchr/objx v0.5.0 // indirect
-	github.com/tidwall/match v1.1.1 // indirect
-	github.com/tidwall/pretty v1.2.0 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
 	golang.org/x/arch v0.0.0-20210923205945-b76863e36670 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect

go.sum

@@ -46,15 +46,8 @@ github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
 github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
-github.com/tidwall/gjson v1.14.4 h1:uo0p8EbA09J7RQaflQ1aBRffTR7xedD2bcIVSYxLnkM=
-github.com/tidwall/gjson v1.14.4/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
-github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
-github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
-github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs=
-github.com/tidwall/pretty v1.2.0/go.mod h1:ITEVvHYasfjBbM0u2Pg8T2nJnzm8xPwvNhhsoaGGjNU=
 github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS4MhqMhdFk5YI=
 github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08=
-golang.org/x/arch v0.0.0-20201008161808-52c3e6f60cff/go.mod h1:flIaEI6LNU6xOCD5PaJvn9wGP0agmIOqjrtsKGRguv4=
 golang.org/x/arch v0.0.0-20210923205945-b76863e36670 h1:18EFjUmQOcUvxNYSkA6jO9VAiXCnxFY6NyDX0bHDmkU=
 golang.org/x/arch v0.0.0-20210923205945-b76863e36670/go.mod h1:5om86z9Hs0C8fWVUuoMHwpExlXzs5Tkyp9hOrfG7pp8=
 golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
@@ -84,4 +77,3 @@ gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 nullprogram.com/x/optparse v1.0.0/go.mod h1:KdyPE+Igbe0jQUrVfMqDMeJQIJZEuyV7pjYmp6pbG50=
-rsc.io/pdf v0.1.1/go.mod h1:n8OzWcQ6Sp37PL01nO98y4iUCRdTGarVfzxY20ICaU4=

pkg/app/server/binding/binder_test.go

@@ -468,7 +468,7 @@ func TestBind_RequiredBind(t *testing.T) {
 	req := newMockRequest().
 		SetRequestURI("http://foobar.com")
 	err := DefaultBinder().Bind(req.Req, &s, nil)
-	assert.DeepEqual(t, "'a' field is a 'required' parameter, but the request does not have this parameter", err.Error())
+	assert.DeepEqual(t, `decode field "A" err: field is required, but not set`, err.Error())
 
 	req = newMockRequest().
 		SetRequestURI("http://foobar.com").
@@ -617,9 +617,7 @@ func TestBind_JSON(t *testing.T) {
 		SetBody([]byte(fmt.Sprintf(`{"j1":"j1", "j2":12, "j3":[%d, %d], "j4":["%s", "%s"]}`, J3s[0], J3s[1], J4s[0], J4s[1])))
 	var result Req
 	err := DefaultBinder().Bind(req.Req, &result, nil)
-	if err != nil {
-		t.Error(err)
-	}
+	assert.Nil(t, err)
 	assert.DeepEqual(t, "j1", result.J1)
 	assert.DeepEqual(t, 13, result.J2)
 	for idx, val := range J3s {
@@ -931,9 +929,9 @@ func TestBind_JSONRequiredField(t *testing.T) {
 	var result Req
 	err := DefaultBinder().Bind(req.Req, &result, nil)
 	if err == nil {
-		t.Errorf("expected an error, but get nil")
+		t.Fatal("expected an error, but get nil")
 	}
-	assert.DeepEqual(t, "'c' field is a 'required' parameter, but the request body does not have this parameter 'n.n2.c'", err.Error())
+	assert.DeepEqual(t, `decode field "N" err: decode field "N2" err: decode field "C" err: JSON field "n.n2.c" is required, but it's not set`, err.Error())
 	assert.DeepEqual(t, 1, result.N.A)
 	assert.DeepEqual(t, 2, result.N.B)
 	assert.DeepEqual(t, 0, result.N.N2.C)
@@ -1259,18 +1257,14 @@ func TestBind_PointerStruct(t *testing.T) {
 		SetRequestURI(fmt.Sprintf("http://foobar.com?%s", query.Encode()))
 
 	err := binder.Bind(req.Req, &result, nil)
-	if err != nil {
-		t.Error(err)
-	}
+	assert.Nil(t, err)
 	assert.DeepEqual(t, "111", (**result.B1).F1)
 
 	result = Bar{}
 	req = newMockRequest().
 		SetRequestURI(fmt.Sprintf("http://foobar.com?%s&F1=222", query.Encode()))
 	err = binder.Bind(req.Req, &result, nil)
-	if err != nil {
-		t.Error(err)
-	}
+	assert.Nil(t, err)
 	assert.DeepEqual(t, "222", (**result.B1).F1)
 }
 
@@ -1522,7 +1516,7 @@ func Test_ValidatorErrorFactory(t *testing.T) {
 	if err == nil {
 		t.Fatalf("unexpected nil, expected an error")
 	}
-	assert.DeepEqual(t, "'a' field is a 'required' parameter, but the request does not have this parameter", err.Error())
+	assert.DeepEqual(t, `decode field "A" err: field is required, but not set`, err.Error())
 
 	type TestValidate struct {
 		B int `query:"b" vd:"$>100"`
@@ -1617,9 +1611,7 @@ func TestBind_JSONWithDefault(t *testing.T) {
 		SetJSONContentType().
 		SetBody([]byte(`{"j2":"j2"}`))
 	err = DefaultBinder().Bind(req.Req, &result, nil)
-	if err != nil {
-		t.Error(err)
-	}
+	assert.Nil(t, err)
 	assert.DeepEqual(t, "j1default", result.J1)
 }
 
@@ -1637,9 +1629,7 @@ func TestBind_WithoutPreBindForTag(t *testing.T) {
 	var result BaseQuery
 
 	err := DefaultBinder().BindQuery(req.Req, &result)
-	if err != nil {
-		t.Error(err)
-	}
+	assert.Nil(t, err)
 	assert.DeepEqual(t, "action", result.Action)
 	assert.DeepEqual(t, "version", result.Version)
 }
@@ -1686,9 +1676,10 @@ func Benchmark_Binding(b *testing.B) {
 	})
 
 	b.ResetTimer()
+	result := &Req{}
 	for i := 0; i < b.N; i++ {
-		var result Req
-		err := DefaultBinder().Bind(req.Req, &result, params)
+		*result = Req{}
+		err := DefaultBinder().Bind(req.Req, result, params)
 		if err != nil {
 			b.Error(err)
 		}

pkg/app/server/binding/config.go

@@ -66,7 +66,7 @@ type BindConfig struct {
 	// TypeUnmarshalFuncs registers customized type unmarshaler.
 	// NOTE:
 	// time.Time is registered by default
-	TypeUnmarshalFuncs map[reflect.Type]inDecoder.CustomizeDecodeFunc
+	TypeUnmarshalFuncs map[reflect.Type]inDecoder.CustomDecodeFunc
 	// Validator is used to validate for BindAndValidate()
 	Validator StructValidator
 }
@@ -78,13 +78,13 @@ func NewBindConfig() *BindConfig {
 		DisableStructFieldResolve:          false,
 		EnableDecoderUseNumber:             false,
 		EnableDecoderDisallowUnknownFields: false,
-		TypeUnmarshalFuncs:                 make(map[reflect.Type]inDecoder.CustomizeDecodeFunc),
+		TypeUnmarshalFuncs:                 make(map[reflect.Type]inDecoder.CustomDecodeFunc),
 		Validator:                          defaultValidate,
 	}
 }
 
 // RegTypeUnmarshal registers customized type unmarshaler.
-func (config *BindConfig) RegTypeUnmarshal(t reflect.Type, fn inDecoder.CustomizeDecodeFunc) error {
+func (config *BindConfig) RegTypeUnmarshal(t reflect.Type, fn inDecoder.CustomDecodeFunc) error {
 	// check
 	switch t.Kind() {
 	case reflect.String, reflect.Bool,
@@ -96,7 +96,7 @@ func (config *BindConfig) RegTypeUnmarshal(t reflect.Type, fn inDecoder.Customiz
 		return fmt.Errorf("registration type cannot be a pointer type")
 	}
 	if config.TypeUnmarshalFuncs == nil {
-		config.TypeUnmarshalFuncs = make(map[reflect.Type]inDecoder.CustomizeDecodeFunc)
+		config.TypeUnmarshalFuncs = make(map[reflect.Type]inDecoder.CustomDecodeFunc)
 	}
 	config.TypeUnmarshalFuncs[t] = fn
 	return nil

pkg/app/server/binding/default.go

@@ -94,6 +94,11 @@ type decoderInfo struct {
 	needValidate bool
 }
 
+func (d *decoderInfo) Decode(req *protocol.Request, params param.Params, rv reflect.Value) error {
+	_, err := d.decoder.Decode(req, params, rv)
+	return err
+}
+
 var defaultBind = NewDefaultBinder(nil)
 
 func DefaultBinder() Binder {
@@ -187,28 +192,29 @@ func (b *defaultBinder) bindTag(req *protocol.Request, v interface{}, params par
 	if ok {
 		// cached fieldDecoder, fast path
 		decoder := cached.(decoderInfo)
-		return decoder.decoder(req, params, rv.Elem())
+		return decoder.Decode(req, params, rv.Elem())
 	}
 	validateTag := defaultValidateTag
 	if len(b.config.Validator.ValidateTag()) != 0 {
 		validateTag = b.config.Validator.ValidateTag()
 	}
 	decodeConfig := &inDecoder.DecodeConfig{
-		LooseZeroMode:                      b.config.LooseZeroMode,
-		DisableDefaultTag:                  b.config.DisableDefaultTag,
-		DisableStructFieldResolve:          b.config.DisableStructFieldResolve,
-		EnableDecoderUseNumber:             b.config.EnableDecoderUseNumber,
-		EnableDecoderDisallowUnknownFields: b.config.EnableDecoderDisallowUnknownFields,
-		ValidateTag:                        validateTag,
-		TypeUnmarshalFuncs:                 b.config.TypeUnmarshalFuncs,
-	}
-	decoder, needValidate, err := inDecoder.GetReqDecoder(rv.Type(), tag, decodeConfig)
+		LooseZeroMode:             b.config.LooseZeroMode,
+		DisableDefaultTag:         b.config.DisableDefaultTag,
+		DisableStructFieldResolve: b.config.DisableStructFieldResolve,
+		TypeUnmarshalFuncs:        b.config.TypeUnmarshalFuncs,
+		DecodeTag:                 tag,
+	}
+	decoder, err := inDecoder.NewDecoder(rv.Type(), decodeConfig)
 	if err != nil {
 		return err
 	}
-
-	cache.Store(typeID, decoderInfo{decoder: decoder, needValidate: needValidate})
-	return decoder(req, params, rv.Elem())
+	cache.Store(typeID, decoderInfo{
+		decoder:      decoder,
+		needValidate: containsStructTag(rv.Type(), validateTag, nil),
+	})
+	_, err = decoder.Decode(req, params, rv.Elem())
+	return err
 }
 
 func (b *defaultBinder) bindTagWithValidate(req *protocol.Request, v interface{}, params param.Params, tag string) error {
@@ -230,7 +236,7 @@ func (b *defaultBinder) bindTagWithValidate(req *protocol.Request, v interface{}
 	if ok {
 		// cached fieldDecoder, fast path
 		decoder := cached.(decoderInfo)
-		err = decoder.decoder(req, params, rv.Elem())
+		err = decoder.Decode(req, params, rv.Elem())
 		if err != nil {
 			return err
 		}
@@ -244,21 +250,19 @@ func (b *defaultBinder) bindTagWithValidate(req *protocol.Request, v interface{}
 		validateTag = b.config.Validator.ValidateTag()
 	}
 	decodeConfig := &inDecoder.DecodeConfig{
-		LooseZeroMode:                      b.config.LooseZeroMode,
-		DisableDefaultTag:                  b.config.DisableDefaultTag,
-		DisableStructFieldResolve:          b.config.DisableStructFieldResolve,
-		EnableDecoderUseNumber:             b.config.EnableDecoderUseNumber,
-		EnableDecoderDisallowUnknownFields: b.config.EnableDecoderDisallowUnknownFields,
-		ValidateTag:                        validateTag,
-		TypeUnmarshalFuncs:                 b.config.TypeUnmarshalFuncs,
-	}
-	decoder, needValidate, err := inDecoder.GetReqDecoder(rv.Type(), tag, decodeConfig)
+		LooseZeroMode:             b.config.LooseZeroMode,
+		DisableDefaultTag:         b.config.DisableDefaultTag,
+		DisableStructFieldResolve: b.config.DisableStructFieldResolve,
+		TypeUnmarshalFuncs:        b.config.TypeUnmarshalFuncs,
+		DecodeTag:                 tag,
+	}
+	decoder, err := inDecoder.NewDecoder(rv.Type(), decodeConfig)
 	if err != nil {
 		return err
 	}
-
+	needValidate := containsStructTag(rv.Type(), validateTag, nil)
 	cache.Store(typeID, decoderInfo{decoder: decoder, needValidate: needValidate})
-	err = decoder(req, params, rv.Elem())
+	_, err = decoder.Decode(req, params, rv.Elem())
 	if err != nil {
 		return err
 	}