Address comment

cloudwego · Sep 4, 2023 · b5a7eff · b5a7eff
1 parent c562932
commit b5a7eff
Show file tree

Hide file tree

Showing 8 changed files with 51 additions and 45 deletions.
diff --git a/generator/golang/imports.go b/generator/golang/imports.go
@@ -87,7 +87,7 @@ func (im *importManager) init(cu *CodeUtils, ast *parser.Thrift) {
 		"unknown":           DefaultUnknownLib,
 		"meta":              DefaultMetaLib,
 		"thrift_reflection": ThriftReflectionLib,
-		"json":              "encoding/json",
+		"json_utils":        ThriftJSONUtilLib,
 	}
 	for pkg, path := range std {
 		ns.Add(pkg, path)

diff --git a/generator/golang/option.go b/generator/golang/option.go
@@ -53,36 +53,36 @@ type Features struct {
 	CodeRef                bool `code_ref:"Genenerate code ref by given idl-ref.yaml"`
 	TrimIDL                bool `trim_idl:"Simplify IDL to the most concise form before generating code."`
 
-	GenerateJSONStringMethod bool `generate_json_string_method:"Generate the JSON marshal method as String()."`
+	JSONStringer bool `json_stringer:"Generate the JSON marshal method in String() method."`
 }
 
 var defaultFeatures = Features{
-	MarshalEnumToText:        false,
-	GenerateSetter:           false,
-	GenDatabaseTag:           false,
-	GenOmitEmptyTag:          true,
-	TypedefAsTypeAlias:       true,
-	ValidateSet:              true,
-	ValueTypeForSIC:          false,
-	ScanValueForEnum:         true,
-	ReorderFields:            false,
-	TypedEnumString:          false,
-	KeepUnknownFields:        false,
-	GenDeepEqual:             false,
-	CompatibleNames:          false,
-	ReserveComments:          false,
-	NilSafe:                  false,
-	FrugalTag:                false,
-	EscapeDoubleInTag:        true,
-	GenerateTypeMeta:         false,
-	GenerateJSONTag:          true,
-	AlwaysGenerateJSONTag:    false,
-	SnakeTyleJSONTag:         false,
-	LowerCamelCaseJSONTag:    false,
-	GenerateReflectionInfo:   false,
-	EnumAsINT32:              false,
-	TrimIDL:                  false,
-	GenerateJSONStringMethod: false,
+	MarshalEnumToText:      false,
+	GenerateSetter:         false,
+	GenDatabaseTag:         false,
+	GenOmitEmptyTag:        true,
+	TypedefAsTypeAlias:     true,
+	ValidateSet:            true,
+	ValueTypeForSIC:        false,
+	ScanValueForEnum:       true,
+	ReorderFields:          false,
+	TypedEnumString:        false,
+	KeepUnknownFields:      false,
+	GenDeepEqual:           false,
+	CompatibleNames:        false,
+	ReserveComments:        false,
+	NilSafe:                false,
+	FrugalTag:              false,
+	EscapeDoubleInTag:      true,
+	GenerateTypeMeta:       false,
+	GenerateJSONTag:        true,
+	AlwaysGenerateJSONTag:  false,
+	SnakeTyleJSONTag:       false,
+	LowerCamelCaseJSONTag:  false,
+	GenerateReflectionInfo: false,
+	EnumAsINT32:            false,
+	TrimIDL:                false,
+	JSONStringer:           false,
 }
 
 type param struct {

diff --git a/generator/golang/templates/file.go b/generator/golang/templates/file.go
@@ -25,16 +25,6 @@ import (
 	{{- if Features.GenerateReflectionInfo}}thriftreflection "github.com/cloudwego/kitex/pkg/reflection/thrift"{{end}}
 )
 
-{{- if Features.GenerateJSONStringMethod }}
-{{- UseStdLibrary "json"}}
-// jsonMarshaler customize json.Marshal as you like
-type jsonMarshaler func(v interface{}) ([]byte, error)
-var jsonFunc jsonMarshaler = json.Marshal
-func ResetJSONMarshalFunc(jn jsonMarshaler) {
-	jsonFunc = jn
-}
-{{- end}}
-
 {{template "Constant" .}}
 
 {{- range .Enums}}

diff --git a/generator/golang/templates/slim/slim.go b/generator/golang/templates/slim/slim.go
@@ -92,9 +92,9 @@ func (p *{{$TypeName}}) CarryingUnknownFields() bool {
 {{template "FieldIsSet" .}}
 
 func (p *{{$TypeName}}) String() string {
-	{{- if Features.GenerateJSONStringMethod }}
-	{{- UseStdLibrary "json"}}
-	JsonBytes , _  := jsonFunc(p)
+	{{- if Features.JSONStringer}}
+	{{- UseStdLibrary "json_utils"}}
+	JsonBytes , _  := json_utils.JSONFunc(p)
 	return string(JsonBytes)	
 	{{- else}}
 	if p == nil {

diff --git a/generator/golang/templates/struct.go b/generator/golang/templates/struct.go
@@ -94,9 +94,9 @@ var fieldIDToName_{{$TypeName}} = map[int16]string{
 {{template "StructLikeWriteField" .}}
 
 func (p *{{$TypeName}}) String() string {
-	{{- if Features.GenerateJSONStringMethod }}
-	{{- UseStdLibrary "json"}}
-		JsonBytes , _  := jsonFunc(p)
+	{{- if Features.JSONStringer}}
+	{{- UseStdLibrary "json_utils"}}
+		JsonBytes , _  := json_utils.JSONFunc(p)
 		return string(JsonBytes)
 	{{- else}}
 	if p == nil {

diff --git a/generator/golang/util.go b/generator/golang/util.go
@@ -45,6 +45,7 @@ const (
 	ThriftReflectionLib = "github.com/cloudwego/thriftgo/thrift_reflection"
 	ThriftOptionLib     = "github.com/cloudwego/thriftgo/option"
 	defaultTemplate     = "default"
+	ThriftJSONUtilLib   = "github.com/cloudwego/thriftgo/utils/json_utils"
 )
 
 var escape = regexp.MustCompile(`\\.`)

diff --git a/test/golang/cases_and_options/run_test.sh b/test/golang/cases_and_options/run_test.sh
@@ -44,7 +44,7 @@ features=(\
     nil_safe \
     frugal_tag \
     unescape_double_quote \
-    generate_json_string_method \ 
+    json_stringer \ 
 )
 
 run_cases() {

diff --git a/utils/json_utils/json_utils.go b/utils/json_utils/json_utils.go
@@ -0,0 +1,15 @@
+package json_utils
+
+import "encoding/json"
+
+// jsonMarshaler customize json.Marshal as you like
+type jsonMarshaler func(v interface{}) ([]byte, error)
+
+var JSONFunc jsonMarshaler = json.Marshal
+
+// ResetJSONMarshalFunc replace the JSON marshal func
+// to all code which are generated by thriftgo.
+// Usually, it is used in String() method.
+func ResetJSONMarshalFunc(jn jsonMarshaler) {
+	JSONFunc = jn
+}