genhandlers.go 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143
  1. package gogen
  2. import (
  3. _ "embed"
  4. "fmt"
  5. "path"
  6. "strings"
  7. "github.com/zeromicro/go-zero/tools/goctl/api/spec"
  8. "github.com/zeromicro/go-zero/tools/goctl/config"
  9. "github.com/zeromicro/go-zero/tools/goctl/pkg/golang"
  10. "github.com/zeromicro/go-zero/tools/goctl/util"
  11. "github.com/zeromicro/go-zero/tools/goctl/util/format"
  12. "github.com/zeromicro/go-zero/tools/goctl/util/pathx"
  13. "github.com/zeromicro/go-zero/tools/goctl/vars"
  14. )
  15. const defaultLogicPackage = "logic"
  16. //go:embed handler.tpl
  17. var handlerTemplate string
  18. type handlerInfo struct {
  19. PkgName string
  20. ImportPackages string
  21. HandlerName string
  22. RequestType string
  23. LogicName string
  24. LogicType string
  25. Call string
  26. HasResp bool
  27. HasRequest bool
  28. }
  29. func genHandler(dir, rootPkg string, cfg *config.Config, group spec.Group, route spec.Route) error {
  30. handler := getHandlerName(route)
  31. handlerPath := getHandlerFolderPath(group, route)
  32. pkgName := handlerPath[strings.LastIndex(handlerPath, "/")+1:]
  33. logicName := defaultLogicPackage
  34. if handlerPath != handlerDir {
  35. handler = strings.Title(handler)
  36. logicName = pkgName
  37. }
  38. parentPkg, err := golang.GetParentPackage(dir)
  39. if err != nil {
  40. return err
  41. }
  42. return doGenToFile(dir, handler, cfg, group, route, handlerInfo{
  43. PkgName: pkgName,
  44. ImportPackages: genHandlerImports(group, route, parentPkg),
  45. HandlerName: handler,
  46. RequestType: util.Title(route.RequestTypeName()),
  47. LogicName: logicName,
  48. LogicType: strings.Title(getLogicName(route)),
  49. Call: strings.Title(strings.TrimSuffix(handler, "Handler")),
  50. HasResp: len(route.ResponseTypeName()) > 0,
  51. HasRequest: len(route.RequestTypeName()) > 0,
  52. })
  53. }
  54. func doGenToFile(dir, handler string, cfg *config.Config, group spec.Group,
  55. route spec.Route, handleObj handlerInfo) error {
  56. filename, err := format.FileNamingFormat(cfg.NamingFormat, handler)
  57. if err != nil {
  58. return err
  59. }
  60. return genFile(fileGenConfig{
  61. dir: dir,
  62. subdir: getHandlerFolderPath(group, route),
  63. filename: filename + ".go",
  64. templateName: "handlerTemplate",
  65. category: category,
  66. templateFile: handlerTemplateFile,
  67. builtinTemplate: handlerTemplate,
  68. data: handleObj,
  69. })
  70. }
  71. func genHandlers(dir, rootPkg string, cfg *config.Config, api *spec.ApiSpec) error {
  72. for _, group := range api.Service.Groups {
  73. for _, route := range group.Routes {
  74. if err := genHandler(dir, rootPkg, cfg, group, route); err != nil {
  75. return err
  76. }
  77. }
  78. }
  79. return nil
  80. }
  81. func genHandlerImports(group spec.Group, route spec.Route, parentPkg string) string {
  82. var imports []string
  83. imports = append(imports, fmt.Sprintf("\"%s\"",
  84. pathx.JoinPackages(parentPkg, getLogicFolderPath(group, route))))
  85. imports = append(imports, fmt.Sprintf("\"%s\"", pathx.JoinPackages(parentPkg, contextDir)))
  86. if len(route.RequestTypeName()) > 0 {
  87. imports = append(imports, fmt.Sprintf("\"%s\"\n", pathx.JoinPackages(parentPkg, typesDir)))
  88. }
  89. imports = append(imports, fmt.Sprintf("\"%s/rest/httpx\"", vars.ProjectOpenSourceURL))
  90. return strings.Join(imports, "\n\t")
  91. }
  92. func getHandlerBaseName(route spec.Route) (string, error) {
  93. handler := route.Handler
  94. handler = strings.TrimSpace(handler)
  95. handler = strings.TrimSuffix(handler, "handler")
  96. handler = strings.TrimSuffix(handler, "Handler")
  97. return handler, nil
  98. }
  99. func getHandlerFolderPath(group spec.Group, route spec.Route) string {
  100. folder := route.GetAnnotation(groupProperty)
  101. if len(folder) == 0 {
  102. folder = group.GetAnnotation(groupProperty)
  103. if len(folder) == 0 {
  104. return handlerDir
  105. }
  106. }
  107. folder = strings.TrimPrefix(folder, "/")
  108. folder = strings.TrimSuffix(folder, "/")
  109. return path.Join(handlerDir, folder)
  110. }
  111. func getHandlerName(route spec.Route) string {
  112. handler, err := getHandlerBaseName(route)
  113. if err != nil {
  114. panic(err)
  115. }
  116. return handler + "Handler"
  117. }
  118. func getLogicName(route spec.Route) string {
  119. handler, err := getHandlerBaseName(route)
  120. if err != nil {
  121. panic(err)
  122. }
  123. return handler + "Logic"
  124. }