genhandlers.go 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  1. package gogen
  2. import (
  3. "bytes"
  4. "fmt"
  5. "path"
  6. "sort"
  7. "strings"
  8. "text/template"
  9. "github.com/tal-tech/go-zero/tools/goctl/api/spec"
  10. apiutil "github.com/tal-tech/go-zero/tools/goctl/api/util"
  11. "github.com/tal-tech/go-zero/tools/goctl/util"
  12. "github.com/tal-tech/go-zero/tools/goctl/vars"
  13. )
  14. const (
  15. handlerTemplate = `package handler
  16. import (
  17. "net/http"
  18. {{.importPackages}}
  19. )
  20. func {{.handlerName}}(ctx *svc.ServiceContext) http.HandlerFunc {
  21. return func(w http.ResponseWriter, r *http.Request) {
  22. l := logic.{{.logic}}(r.Context(), ctx)
  23. {{.handlerBody}}
  24. }
  25. }
  26. `
  27. handlerBodyTemplate = `{{.parseRequest}}
  28. {{.processBody}}
  29. `
  30. parseRequestTemplate = `var req {{.requestType}}
  31. if err := httpx.Parse(r, &req); err != nil {
  32. httpx.Error(w, err)
  33. return
  34. }
  35. `
  36. hasRespTemplate = `
  37. {{.logicResponse}} l.{{.callee}}({{.req}})
  38. if err != nil {
  39. httpx.Error(w, err)
  40. } else {
  41. {{.respWriter}}
  42. }
  43. `
  44. )
  45. func genHandler(dir string, group spec.Group, route spec.Route) error {
  46. handler, ok := apiutil.GetAnnotationValue(route.Annotations, "server", "handler")
  47. if !ok {
  48. return fmt.Errorf("missing handler annotation for %q", route.Path)
  49. }
  50. handler = getHandlerName(handler)
  51. var reqBody string
  52. if len(route.RequestType.Name) > 0 {
  53. var bodyBuilder strings.Builder
  54. t := template.Must(template.New("parseRequest").Parse(parseRequestTemplate))
  55. if err := t.Execute(&bodyBuilder, map[string]string{
  56. "requestType": typesPacket + "." + util.Title(route.RequestType.Name),
  57. }); err != nil {
  58. return err
  59. }
  60. reqBody = bodyBuilder.String()
  61. }
  62. var req = "req"
  63. if len(route.RequestType.Name) == 0 {
  64. req = ""
  65. }
  66. var logicResponse string
  67. var writeResponse = "nil, nil"
  68. var respWriter = `httpx.WriteJson(w, http.StatusOK, resp)`
  69. if len(route.ResponseType.Name) > 0 {
  70. logicResponse = "resp, err :="
  71. writeResponse = "resp, err"
  72. } else {
  73. logicResponse = "err :="
  74. writeResponse = "nil, err"
  75. respWriter = `httpx.Ok(w)`
  76. }
  77. var logicBodyBuilder strings.Builder
  78. t := template.Must(template.New("hasRespTemplate").Parse(hasRespTemplate))
  79. if err := t.Execute(&logicBodyBuilder, map[string]string{
  80. "callee": strings.Title(strings.TrimSuffix(handler, "Handler")),
  81. "req": req,
  82. "logicResponse": logicResponse,
  83. "writeResponse": writeResponse,
  84. "respWriter": respWriter,
  85. }); err != nil {
  86. return err
  87. }
  88. respBody := logicBodyBuilder.String()
  89. if !strings.HasSuffix(handler, "Handler") {
  90. handler = handler + "Handler"
  91. }
  92. var bodyBuilder strings.Builder
  93. bodyTemplate := template.Must(template.New("handlerBodyTemplate").Parse(handlerBodyTemplate))
  94. if err := bodyTemplate.Execute(&bodyBuilder, map[string]string{
  95. "parseRequest": reqBody,
  96. "processBody": respBody,
  97. }); err != nil {
  98. return err
  99. }
  100. return doGenToFile(dir, handler, group, route, bodyBuilder)
  101. }
  102. func doGenToFile(dir, handler string, group spec.Group, route spec.Route, bodyBuilder strings.Builder) error {
  103. if getHandlerFolderPath(group, route) != handlerDir {
  104. handler = strings.Title(handler)
  105. }
  106. parentPkg, err := getParentPackage(dir)
  107. if err != nil {
  108. return err
  109. }
  110. filename := strings.ToLower(handler)
  111. if strings.HasSuffix(filename, "handler") {
  112. filename = filename + ".go"
  113. } else {
  114. filename = filename + "handler.go"
  115. }
  116. fp, created, err := apiutil.MaybeCreateFile(dir, getHandlerFolderPath(group, route), filename)
  117. if err != nil {
  118. return err
  119. }
  120. if !created {
  121. return nil
  122. }
  123. defer fp.Close()
  124. t := template.Must(template.New("handlerTemplate").Parse(handlerTemplate))
  125. buffer := new(bytes.Buffer)
  126. err = t.Execute(buffer, map[string]string{
  127. "logic": "New" + strings.TrimSuffix(strings.Title(handler), "Handler") + "Logic",
  128. "importPackages": genHandlerImports(group, route, parentPkg),
  129. "handlerName": handler,
  130. "handlerBody": strings.TrimSpace(bodyBuilder.String()),
  131. })
  132. if err != nil {
  133. return nil
  134. }
  135. formatCode := formatCode(buffer.String())
  136. _, err = fp.WriteString(formatCode)
  137. return err
  138. }
  139. func genHandlers(dir string, api *spec.ApiSpec) error {
  140. for _, group := range api.Service.Groups {
  141. for _, route := range group.Routes {
  142. if err := genHandler(dir, group, route); err != nil {
  143. return err
  144. }
  145. }
  146. }
  147. return nil
  148. }
  149. func genHandlerImports(group spec.Group, route spec.Route, parentPkg string) string {
  150. var imports []string
  151. imports = append(imports, fmt.Sprintf("\"%s/rest/httpx\"", vars.ProjectOpenSourceUrl))
  152. imports = append(imports, fmt.Sprintf("\"%s\"", util.JoinPackages(parentPkg, contextDir)))
  153. if len(route.RequestType.Name) > 0 || len(route.ResponseType.Name) > 0 {
  154. imports = append(imports, fmt.Sprintf("\"%s\"", util.JoinPackages(parentPkg, typesDir)))
  155. }
  156. imports = append(imports, fmt.Sprintf("\"%s\"",
  157. util.JoinPackages(parentPkg, getLogicFolderPath(group, route))))
  158. sort.Strings(imports)
  159. return strings.Join(imports, "\n\t")
  160. }
  161. func getHandlerBaseName(handler string) string {
  162. handlerName := util.Untitle(handler)
  163. if strings.HasSuffix(handlerName, "handler") {
  164. handlerName = strings.ReplaceAll(handlerName, "handler", "")
  165. } else if strings.HasSuffix(handlerName, "Handler") {
  166. handlerName = strings.ReplaceAll(handlerName, "Handler", "")
  167. }
  168. return handlerName
  169. }
  170. func getHandlerFolderPath(group spec.Group, route spec.Route) string {
  171. folder, ok := apiutil.GetAnnotationValue(route.Annotations, "server", folderProperty)
  172. if !ok {
  173. folder, ok = apiutil.GetAnnotationValue(group.Annotations, "server", folderProperty)
  174. if !ok {
  175. return handlerDir
  176. }
  177. }
  178. folder = strings.TrimPrefix(folder, "/")
  179. folder = strings.TrimSuffix(folder, "/")
  180. return path.Join(handlerDir, folder)
  181. }
  182. func getHandlerName(handler string) string {
  183. return getHandlerBaseName(handler) + "Handler"
  184. }