feat(hz): optional filed parse for client (#1177)

cloudwego · Dec 13, 2024 · c277f58 · c277f58
1 parent e644b1c
commit c277f58
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 4 deletions.
diff --git a/cmd/hz/app/app.go b/cmd/hz/app/app.go
@@ -194,6 +194,9 @@ func Init() *cli.App {
 	handlerByMethod := cli.BoolFlag{Name: "handler_by_method", Usage: "Generate a separate handler file for each method.", Destination: &globalArgs.HandlerByMethod}
 	trimGoPackage := cli.StringFlag{Name: "trim_gopackage", Aliases: []string{"trim_pkg"}, Usage: "Trim the prefix of go_package for protobuf.", Destination: &globalArgs.TrimGoPackage}
 
+	// client flag
+	enableClientOptionalFlag := cli.BoolFlag{Name: "enable_optional", Usage: "Optional field do not transfer for thrift if not set.(Only works for query tag)", Destination: &globalArgs.EnableClientOptional}
+
 	// app
 	app := cli.NewApp()
 	app.Name = "hz"
@@ -327,6 +330,7 @@ func Init() *cli.App {
 				&trimGoPackage,
 
 				&jsonEnumStrFlag,
+				&enableClientOptionalFlag,
 				&queryEnumIntFlag,
 				&unsetOmitemptyFlag,
 				&protoCamelJSONTag,

diff --git a/cmd/hz/config/argument.go b/cmd/hz/config/argument.go
@@ -76,6 +76,9 @@ type Argument struct {
 	EnableExtends        bool
 	SortRouter           bool
 
+	// client flag
+	EnableClientOptional bool
+
 	CustomizeLayout     string
 	CustomizeLayoutData string
 	CustomizePackage    string

diff --git a/cmd/hz/generator/package_tpl.go b/cmd/hz/generator/package_tpl.go
@@ -589,7 +589,13 @@ func (r *request) addHeaders(params map[string]string) *request {
 
 
 func (r *request) setQueryParam(param string, value interface{}) *request {
+	if value == nil {
+		return r
+	}
 	v := reflect.ValueOf(value)
+	if v.Kind() == reflect.Pointer && v.IsNil() {
+		return r
+	}
 	switch v.Kind() {
 	case reflect.Slice, reflect.Array:
 		for index := 0; index < v.Len(); index++ {

diff --git a/cmd/hz/thrift/ast.go b/cmd/hz/thrift/ast.go
@@ -216,7 +216,7 @@ func astToService(ast *parser.Thrift, resolver *Resolver, args *config.Argument)
 				if err != nil {
 					return nil, err
 				}
-				err = parseAnnotationToClient(clientMethod, m.Arguments[0].GetType(), rt)
+				err = parseAnnotationToClient(clientMethod, m.Arguments[0].GetType(), rt, args.EnableClientOptional)
 				if err != nil {
 					return nil, err
 				}
@@ -244,7 +244,7 @@ func newHTTPMethod(s *parser.Service, m *parser.Function, method *generator.Http
 	return &newMethod, nil
 }
 
-func parseAnnotationToClient(clientMethod *generator.ClientMethod, p *parser.Type, symbol ResolvedSymbol) error {
+func parseAnnotationToClient(clientMethod *generator.ClientMethod, p *parser.Type, symbol ResolvedSymbol, enableOptional bool) error {
 	if p == nil {
 		return fmt.Errorf("get type failed for parse annotatoon to client")
 	}
@@ -270,13 +270,21 @@ func parseAnnotationToClient(clientMethod *generator.ClientMethod, p *parser.Typ
 	for _, field := range st.Fields() {
 		hasAnnotation := false
 		isStringFieldType := false
+		isOptional := false
 		if field.GetType().String() == "string" {
 			isStringFieldType = true
 		}
+		if field.GetRequiredness() == parser.FieldType_Optional {
+			isOptional = true
+		}
 		if anno := getAnnotation(field.Annotations, AnnotationQuery); len(anno) > 0 {
 			hasAnnotation = true
 			query := checkSnakeName(anno[0])
-			clientMethod.QueryParamsCode += fmt.Sprintf("%q: req.Get%s(),\n", query, field.GoName().String())
+			if isOptional && enableOptional {
+				clientMethod.QueryParamsCode += fmt.Sprintf("%q: func() interface{} {\n\t\t\t\tif req.IsSet%s() {\n\t\t\t\t\treturn req.Get%s()\n\t\t\t\t} else {\n\t\t\t\t\treturn nil\n\t\t\t\t}}(),\n", query, field.GoName().String(), field.GoName().String())
+			} else {
+				clientMethod.QueryParamsCode += fmt.Sprintf("%q: req.Get%s(),\n", query, field.GoName().String())
+			}
 		}
 
 		if anno := getAnnotation(field.Annotations, AnnotationPath); len(anno) > 0 {
@@ -326,7 +334,11 @@ func parseAnnotationToClient(clientMethod *generator.ClientMethod, p *parser.Typ
 			// cookie do nothing
 		}
 		if !hasAnnotation && strings.EqualFold(clientMethod.HTTPMethod, "get") {
-			clientMethod.QueryParamsCode += fmt.Sprintf("%q: req.Get%s(),\n", checkSnakeName(field.GetName()), field.GoName().String())
+			if isOptional && enableOptional {
+				clientMethod.QueryParamsCode += fmt.Sprintf("%q: func() interface{} {\n\t\t\t\tif req.IsSet%s() {\n\t\t\t\t\treturn req.Get%s()\n\t\t\t\t} else {\n\t\t\t\t\treturn nil\n\t\t\t\t}}(),\n", checkSnakeName(field.GetName()), field.GoName().String(), field.GoName().String())
+			} else {
+				clientMethod.QueryParamsCode += fmt.Sprintf("%q: req.Get%s(),\n", checkSnakeName(field.GetName()), field.GoName().String())
+			}
 		}
 	}
 	clientMethod.BodyParamsCode = meta.SetBodyParam