增加Select和Omit方法，简化过滤操作

Author: liu-cn

filter/filter.go

@@ -8,7 +8,7 @@ func (f Filter) MarshalJSON() ([]byte, error) {
 	return f.node.Bytes()
 }
 
-//Deprecated
+// Deprecated
 func (f Filter) MastMarshalJSON() []byte {
 	return f.node.MustBytes()
 }
@@ -52,6 +52,16 @@ func SelectMarshal(selectScene string, el interface{}) Filter {
 	}
 }
 
+// Select 直接返回过滤后的数据结构，相当于直接SelectMarshal后再调用Interface方法
+func Select(selectScene string, el interface{}) interface{} {
+	return SelectMarshal(selectScene, el).Interface()
+}
+
+// Omit 直接返回过滤后的数据结构，相当于直接OmitMarshal后再调用Interface方法
+func Omit(omitScene string, el interface{}) interface{} {
+	return OmitMarshal(omitScene, el).Interface()
+}
+
 // OmitMarshal 第一个参数填你结构体omit标签里的场景，第二个参数是你需要过滤的结构体对象，如果字段的omit标签里标注的有该场景那么该字段会被过滤掉
 func OmitMarshal(omitScene string, el interface{}) Filter {
 	tree := &fieldNodeTree{

filter/filter_test.go

@@ -1,6 +1,7 @@
 package filter
 
 import (
+	"encoding/json"
 	"fmt"
 	"testing"
 	"time"
@@ -124,8 +125,8 @@ type Child struct {
 	CAge  int    `json:"c_age,select(all|struct)"`
 }
 type UsersCase struct {
-	Name   string `json:"name,select(all|1)"`
-	Age    int    `json:"age,select(all|2)"`
+	Name   string `json:"name,select(all|1),omit(1)"`
+	Age    int    `json:"age,select(all|2),omit(1)"`
 	Struct Child  `json:"struct,select(all|struct)"`
 }
 
@@ -390,6 +391,24 @@ func TestTestCases(t *testing.T) {
 		fmt.Println(filter.MustJSON())
 		//{"int":100,"int16":16,"int16_p":16,"int32":32,"int32_p":32,"int64":64,"int64_p":64,"int8":8,"int8_p":8,"int_p":100}
 	})
+	t.Run("intAllSelect", func(t *testing.T) {
+		filter := Select("intAll", NewTestCases())
+		marshal, err := json.Marshal(filter)
+		if err != nil {
+			t.Error("err", err)
+		}
+		fmt.Println(string(marshal))
+		//{"int":100,"int16":16,"int16_p":16,"int32":32,"int32_p":32,"int64":64,"int64_p":64,"int8":8,"int8_p":8,"int_p":100}
+	})
+	t.Run("intAllOmit", func(t *testing.T) {
+		filter := Omit("1", UsersCase{})
+		marshal, err := json.Marshal(filter)
+		if err != nil {
+			t.Error("err", err)
+		}
+		fmt.Println(string(marshal))
+		//{"int":100,"int16":16,"int16_p":16,"int32":32,"int32_p":32,"int64":64,"int64_p":64,"int8":8,"int8_p":8,"int_p":100}
+	})
 
 	t.Run("sliceAll", func(t *testing.T) {
 		filter := SelectMarshal("sliceAll", NewTestCases())

filter/node_decode.go

@@ -11,7 +11,7 @@ type fieldNodeTree struct {
 	IsAnonymous bool             //是否是匿名结构体，内嵌结构体，需要把所有字段展开
 	IsNil       bool             //该字段值是否为nil
 	ParentNode  *fieldNodeTree   //父节点指针，根节点为nil，
-	ChildNodes  []*fieldNodeTree //如果是struct则保存所有字段名和值的指针，如果是切片就保存切片的所有值
+	Children    []*fieldNodeTree //如果是struct则保存所有字段名和值的指针，如果是切片就保存切片的所有值
 }
 
 func (t *fieldNodeTree) GetValue() (val interface{}, ok bool) {
@@ -22,21 +22,21 @@ func (t *fieldNodeTree) GetValue() (val interface{}, ok bool) {
 	if t.IsNil {
 		return nil, true
 	}
-	if t.ChildNodes == nil {
+	if t.Children == nil {
 		return t.Val, true
 	}
 	if t.IsSlice { //为切片和数组时候key为空
-		slices := make([]interface{}, 0, len(t.ChildNodes))
-		for i := 0; i < len(t.ChildNodes); i++ {
-			value, ok0 := t.ChildNodes[i].GetValue()
+		slices := make([]interface{}, 0, len(t.Children))
+		for i := 0; i < len(t.Children); i++ {
+			value, ok0 := t.Children[i].GetValue()
 			if ok0 {
 				slices = append(slices, value)
 			}
 		}
 		return slices, true
 	}
 	maps := make(map[string]interface{})
-	for _, v := range t.ChildNodes {
+	for _, v := range t.Children {
 		value, ok1 := v.GetValue()
 		if ok1 {
 			maps[v.Key] = value
@@ -47,18 +47,18 @@ func (t *fieldNodeTree) GetValue() (val interface{}, ok bool) {
 
 func (t *fieldNodeTree) Map() map[string]interface{} {
 	maps := make(map[string]interface{})
-	for _, v := range t.ChildNodes {
-		value, ok := (*v).GetValue()
+	for _, v := range t.Children {
+		value, ok := v.GetValue()
 		if ok {
-			maps[(*v).Key] = value
+			maps[v.Key] = value
 		}
 	}
 	return maps
 }
 func (t *fieldNodeTree) Slice() interface{} {
-	slices := make([]interface{}, 0, len(t.ChildNodes))
-	for i := 0; i < len(t.ChildNodes); i++ {
-		v, ok := t.ChildNodes[i].GetValue()
+	slices := make([]interface{}, 0, len(t.Children))
+	for i := 0; i < len(t.Children); i++ {
+		v, ok := t.Children[i].GetValue()
 		if ok {
 			slices = append(slices, v)
 		}
@@ -75,10 +75,10 @@ func (t *fieldNodeTree) Marshal() interface{} {
 }
 
 func (t *fieldNodeTree) AddChild(tree *fieldNodeTree) *fieldNodeTree {
-	if t.ChildNodes == nil {
-		t.ChildNodes = make([]*fieldNodeTree, 0, 3)
+	if t.Children == nil {
+		t.Children = make([]*fieldNodeTree, 0, 3)
 	}
-	t.ChildNodes = append(t.ChildNodes, tree)
+	t.Children = append(t.Children, tree)
 	return t
 }
 

filter/omit_encode.go

@@ -41,7 +41,7 @@ TakePointerValue: //取指针的值
 		var isAnonymous bool
 		for i := 0; i < typeOf.NumField(); i++ {
 			jsonTag, ok := typeOf.Field(i).Tag.Lookup("json")
-			var tag Tag
+			var tag tag
 			if !ok {
 				tag = newOmitNotTag(omitScene, typeOf.Field(i).Name)
 				isAnonymous = typeOf.Field(i).Anonymous
@@ -98,7 +98,7 @@ TakePointerValue: //取指针的值
 				t.AddChild(tree)
 			}
 		}
-		if t.ChildNodes == nil && !t.IsAnonymous {
+		if t.Children == nil && !t.IsAnonymous {
 			//t.Val = struct{}{} //这样表示返回{}
 
 			t.IsAnonymous = true //给他搞成匿名字段的处理方式，直接忽略字段

filter/select_encode.go

@@ -98,7 +98,7 @@ TakePointerValue: //取指针的值
 				t.AddChild(tree)
 			}
 		}
-		if t.ChildNodes == nil && !t.IsAnonymous {
+		if t.Children == nil && !t.IsAnonymous {
 			//t.Val = struct{}{} //这样表示返回{}
 
 			t.IsAnonymous = true //给他搞成匿名字段的处理方式，直接忽略字段

filter/tag.go

@@ -9,7 +9,7 @@ const (
 	//empty ="$empty"
 )
 
-type Tag struct {
+type tag struct {
 	//执行的场景
 	SelectScene string
 	//该字段是否需要被忽略？
@@ -24,13 +24,13 @@ type Tag struct {
 	Omitempty bool
 }
 
-func newSelectTag(tag, selectScene, fieldName string) Tag {
+func newSelectTag(tagStr, selectScene, fieldName string) tag {
 
-	tagEl := Tag{
+	tagEl := tag{
 		SelectScene: selectScene,
 		IsOmitField: true,
 	}
-	tags := strings.Split(tag, ",")
+	tags := strings.Split(tagStr, ",")
 	tagEl.UseFieldName = fieldName
 
 	if len(tags) < 2 {
@@ -63,13 +63,13 @@ func newSelectTag(tag, selectScene, fieldName string) Tag {
 	return tagEl
 }
 
-func newOmitTag(tag, omitScene, fieldName string) Tag {
-	tagEl := Tag{
+func newOmitTag(tagStr, omitScene, fieldName string) tag {
+	tagEl := tag{
 		SelectScene: omitScene,
 		IsOmitField: false,
 		IsSelect:    true,
 	}
-	tags := strings.Split(tag, ",")
+	tags := strings.Split(tagStr, ",")
 	tagEl.UseFieldName = fieldName
 
 	if len(tags) < 2 {
@@ -107,8 +107,8 @@ func newOmitTag(tag, omitScene, fieldName string) Tag {
 	return tagEl
 }
 
-func newOmitNotTag(omitScene, fieldName string) Tag {
-	return Tag{
+func newOmitNotTag(omitScene, fieldName string) tag {
+	return tag{
 		IsSelect:     true,
 		UseFieldName: fieldName,
 		SelectScene:  omitScene,

filter/time.go

@@ -7,7 +7,7 @@ import (
 
 type Time time.Time
 
-const timeFmt = "2006-01-02 15:04:05"
+var timeFmt = "2006-01-02 15:04:05"
 
 func (t Time) MarshalJSON() ([]byte, error) {
 	fmtTime := time.Time(t)