http_binding.go 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. package http_binding
  2. import (
  3. "errors"
  4. "git.sxidc.com/go-tools/api_binding/http_binding/binding_context"
  5. "git.sxidc.com/go-tools/api_binding/http_binding/middleware"
  6. "git.sxidc.com/go-tools/api_binding/http_binding/request"
  7. "git.sxidc.com/go-tools/api_binding/http_binding/response"
  8. "git.sxidc.com/go-tools/api_binding/utils"
  9. "git.sxidc.com/service-supports/fserr"
  10. "github.com/gin-gonic/gin"
  11. "net/http"
  12. "reflect"
  13. "strings"
  14. )
  15. type BusinessFunc[I any, O any] func(c *binding_context.Context, inputModel I) (O, error)
  16. type BindingFunc[O any] func(c *binding_context.Context, request any, sendFunc response.SendFunc[O]) bool
  17. type Binding struct {
  18. routerGroup *gin.RouterGroup
  19. }
  20. // NewBinding 创建版本对应的binding
  21. func NewBinding(apiVersion string, middlewares ...middleware.Func) *Binding {
  22. apiPrefix := urlPrefix + "/api"
  23. if utils.IsStringNotEmpty(apiVersion) && apiVersion != "root" {
  24. apiPrefix += "/" + apiVersion
  25. }
  26. // 把binding.Middleware转换为gin的中间件函数
  27. ginMiddlewares := make([]gin.HandlerFunc, 0)
  28. for _, m := range middlewares {
  29. innerM := m
  30. ginMiddlewares = append(ginMiddlewares, func(c *gin.Context) {
  31. innerM(&binding_context.Context{Context: c})
  32. })
  33. }
  34. // 返回创建的路由组
  35. return &Binding{routerGroup: routerInstance.Group(apiPrefix, ginMiddlewares...)}
  36. }
  37. type HandleFunc func(c *binding_context.Context)
  38. func (binding *Binding) AddHandler(method string, relativePath string, handleFunc HandleFunc) error {
  39. if utils.IsStringEmpty(method) {
  40. return errors.New("没有传递方法名")
  41. }
  42. if utils.IsStringEmpty(relativePath) {
  43. return errors.New("没有传递相对路径")
  44. }
  45. if handleFunc == nil {
  46. return errors.New("没有传递处理函数")
  47. }
  48. binding.routerGroup.Handle(method, relativePath, func(c *gin.Context) {
  49. handleFunc(&binding_context.Context{Context: c})
  50. })
  51. return nil
  52. }
  53. func PostBind[I any, O any](b *Binding, item *SimpleBindItem[I, O], middlewares ...middleware.Func) {
  54. item.bind(b.routerGroup, http.MethodPost, middlewares...)
  55. }
  56. func DeleteBind[I any, O any](b *Binding, item *SimpleBindItem[I, O], middlewares ...middleware.Func) {
  57. item.bind(b.routerGroup, http.MethodDelete, middlewares...)
  58. }
  59. func PutBind[I any, O any](b *Binding, item *SimpleBindItem[I, O], middlewares ...middleware.Func) {
  60. item.bind(b.routerGroup, http.MethodPut, middlewares...)
  61. }
  62. func GetBind[I any, O any](b *Binding, item *SimpleBindItem[I, O], middlewares ...middleware.Func) {
  63. item.bind(b.routerGroup, http.MethodGet, middlewares...)
  64. }
  65. func Bind[I any, O any](b *Binding, item *BindItem[I, O], middlewares ...middleware.Func) {
  66. item.bind(b.routerGroup, middlewares...)
  67. }
  68. func Static(b *Binding, item *StaticBindItem) {
  69. item.bind(b.routerGroup)
  70. }
  71. // SimpleBindItem 路由条目
  72. type SimpleBindItem[I any, O any] struct {
  73. Path string // 请求路径
  74. ResponseFunc response.SendFunc[O] // 响应泛型函数
  75. BusinessFunc BusinessFunc[I, O] // 业务泛型函数
  76. OptionalBindingFunc BindingFunc[O] //
  77. }
  78. func (item *SimpleBindItem[I, O]) bind(routerGroup *gin.RouterGroup, method string, middlewares ...middleware.Func) {
  79. bindingItem := &BindItem[I, O]{
  80. Method: method,
  81. SimpleBindItem: item,
  82. }
  83. bindingItem.bind(routerGroup, middlewares...)
  84. }
  85. // BindItem 路由条目结构
  86. type BindItem[I any, O any] struct {
  87. Method string
  88. *SimpleBindItem[I, O]
  89. }
  90. func (item *BindItem[I, O]) bind(routerGroup *gin.RouterGroup, middlewares ...middleware.Func) {
  91. if utils.IsStringEmpty(item.Path) {
  92. panic("需要指定路径")
  93. }
  94. if utils.IsStringEmpty(item.Method) {
  95. panic("需要指定方法")
  96. }
  97. if item.ResponseFunc == nil {
  98. panic("需要指定响应函数")
  99. }
  100. var inputCheckModel I
  101. inputType := reflect.TypeOf(inputCheckModel)
  102. if inputType != nil {
  103. if inputType.Kind() == reflect.Pointer {
  104. panic("输入对象不能使用指针类型")
  105. }
  106. if inputType.Kind() != reflect.Struct {
  107. panic("输入对象必须是结构")
  108. }
  109. }
  110. // 给单个路由增加中间件
  111. ginHandleFunctions := make([]gin.HandlerFunc, 0)
  112. for _, m := range middlewares {
  113. innerM := m
  114. ginHandleFunctions = append(ginHandleFunctions, func(c *gin.Context) {
  115. innerM(&binding_context.Context{Context: c})
  116. })
  117. }
  118. ginHandleFunctions = append(ginHandleFunctions, func(c *gin.Context) {
  119. bindingContext := &binding_context.Context{Context: c}
  120. var inputModel I
  121. // 请求的结构类型不为any
  122. if inputType != nil {
  123. // 将请求数据解析到inputModel中
  124. if item.OptionalBindingFunc != nil {
  125. ok := item.OptionalBindingFunc(bindingContext, &inputModel, item.ResponseFunc)
  126. if !ok {
  127. return
  128. }
  129. } else {
  130. switch item.Method {
  131. case http.MethodPost:
  132. fallthrough
  133. case http.MethodPut:
  134. ok := request.BindingJson(bindingContext, &inputModel, item.ResponseFunc)
  135. if !ok {
  136. return
  137. }
  138. case http.MethodGet:
  139. fallthrough
  140. case http.MethodDelete:
  141. ok := request.BindingQuery(bindingContext, &inputModel, item.ResponseFunc)
  142. if !ok {
  143. return
  144. }
  145. }
  146. }
  147. }
  148. // 执行业务函数
  149. if item.BusinessFunc != nil {
  150. statusCode := http.StatusOK
  151. outputModel, err := item.BusinessFunc(bindingContext, inputModel)
  152. if err != nil {
  153. statusCode = fserr.ParseCode(err).HttpCode
  154. }
  155. item.ResponseFunc(bindingContext, statusCode, outputModel, err)
  156. return
  157. }
  158. })
  159. // 所有的函数加入到执行链中
  160. routerGroup.Handle(item.Method, item.Path, ginHandleFunctions...)
  161. }
  162. // StaticBindItem 静态路由item
  163. type StaticBindItem struct {
  164. RelativePath string
  165. Root string
  166. WithBasePath bool
  167. }
  168. func (item *StaticBindItem) bind(routerGroup *gin.RouterGroup) {
  169. if item.WithBasePath {
  170. routerGroup.Static(strings.TrimPrefix(item.RelativePath, routerGroup.BasePath()), item.Root)
  171. } else {
  172. routerGroup.Static(item.RelativePath, item.Root)
  173. }
  174. }