genhandlers.go 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162
  1. package gogen
  2. import (
  3. "bytes"
  4. "fmt"
  5. "path"
  6. "strings"
  7. "text/template"
  8. "github.com/tal-tech/go-zero/tools/goctl/api/spec"
  9. apiutil "github.com/tal-tech/go-zero/tools/goctl/api/util"
  10. "github.com/tal-tech/go-zero/tools/goctl/util"
  11. "github.com/tal-tech/go-zero/tools/goctl/vars"
  12. )
  13. const handlerTemplate = `package handler
  14. import (
  15. "net/http"
  16. {{.ImportPackages}}
  17. )
  18. func {{.HandlerName}}(ctx *svc.ServiceContext) http.HandlerFunc {
  19. return func(w http.ResponseWriter, r *http.Request) {
  20. var req types.{{.RequestType}}
  21. if err := httpx.Parse(r, &req); err != nil {
  22. httpx.Error(w, err)
  23. return
  24. }
  25. l := logic.New{{.LogicType}}(r.Context(), ctx)
  26. {{if .HasResp}}resp, {{end}}err := l.{{.Call}}(req)
  27. if err != nil {
  28. httpx.Error(w, err)
  29. } else {
  30. {{if .HasResp}}httpx.OkJson(w, resp){{else}}httpx.Ok(w){{end}}
  31. }
  32. }
  33. }
  34. `
  35. type Handler struct {
  36. ImportPackages string
  37. HandlerName string
  38. RequestType string
  39. LogicType string
  40. Call string
  41. HasResp bool
  42. }
  43. func genHandler(dir string, group spec.Group, route spec.Route) error {
  44. handler, ok := apiutil.GetAnnotationValue(route.Annotations, "server", "handler")
  45. if !ok {
  46. return fmt.Errorf("missing handler annotation for %q", route.Path)
  47. }
  48. handler = getHandlerName(handler)
  49. if getHandlerFolderPath(group, route) != handlerDir {
  50. handler = strings.Title(handler)
  51. }
  52. parentPkg, err := getParentPackage(dir)
  53. if err != nil {
  54. return err
  55. }
  56. return doGenToFile(dir, handler, group, route, Handler{
  57. ImportPackages: genHandlerImports(group, route, parentPkg),
  58. HandlerName: handler,
  59. RequestType: util.Title(route.RequestType.Name),
  60. LogicType: strings.TrimSuffix(strings.Title(handler), "Handler") + "Logic",
  61. Call: strings.Title(strings.TrimSuffix(handler, "Handler")),
  62. HasResp: len(route.ResponseType.Name) > 0,
  63. })
  64. }
  65. func doGenToFile(dir, handler string, group spec.Group, route spec.Route, handleObj Handler) error {
  66. if getHandlerFolderPath(group, route) != handlerDir {
  67. handler = strings.Title(handler)
  68. }
  69. filename := strings.ToLower(handler)
  70. if strings.HasSuffix(filename, "handler") {
  71. filename = filename + ".go"
  72. } else {
  73. filename = filename + "handler.go"
  74. }
  75. fp, created, err := apiutil.MaybeCreateFile(dir, getHandlerFolderPath(group, route), filename)
  76. if err != nil {
  77. return err
  78. }
  79. if !created {
  80. return nil
  81. }
  82. defer fp.Close()
  83. text, err := util.LoadTemplate(category, handlerTemplateFile, handlerTemplate)
  84. if err != nil {
  85. return err
  86. }
  87. buffer := new(bytes.Buffer)
  88. err = template.Must(template.New("handlerTemplate").Parse(text)).Execute(buffer, handleObj)
  89. if err != nil {
  90. return nil
  91. }
  92. formatCode := formatCode(buffer.String())
  93. _, err = fp.WriteString(formatCode)
  94. return err
  95. }
  96. func genHandlers(dir string, api *spec.ApiSpec) error {
  97. for _, group := range api.Service.Groups {
  98. for _, route := range group.Routes {
  99. if err := genHandler(dir, group, route); err != nil {
  100. return err
  101. }
  102. }
  103. }
  104. return nil
  105. }
  106. func genHandlerImports(group spec.Group, route spec.Route, parentPkg string) string {
  107. var imports []string
  108. imports = append(imports, fmt.Sprintf("\"%s\"",
  109. util.JoinPackages(parentPkg, getLogicFolderPath(group, route))))
  110. imports = append(imports, fmt.Sprintf("\"%s\"", util.JoinPackages(parentPkg, contextDir)))
  111. if len(route.RequestType.Name) > 0 {
  112. imports = append(imports, fmt.Sprintf("\"%s\"\n", util.JoinPackages(parentPkg, typesDir)))
  113. }
  114. imports = append(imports, fmt.Sprintf("\"%s/rest/httpx\"", vars.ProjectOpenSourceUrl))
  115. return strings.Join(imports, "\n\t")
  116. }
  117. func getHandlerBaseName(handler string) string {
  118. handlerName := util.Untitle(handler)
  119. if strings.HasSuffix(handlerName, "handler") {
  120. handlerName = strings.ReplaceAll(handlerName, "handler", "")
  121. } else if strings.HasSuffix(handlerName, "Handler") {
  122. handlerName = strings.ReplaceAll(handlerName, "Handler", "")
  123. }
  124. return handlerName
  125. }
  126. func getHandlerFolderPath(group spec.Group, route spec.Route) string {
  127. folder, ok := apiutil.GetAnnotationValue(route.Annotations, "server", groupProperty)
  128. if !ok {
  129. folder, ok = apiutil.GetAnnotationValue(group.Annotations, "server", groupProperty)
  130. if !ok {
  131. return handlerDir
  132. }
  133. }
  134. folder = strings.TrimPrefix(folder, "/")
  135. folder = strings.TrimSuffix(folder, "/")
  136. return path.Join(handlerDir, folder)
  137. }
  138. func getHandlerName(handler string) string {
  139. return getHandlerBaseName(handler) + "Handler"
  140. }