Merge pull request #24 from devfeel/develop

feature: mapper ignore tag processor

Author: shyandsy

.gitignore

@@ -0,0 +1 @@
+.idea/

README.md

@@ -11,7 +11,7 @@ go get -u github.com/devfeel/mapper
 ## 2. Getting Started
 
 Traditional Usage
-```go
+``` go
 package main
 
 import (
@@ -81,7 +81,7 @@ userMap: &{map 10 x1asd 100 2017-11-20 13:45:56.3972504 +0800 CST m=+0.006004001
 
 Object Usage
 
-```go
+``` go
 package main
 
 import (
@@ -91,41 +91,50 @@ import (
 
 type (
   User struct {
-    Name     string `json:"name" mapper:"name"`
-    Age      int    `json:"age" mapper:"age"`
+    Name  string `json:"name" mapper:"name"`
+    Class int    `mapper:"class"`
+    Age   int    `json:"age" mapper:"-"`
   }
 
   Student struct {
     Name  string `json:"name" mapper:"name"`
-    Age   int    `json:"age" mapper:"-"`
+    Class int    `mapper:"class"`
+    Age   []int  `json:"age" mapper:"-"`
   }
 )
 
 func main() {
-  user := &User{Name: "test", Age: 10}
+  user := &User{Name: "shyandsy", Class: 1, Age: 10}
   student := &Student{}
 
   // create mapper object
   m := mapper.NewMapper()
 
-  // enable the type checking
-  m.SetEnabledTypeChecking(true)
+  // in the version < v0.7.8, we will use field name as key when mapping structs
+  // we keep it as default behavior in this version
+  m.SetEnableIgnoreFieldTag(true)
 
-  student.Age = 1
+  student.Age = []int{1}
 
   // disable the json tag
   m.SetEnabledJsonTag(false)
 
   // student::age should be 1
   m.Mapper(user, student)
 
+  fmt.Println("user:")
+  fmt.Println(user)
+  fmt.Println("student:")
   fmt.Println(student)
 }
 ```
 
 执行main，输出：
 ```
-&{test 1}
+user:
+&{shyandsy 1 10}
+student:
+&{shyandsy 1 [1]}
 ```
 
 

constant.go

@@ -1,7 +1,7 @@
 package mapper
 
 const (
-	packageVersion = "0.7.8"
+	packageVersion = "0.7.9"
 	mapperTagKey   = "mapper"
 	jsonTagKey     = "json"
 	IgnoreTagValue = "-"

example/ignoretag/main.go

@@ -0,0 +1,43 @@
+package main
+
+import (
+	"fmt"
+	"github.com/devfeel/mapper"
+)
+
+type (
+	User struct {
+		Name  string `json:"name" mapper:"name"`
+		Class int    `mapper:"class"`
+		Age   int    `json:"age" mapper:"-"`
+	}
+
+	Student struct {
+		Name  string `json:"name" mapper:"name"`
+		Class int    `mapper:"class"`
+		Age   int    `json:"age" mapper:"-"`
+	}
+)
+
+func main() {
+	user := &User{Name: "shyandsy", Class: 1, Age: 10}
+	student := &Student{}
+
+	// create mapper object
+	m := mapper.NewMapper()
+
+	// in the version < v0.7.8, we will use field name as key when mapping structs
+	// we keep it as default behavior in this version
+	m.SetEnableFieldIgnoreTag(true)
+
+	// disable the json tag
+	m.SetEnabledJsonTag(false)
+
+	// student::age should be 1
+	m.Mapper(user, student)
+
+	fmt.Println("user:")
+	fmt.Println(user)
+	fmt.Println("student:")
+	fmt.Println(student)
+}

example/object/main.go

@@ -7,33 +7,39 @@ import (
 
 type (
 	User struct {
-		Name     string `json:"name" mapper:"name"`
-		Age      int    `json:"age" mapper:"age"`
+		Name  string `json:"name" mapper:"name"`
+		Class int    `mapper:"class"`
+		Age   int    `json:"age" mapper:"-"`
 	}
 
 	Student struct {
 		Name  string `json:"name" mapper:"name"`
-		Age   int    `json:"age" mapper:"-"`
+		Class int    `mapper:"class"`
+		Age   []int  `json:"age" mapper:"-"`
 	}
 )
 
 func main() {
-	user := &User{Name: "test", Age: 10}
+	user := &User{Name: "shyandsy", Class: 1, Age: 10}
 	student := &Student{}
 
 	// create mapper object
 	m := mapper.NewMapper()
 
-	// enable the type checking
-	m.SetEnabledTypeChecking(true)
+	// in the version < v0.7.8, we will use field name as key when mapping structs
+	// we keep it as default behavior in this version
+	m.SetEnableFieldIgnoreTag(true)
 
-	student.Age = 1
+	student.Age = []int{1}
 
 	// disable the json tag
 	m.SetEnabledJsonTag(false)
 
 	// student::age should be 1
 	m.Mapper(user, student)
 
+	fmt.Println("user:")
+	fmt.Println(user)
+	fmt.Println("student:")
 	fmt.Println(student)
 }

mapper.go

@@ -42,6 +42,9 @@ type IMapper interface {
 
 	SetEnabledMapperStructField(isEnabled bool)
 	IsEnabledMapperStructField() bool
+
+	SetEnableFieldIgnoreTag(isEnabled bool)
+	IsEnableFieldIgnoreTag() bool
 }
 
 func init() {
@@ -100,6 +103,14 @@ func SetEnabledMapperStructField(isEnabled bool) {
 	standardMapper.SetEnabledMapperStructField(isEnabled)
 }
 
+// SetEnableFieldIgnoreTag set the enabled flag for the ignored tag
+// in the version < 0.7.8, we use field name as the key when mapping structs if field tag is "-"
+// from 0.7.8, we add switch enableFieldIgnoreTag which is false in default
+// if caller enable this flag, the field will be ignored in the mapping process
+func SetEnableFieldIgnoreTag(isEnabled bool) {
+	standardMapper.SetEnableFieldIgnoreTag(isEnabled)
+}
+
 // Register register struct to init Map
 func Register(obj interface{}) error {
 	return standardMapper.Register(obj)

mapper_object.go

@@ -21,6 +21,11 @@ type mapperObject struct {
 	enabledAutoTypeConvert   bool
 	enabledMapperTag         bool
 	enabledJsonTag           bool
+
+	// in the version < 0.7.8, we use field name as the key when mapping structs if field tag is "-"
+	// from 0.7.8, we add switch enableIgnoreFieldTag which is false in default
+	// if caller enable this flag, the field will be ignored in the mapping process
+	enableFieldIgnoreTag bool
 }
 
 func NewMapper() IMapper {
@@ -35,6 +40,7 @@ func NewMapper() IMapper {
 		enabledAutoTypeConvert:   true,
 		enabledMapperTag:         true,
 		enabledJsonTag:           true,
+		enableFieldIgnoreTag:     false, // 保留老版本默认行为：对于tag = “-”的字段使用FieldName
 	}
 	dm.useWrapper(dm.DefaultTimeWrapper)
 	return &dm
@@ -166,6 +172,18 @@ func (dm *mapperObject) IsEnabledMapperStructField() bool {
 	return dm.enabledMapperStructField
 }
 
+// SetEnableFieldIgnoreTag set the enabled flag for the ignored tag
+// in the version < 0.7.8, we use field name as the key when mapping structs if field tag is "-"
+// from 0.7.8, we add switch enableFieldIgnoreTag which is false in default
+// if caller enable this flag, the field will be ignored in the mapping process
+func (dm *mapperObject) SetEnableFieldIgnoreTag(isEnabled bool) {
+	dm.enableFieldIgnoreTag = isEnabled
+}
+
+func (dm *mapperObject) IsEnableFieldIgnoreTag() bool {
+	return dm.enableFieldIgnoreTag
+}
+
 // GetTypeName get type name
 func (dm *mapperObject) GetTypeName(obj interface{}) string {
 	object := reflect.ValueOf(obj)

mapper_object_internal.go

@@ -22,7 +22,11 @@ func (dm *mapperObject) registerValue(objValue reflect.Value) error {
 	typeName := regValue.Type().String()
 	if regValue.Type().Kind() == reflect.Struct {
 		for i := 0; i < regValue.NumField(); i++ {
-			mapFieldName := typeName + nameConnector + dm.getFieldName(regValue, i)
+			fieldName := dm.getFieldName(regValue, i)
+			if fieldName == IgnoreTagValue {
+				continue
+			}
+			mapFieldName := typeName + nameConnector + fieldName
 			realFieldName := regValue.Type().Field(i).Name
 			dm.fieldNameMap.Store(mapFieldName, realFieldName)
 		}
@@ -39,6 +43,12 @@ func (dm *mapperObject) getFieldName(objElem reflect.Value, index int) string {
 	fieldName := ""
 	field := objElem.Type().Field(index)
 	tag := dm.getStructTag(field)
+
+	// keeps the behavior in old version
+	if tag == IgnoreTagValue && !dm.IsEnableFieldIgnoreTag() {
+		tag = ""
+	}
+
 	if tag != "" {
 		fieldName = tag
 	} else {
@@ -81,6 +91,10 @@ func (dm *mapperObject) elemToStruct(fromElem, toElem reflect.Value) {
 	for i := 0; i < fromElem.NumField(); i++ {
 		fromFieldInfo := fromElem.Field(i)
 		fieldName := dm.getFieldName(fromElem, i)
+		if fieldName == IgnoreTagValue {
+			continue
+		}
+
 		// check field is exists
 		realFieldName, exists := dm.CheckExistsField(toElem, fieldName)
 		if !exists {
@@ -131,6 +145,9 @@ func (dm *mapperObject) elemToMap(fromElem, toElem reflect.Value) {
 	for i := 0; i < fromElem.NumField(); i++ {
 		fromFieldInfo := fromElem.Field(i)
 		fieldName := dm.getFieldName(fromElem, i)
+		if fieldName == IgnoreTagValue {
+			continue
+		}
 		toElem.SetMapIndex(reflect.ValueOf(fieldName), fromFieldInfo)
 	}
 }
@@ -257,28 +274,21 @@ func (dm *mapperObject) getStructTag(field reflect.StructField) string {
 	// 1.check mapperTagKey
 	if dm.enabledMapperTag {
 		tagValue = field.Tag.Get(mapperTagKey)
-		if dm.checkTagValidity(tagValue) {
+		if tagValue != "" {
 			return tagValue
 		}
 	}
 
 	// 2.check jsonTagKey
 	if dm.enabledJsonTag {
 		tagValue = field.Tag.Get(jsonTagKey)
-		if dm.checkTagValidity(tagValue) {
+		if tagValue != "" {
 			// support more tag property, as json tag omitempty 2018-07-13
 			return strings.Split(tagValue, ",")[0]
 		}
 	}
 
-	return ""
-}
-
-func (dm *mapperObject) checkTagValidity(tagValue string) bool {
-	if tagValue != "" && tagValue != IgnoreTagValue {
-		return true
-	}
-	return false
+	return tagValue
 }
 
 func (dm *mapperObject) checkIsRegister(objElem reflect.Value) bool {
@@ -287,7 +297,7 @@ func (dm *mapperObject) checkIsRegister(objElem reflect.Value) bool {
 	return isOk
 }
 
-// convert slice interface{} to []interface{}
+// convertToSlice convert slice interface{} to []interface{}
 func (dm *mapperObject) convertToSlice(arr interface{}) []interface{} {
 	v := reflect.ValueOf(arr)
 	if v.Kind() == reflect.Ptr {
@@ -308,7 +318,7 @@ func (dm *mapperObject) convertToSlice(arr interface{}) []interface{} {
 	return ret
 }
 
-// CheckIsTypeWrapper check value is in type wrappers
+// checkIsTypeWrapper check value is in type wrappers
 func (dm *mapperObject) checkIsTypeWrapper(value reflect.Value) bool {
 	for _, w := range dm.typeWrappers {
 		if w.IsType(value) {

version.md

@@ -1,5 +1,11 @@
 ## devfeel/mapper
 
+#### Version 0.7.9
+* Feature: add feature flag for ignore tag.
+* Tips: about "-" we keep default behavior as previous version by default, which is use field name as key when mapping structure.
+* Tips: now you can use SetEnableFieldIgnoreTag function to enable this flag right now
+* 2022-04-17 21:00 in ShangHai
+
 #### Version 0.7.8
 * Refactor: use mapperObject refactored the static version implementation.
 * 2022-04-16 10:00 in ShangHai