Merge pull request #4173 from AllenX2018/fix-bug-queryRow

Fix issue 3866

pkg/infrastructure/bean/context.go

@@ -0,0 +1,20 @@
+// Copyright 2020
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package bean
+
+// ApplicationContext define for future
+// when we decide to support DI, IoC, this will be core API
+type ApplicationContext interface {
+}

pkg/infrastructure/bean/doc.go

@@ -0,0 +1,17 @@
+// Copyright 2020
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// bean is a basic package
+// it should not depend on other modules except common module, log module and config module
+package bean

pkg/infrastructure/bean/factory.go

@@ -0,0 +1,25 @@
+// Copyright 2020
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package bean
+
+import (
+	"context"
+)
+
+// AutoWireBeanFactory wire the bean based on ApplicationContext and context.Context
+type AutoWireBeanFactory interface {
+	// AutoWire will wire the bean.
+	AutoWire(ctx context.Context, appCtx ApplicationContext, bean interface{}) error
+}

pkg/infrastructure/bean/metadata.go

@@ -0,0 +1,28 @@
+// Copyright 2020
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package bean
+
+// BeanMetadata, in other words, bean's config.
+// it could be read from config file
+type BeanMetadata struct {
+	// Fields: field name => field metadata
+	Fields map[string]*FieldMetadata
+}
+
+// FieldMetadata contains metadata
+type FieldMetadata struct {
+	// default value in string format
+	DftValue string
+}

pkg/infrastructure/bean/tag_auto_wire_bean_factory.go

@@ -0,0 +1,231 @@
+// Copyright 2020
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package bean
+
+import (
+	"context"
+	"fmt"
+	"reflect"
+	"strconv"
+
+	"github.com/pkg/errors"
+
+	"github.com/astaxie/beego/pkg/infrastructure/logs"
+)
+
+const DefaultValueTagKey = "default"
+
+// TagAutoWireBeanFactory wire the bean based on Fields' tag
+// if field's value is "zero value", we will execute injection
+// see reflect.Value.IsZero()
+// If field's kind is one of(reflect.Chan, reflect.Func, reflect.Interface, reflect.Map, reflect.Slice
+// reflect.UnsafePointer, reflect.Array, reflect.Uintptr, reflect.Complex64, reflect.Complex128
+// reflect.Ptr, reflect.Struct),
+// it will be ignored
+type TagAutoWireBeanFactory struct {
+	// we allow user register their TypeAdapter
+	Adapters map[string]TypeAdapter
+
+	// FieldTagParser is an extension point which means that you can custom how to read field's metadata from tag
+	FieldTagParser func(field reflect.StructField) *FieldMetadata
+}
+
+// NewTagAutoWireBeanFactory create an instance of TagAutoWireBeanFactory
+// by default, we register Time adapter, the time will be parse by using layout "2006-01-02 15:04:05"
+// If you need more adapter, you can implement interface TypeAdapter
+func NewTagAutoWireBeanFactory() *TagAutoWireBeanFactory {
+	return &TagAutoWireBeanFactory{
+		Adapters: map[string]TypeAdapter{
+			"Time": &TimeTypeAdapter{Layout: "2006-01-02 15:04:05"},
+		},
+
+		FieldTagParser: func(field reflect.StructField) *FieldMetadata {
+			return &FieldMetadata{
+				DftValue: field.Tag.Get(DefaultValueTagKey),
+			}
+		},
+	}
+}
+
+// AutoWire use value from appCtx to wire the bean, or use default value, or do nothing
+func (t *TagAutoWireBeanFactory) AutoWire(ctx context.Context, appCtx ApplicationContext, bean interface{}) error {
+	if bean == nil {
+		return nil
+	}
+
+	v := reflect.Indirect(reflect.ValueOf(bean))
+
+	bm := t.getConfig(v)
+
+	// field name, field metadata
+	for fn, fm := range bm.Fields {
+
+		fValue := v.FieldByName(fn)
+		if len(fm.DftValue) == 0 || !t.needInject(fValue) || !fValue.CanSet() {
+			continue
+		}
+
+		// handle type adapter
+		typeName := fValue.Type().Name()
+		if adapter, ok := t.Adapters[typeName]; ok {
+			dftValue, err := adapter.DefaultValue(ctx, fm.DftValue)
+			if err == nil {
+				fValue.Set(reflect.ValueOf(dftValue))
+				continue
+			} else {
+				return err
+			}
+		}
+
+		switch fValue.Kind() {
+		case reflect.Bool:
+			if v, err := strconv.ParseBool(fm.DftValue); err != nil {
+				return errors.WithMessage(err,
+					fmt.Sprintf("can not convert the field[%s]'s default value[%s] to bool value",
+						fn, fm.DftValue))
+			} else {
+				fValue.SetBool(v)
+				continue
+			}
+		case reflect.Int:
+			if err := t.setIntXValue(fm.DftValue, 0, fn, fValue); err != nil {
+				return err
+			}
+			continue
+		case reflect.Int8:
+			if err := t.setIntXValue(fm.DftValue, 8, fn, fValue); err != nil {
+				return err
+			}
+			continue
+		case reflect.Int16:
+			if err := t.setIntXValue(fm.DftValue, 16, fn, fValue); err != nil {
+				return err
+			}
+			continue
+
+		case reflect.Int32:
+			if err := t.setIntXValue(fm.DftValue, 32, fn, fValue); err != nil {
+				return err
+			}
+			continue
+
+		case reflect.Int64:
+			if err := t.setIntXValue(fm.DftValue, 64, fn, fValue); err != nil {
+				return err
+			}
+			continue
+
+		case reflect.Uint:
+			if err := t.setUIntXValue(fm.DftValue, 0, fn, fValue); err != nil {
+				return err
+			}
+
+		case reflect.Uint8:
+			if err := t.setUIntXValue(fm.DftValue, 8, fn, fValue); err != nil {
+				return err
+			}
+			continue
+
+		case reflect.Uint16:
+			if err := t.setUIntXValue(fm.DftValue, 16, fn, fValue); err != nil {
+				return err
+			}
+			continue
+		case reflect.Uint32:
+			if err := t.setUIntXValue(fm.DftValue, 32, fn, fValue); err != nil {
+				return err
+			}
+			continue
+
+		case reflect.Uint64:
+			if err := t.setUIntXValue(fm.DftValue, 64, fn, fValue); err != nil {
+				return err
+			}
+			continue
+
+		case reflect.Float32:
+			if err := t.setFloatXValue(fm.DftValue, 32, fn, fValue); err != nil {
+				return err
+			}
+			continue
+		case reflect.Float64:
+			if err := t.setFloatXValue(fm.DftValue, 64, fn, fValue); err != nil {
+				return err
+			}
+			continue
+
+		case reflect.String:
+			fValue.SetString(fm.DftValue)
+			continue
+
+		// case reflect.Ptr:
+		// case reflect.Struct:
+		default:
+			logs.Warn("this field[%s] has default setting, but we don't support this type: %s",
+				fn, fValue.Kind().String())
+		}
+	}
+	return nil
+}
+
+func (t *TagAutoWireBeanFactory) setFloatXValue(dftValue string, bitSize int, fn string, fv reflect.Value) error {
+	if v, err := strconv.ParseFloat(dftValue, bitSize); err != nil {
+		return errors.WithMessage(err,
+			fmt.Sprintf("can not convert the field[%s]'s default value[%s] to float%d value",
+				fn, dftValue, bitSize))
+	} else {
+		fv.SetFloat(v)
+		return nil
+	}
+}
+
+func (t *TagAutoWireBeanFactory) setUIntXValue(dftValue string, bitSize int, fn string, fv reflect.Value) error {
+	if v, err := strconv.ParseUint(dftValue, 10, bitSize); err != nil {
+		return errors.WithMessage(err,
+			fmt.Sprintf("can not convert the field[%s]'s default value[%s] to uint%d value",
+				fn, dftValue, bitSize))
+	} else {
+		fv.SetUint(v)
+		return nil
+	}
+}
+
+func (t *TagAutoWireBeanFactory) setIntXValue(dftValue string, bitSize int, fn string, fv reflect.Value) error {
+	if v, err := strconv.ParseInt(dftValue, 10, bitSize); err != nil {
+		return errors.WithMessage(err,
+			fmt.Sprintf("can not convert the field[%s]'s default value[%s] to int%d value",
+				fn, dftValue, bitSize))
+	} else {
+		fv.SetInt(v)
+		return nil
+	}
+}
+
+func (t *TagAutoWireBeanFactory) needInject(fValue reflect.Value) bool {
+	return fValue.IsZero()
+}
+
+// getConfig never return nil
+func (t *TagAutoWireBeanFactory) getConfig(beanValue reflect.Value) *BeanMetadata {
+	fms := make(map[string]*FieldMetadata, beanValue.NumField())
+	for i := 0; i < beanValue.NumField(); i++ {
+		// f => StructField
+		f := beanValue.Type().Field(i)
+		fms[f.Name] = t.FieldTagParser(f)
+	}
+	return &BeanMetadata{
+		Fields: fms,
+	}
+}

pkg/infrastructure/bean/tag_auto_wire_bean_factory_test.go

@@ -0,0 +1,75 @@
+// Copyright 2020
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package bean
+
+import (
+	"context"
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestTagAutoWireBeanFactory_AutoWire(t *testing.T) {
+	factory := NewTagAutoWireBeanFactory()
+	bm := &ComplicateStruct{}
+	err := factory.AutoWire(context.Background(), nil, bm)
+	assert.Nil(t, err)
+	assert.Equal(t, 12, bm.IntValue)
+	assert.Equal(t, "hello, strValue", bm.StrValue)
+
+	assert.Equal(t, int8(8), bm.Int8Value)
+	assert.Equal(t, int16(16), bm.Int16Value)
+	assert.Equal(t, int32(32), bm.Int32Value)
+	assert.Equal(t, int64(64), bm.Int64Value)
+
+	assert.Equal(t, uint(13), bm.UintValue)
+	assert.Equal(t, uint8(88), bm.Uint8Value)
+	assert.Equal(t, uint16(1616), bm.Uint16Value)
+	assert.Equal(t, uint32(3232), bm.Uint32Value)
+	assert.Equal(t, uint64(6464), bm.Uint64Value)
+
+	assert.Equal(t, float32(32.32), bm.Float32Value)
+	assert.Equal(t, float64(64.64), bm.Float64Value)
+
+	assert.True(t, bm.BoolValue)
+	assert.Equal(t, 0, bm.ignoreInt)
+
+	assert.NotNil(t, bm.TimeValue)
+}
+
+type ComplicateStruct struct {
+	IntValue   int    `default:"12"`
+	StrValue   string `default:"hello, strValue"`
+	Int8Value  int8   `default:"8"`
+	Int16Value int16  `default:"16"`
+	Int32Value int32  `default:"32"`
+	Int64Value int64  `default:"64"`
+
+	UintValue   uint   `default:"13"`
+	Uint8Value  uint8  `default:"88"`
+	Uint16Value uint16 `default:"1616"`
+	Uint32Value uint32 `default:"3232"`
+	Uint64Value uint64 `default:"6464"`
+
+	Float32Value float32 `default:"32.32"`
+	Float64Value float64 `default:"64.64"`
+
+	BoolValue bool `default:"true"`
+
+	ignoreInt int `default:"11"`
+
+	TimeValue time.Time `default:"2018-02-03 12:13:14.000"`
+}

pkg/infrastructure/bean/time_type_adapter.go

@@ -0,0 +1,35 @@
+// Copyright 2020
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package bean
+
+import (
+	"context"
+	"time"
+)
+
+// TimeTypeAdapter process the time.Time
+type TimeTypeAdapter struct {
+	Layout string
+}
+
+// DefaultValue parse the DftValue to time.Time
+// and if the DftValue == now
+// time.Now() is returned
+func (t *TimeTypeAdapter) DefaultValue(ctx context.Context, dftValue string) (interface{}, error) {
+	if dftValue == "now" {
+		return time.Now(), nil
+	}
+	return time.Parse(t.Layout, dftValue)
+}

pkg/infrastructure/bean/time_type_adapter_test.go

@@ -0,0 +1,29 @@
+// Copyright 2020
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package bean
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestTimeTypeAdapter_DefaultValue(t *testing.T) {
+	typeAdapter := &TimeTypeAdapter{Layout: "2006-01-02 15:04:05"}
+	tm, err := typeAdapter.DefaultValue(context.Background(), "2018-02-03 12:34:11")
+	assert.Nil(t, err)
+	assert.NotNil(t, tm)
+}

pkg/infrastructure/bean/type_adapter.go

@@ -0,0 +1,26 @@
+// Copyright 2020
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package bean
+
+import (
+	"context"
+)
+
+// TypeAdapter is an abstraction that define some behavior of target type
+// usually, we don't use this to support basic type since golang has many restriction for basic types
+// This is an important extension point
+type TypeAdapter interface {
+	DefaultValue(ctx context.Context, dftValue string) (interface{}, error)
+}