Skip to content

feat(protoc-gen-go-http): add bind query to disable BindQuery #3719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yeqown wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(protoc-gen-go-http): add bind query to disable BindQuery #3719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions cmd/protoc-gen-go-http/http.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const (
var methodSets = make(map[string]int)

// generateFile generates a _http.pb.go file containing kratos errors definitions.
func generateFile(gen *protogen.Plugin, file *protogen.File, omitempty bool, omitemptyPrefix string) *protogen.GeneratedFile {
func generateFile(gen *protogen.Plugin, file *protogen.File, omitempty bool, omitemptyPrefix string, bindQuery bool) *protogen.GeneratedFile {
if len(file.Services) == 0 || (omitempty && !hasHTTPRule(file.Services)) {
return nil
}
Expand All @@ -42,12 +42,12 @@ func generateFile(gen *protogen.Plugin, file *protogen.File, omitempty bool, omi
g.P()
g.P("package ", file.GoPackageName)
g.P()
generateFileContent(gen, file, g, omitempty, omitemptyPrefix)
generateFileContent(gen, file, g, omitempty, omitemptyPrefix, bindQuery)
return g
}

// generateFileContent generates the kratos errors definitions, excluding the package statement.
func generateFileContent(gen *protogen.Plugin, file *protogen.File, g *protogen.GeneratedFile, omitempty bool, omitemptyPrefix string) {
func generateFileContent(gen *protogen.Plugin, file *protogen.File, g *protogen.GeneratedFile, omitempty bool, omitemptyPrefix string, bindQuery bool) {
if len(file.Services) == 0 {
return
}
Expand All @@ -59,11 +59,11 @@ func generateFileContent(gen *protogen.Plugin, file *protogen.File, g *protogen.
g.P()

for _, service := range file.Services {
genService(gen, file, g, service, omitempty, omitemptyPrefix)
genService(gen, file, g, service, omitempty, omitemptyPrefix, bindQuery)
}
}

func genService(_ *protogen.Plugin, file *protogen.File, g *protogen.GeneratedFile, service *protogen.Service, omitempty bool, omitemptyPrefix string) {
func genService(_ *protogen.Plugin, file *protogen.File, g *protogen.GeneratedFile, service *protogen.Service, omitempty bool, omitemptyPrefix string, bindQuery bool) {
if service.Desc.Options().(*descriptorpb.ServiceOptions).GetDeprecated() {
g.P("//")
g.P(deprecationComment)
Expand All @@ -81,12 +81,12 @@ func genService(_ *protogen.Plugin, file *protogen.File, g *protogen.GeneratedFi
rule, ok := proto.GetExtension(method.Desc.Options(), annotations.E_Http).(*annotations.HttpRule)
if rule != nil && ok {
for _, bind := range rule.AdditionalBindings {
sd.Methods = append(sd.Methods, buildHTTPRule(g, service, method, bind, omitemptyPrefix))
sd.Methods = append(sd.Methods, buildHTTPRule(g, service, method, bind, omitemptyPrefix, bindQuery))
}
sd.Methods = append(sd.Methods, buildHTTPRule(g, service, method, rule, omitemptyPrefix))
sd.Methods = append(sd.Methods, buildHTTPRule(g, service, method, rule, omitemptyPrefix, bindQuery))
} else if !omitempty {
path := fmt.Sprintf("%s/%s/%s", omitemptyPrefix, service.Desc.FullName(), method.Desc.Name())
sd.Methods = append(sd.Methods, buildMethodDesc(g, method, http.MethodPost, path))
sd.Methods = append(sd.Methods, buildMethodDesc(g, method, http.MethodPost, path, bindQuery))
}
}
if len(sd.Methods) != 0 {
Expand All @@ -109,7 +109,7 @@ func hasHTTPRule(services []*protogen.Service) bool {
return false
}

func buildHTTPRule(g *protogen.GeneratedFile, service *protogen.Service, m *protogen.Method, rule *annotations.HttpRule, omitemptyPrefix string) *methodDesc {
func buildHTTPRule(g *protogen.GeneratedFile, service *protogen.Service, m *protogen.Method, rule *annotations.HttpRule, omitemptyPrefix string, bindQuery bool) *methodDesc {
var (
path string
method string
Expand Down Expand Up @@ -145,7 +145,7 @@ func buildHTTPRule(g *protogen.GeneratedFile, service *protogen.Service, m *prot
}
body = rule.Body
responseBody = rule.ResponseBody
md := buildMethodDesc(g, m, method, path)
md := buildMethodDesc(g, m, method, path, bindQuery)
if method == http.MethodGet || method == http.MethodDelete {
if body != "" {
_, _ = fmt.Fprintf(os.Stderr, "\u001B[31mWARN\u001B[m: %s %s body should not be declared.\n", method, path)
Expand All @@ -172,7 +172,7 @@ func buildHTTPRule(g *protogen.GeneratedFile, service *protogen.Service, m *prot
return md
}

func buildMethodDesc(g *protogen.GeneratedFile, m *protogen.Method, method, path string) *methodDesc {
func buildMethodDesc(g *protogen.GeneratedFile, m *protogen.Method, method, path string, bindQuery bool) *methodDesc {
defer func() { methodSets[m.GoName]++ }()

vars := buildPathVars(path)
Expand Down Expand Up @@ -224,6 +224,7 @@ func buildMethodDesc(g *protogen.GeneratedFile, m *protogen.Method, method, path
Path: path,
Method: method,
HasVars: len(vars) > 0,
BindQuery: bindQuery,
}
}

Expand Down
2 changes: 2 additions & 0 deletions cmd/protoc-gen-go-http/httpTemplate.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ func _{{$svrType}}_{{.Name}}{{.Num}}_HTTP_Handler(srv {{$svrType}}HTTPServer) fu
return err
}
{{- end}}
{{- if .BindQuery}}
if err := ctx.BindQuery(&in); err != nil {
return err
}
{{- end}}
{{- if .HasVars}}
if err := ctx.BindVars(&in); err != nil {
return err
Expand Down
3 changes: 2 additions & 1 deletion cmd/protoc-gen-go-http/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ var (
showVersion = flag.Bool("version", false, "print the version and exit")
omitempty = flag.Bool("omitempty", true, "omit if google.api is empty")
omitemptyPrefix = flag.String("omitempty_prefix", "", "omit if google.api is empty")
bindQuery = flag.Bool("bind_query", true, "bind query")
)

func main() {
Expand All @@ -28,7 +29,7 @@ func main() {
if !f.Generate {
continue
}
generateFile(gen, f, *omitempty, *omitemptyPrefix)
generateFile(gen, f, *omitempty, *omitemptyPrefix, *bindQuery)
}
return nil
})
Expand Down
1 change: 1 addition & 0 deletions cmd/protoc-gen-go-http/template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ type methodDesc struct {
HasBody bool
Body string
ResponseBody string
BindQuery bool
}

func (s *serviceDesc) execute() string {
Expand Down
Loading