simple.go 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  1. package entity_crud
  2. import (
  3. "git.sxidc.com/go-framework/baize/framework/binding"
  4. "git.sxidc.com/go-framework/baize/framework/core/api/request"
  5. "git.sxidc.com/go-framework/baize/framework/core/api/response"
  6. "git.sxidc.com/go-framework/baize/framework/core/domain"
  7. "git.sxidc.com/go-framework/baize/framework/core/domain/entity"
  8. )
  9. // Simple 实体CRUD的Bind参数
  10. // I 为查询相关接口返回的Info类型
  11. type Simple[I any] struct {
  12. // 使用的领域实体,注意是Entity类型
  13. Entity entity.Entity
  14. // 数据库Schema
  15. Schema string
  16. // 创建使用的请求参数
  17. CreateJsonBody request.Params
  18. // 删除使用的请求参数,注意是WithID类型
  19. DeleteQueryParams request.IDRequestParam
  20. // 更新使用的请求参数,注意是WithID类型
  21. UpdateJsonBody request.IDRequestParam
  22. // 查询使用的请求参数,注意是Query类型
  23. QueryQueryParams request.QueryRequestParams
  24. // 根据ID查询使用的请求参数,注意是WithID类型
  25. GetByIDQueryParams request.IDRequestParam
  26. // 可选配置项,通过WithXXX配置
  27. globalOptions *GlobalOptions
  28. createOptions *CreateOptions
  29. deleteOptions *DeleteOptions
  30. updateOptions *UpdateOptions
  31. queryOptions *QueryOptions[I]
  32. getByIDOptions *GetByIDOptions[I]
  33. }
  34. func (simple *Simple[I]) bind(binder *binding.Binder) {
  35. globalOptions := simple.globalOptions
  36. createOptions := simple.createOptions
  37. deleteOptions := simple.deleteOptions
  38. updateOptions := simple.updateOptions
  39. queryOptions := simple.queryOptions
  40. getByIDOptions := simple.getByIDOptions
  41. tableName := domain.TableName(simple.Schema, simple.Entity)
  42. domainPath := domain.RelativeDomainPath(simple.Entity)
  43. // 创建
  44. if !createOptions.disable {
  45. createMiddlewares := append(globalOptions.middlewares, createOptions.middlewares...)
  46. binding.PostBind[string](binder, &binding.SimpleBindItem[string]{
  47. Path: domainPath + "/create",
  48. SendResponseFunc: response.SendIDResponse,
  49. RequestParams: simple.CreateJsonBody,
  50. Objects: []domain.Object{simple.Entity},
  51. ServiceFunc: Create(tableName, createOptions.needCreateUserID, createOptions.callbacks, createOptions.needTx),
  52. }, createMiddlewares...)
  53. }
  54. // 删除
  55. if !deleteOptions.disable {
  56. deleteMiddlewares := append(globalOptions.middlewares, deleteOptions.middlewares...)
  57. binding.DeleteBind(binder, &binding.SimpleBindItem[any]{
  58. Path: domainPath + "/delete",
  59. SendResponseFunc: response.SendMsgResponse,
  60. RequestParams: simple.DeleteQueryParams,
  61. Objects: []domain.Object{simple.Entity},
  62. ServiceFunc: Delete(tableName, deleteOptions.callbacks, deleteOptions.needTx, globalOptions.scopeFields...),
  63. }, deleteMiddlewares...)
  64. }
  65. // 修改
  66. if !updateOptions.disable {
  67. updateMiddlewares := append(globalOptions.middlewares, updateOptions.middlewares...)
  68. binding.PutBind(binder, &binding.SimpleBindItem[any]{
  69. Path: domainPath + "/update",
  70. SendResponseFunc: response.SendMsgResponse,
  71. RequestParams: simple.UpdateJsonBody,
  72. Objects: []domain.Object{simple.Entity},
  73. ServiceFunc: Update(tableName, updateOptions.needLastUpdateUserID, updateOptions.callbacks, updateOptions.needTx, globalOptions.scopeFields...),
  74. }, updateMiddlewares...)
  75. }
  76. // 查询
  77. if !queryOptions.disable {
  78. queryMiddlewares := append(globalOptions.middlewares, queryOptions.middlewares...)
  79. binding.GetBind(binder, &binding.SimpleBindItem[response.InfosData[I]]{
  80. Path: domainPath + "/query",
  81. SendResponseFunc: response.SendInfosResponse[I],
  82. RequestParams: simple.QueryQueryParams,
  83. Objects: []domain.Object{simple.Entity},
  84. ServiceFunc: Query[I](tableName, queryOptions.orderBy, queryOptions.stringFieldQueryCondition,
  85. queryOptions.customStringFieldQueryCondition, queryOptions.callbacks, queryOptions.conditionFieldCallback, queryOptions.formCustomConditionFunc),
  86. }, queryMiddlewares...)
  87. }
  88. // 通过ID获取
  89. if !getByIDOptions.disable {
  90. getByIDMiddlewares := append(globalOptions.middlewares, getByIDOptions.middlewares...)
  91. binding.GetBind(binder, &binding.SimpleBindItem[I]{
  92. Path: domainPath + "/get",
  93. SendResponseFunc: response.SendInfoResponse[I],
  94. RequestParams: simple.GetByIDQueryParams,
  95. Objects: []domain.Object{simple.Entity},
  96. ServiceFunc: GetByID[I](tableName, getByIDOptions.callbacks),
  97. }, getByIDMiddlewares...)
  98. }
  99. }
  100. func BindSimple[I any](binder *binding.Binder, simple *Simple[I], opts ...any) {
  101. globalOptions := new(GlobalOptions)
  102. createOptions := new(CreateOptions)
  103. deleteOptions := new(DeleteOptions)
  104. updateOptions := new(UpdateOptions)
  105. queryOptions := new(QueryOptions[I])
  106. getByIDOptions := new(GetByIDOptions[I])
  107. for _, opt := range opts {
  108. switch o := opt.(type) {
  109. case GlobalOption:
  110. o(globalOptions)
  111. case CreateOption:
  112. o(createOptions)
  113. case DeleteOption:
  114. o(deleteOptions)
  115. case UpdateOption:
  116. o(updateOptions)
  117. case QueryOption[I]:
  118. o(queryOptions)
  119. case GetByIDOption[I]:
  120. o(getByIDOptions)
  121. default:
  122. continue
  123. }
  124. }
  125. simple.globalOptions = globalOptions
  126. simple.createOptions = createOptions
  127. simple.deleteOptions = deleteOptions
  128. simple.updateOptions = updateOptions
  129. simple.queryOptions = queryOptions
  130. simple.getByIDOptions = getByIDOptions
  131. simple.bind(binder)
  132. }
  133. type GlobalOption func(options *GlobalOptions)
  134. type CreateOption func(options *CreateOptions)
  135. type DeleteOption func(options *DeleteOptions)
  136. type UpdateOption func(options *UpdateOptions)
  137. type QueryOption[I any] func(options *QueryOptions[I])
  138. type GetByIDOption[I any] func(options *GetByIDOptions[I])
  139. type GlobalOptions struct {
  140. middlewares []binding.Middleware
  141. scopeFields []string
  142. }
  143. type CreateOptions struct {
  144. // 关闭创建
  145. disable bool
  146. // 创建是否使用事务
  147. needTx bool
  148. // 创建需要创建用户ID
  149. needCreateUserID bool
  150. // 创建回调
  151. callbacks *CreateCallbacks
  152. // 创建中间件
  153. middlewares []binding.Middleware
  154. }
  155. type DeleteOptions struct {
  156. // 关闭删除
  157. disable bool
  158. // 删除是否使用事务
  159. needTx bool
  160. // 删除回调
  161. callbacks *DeleteCallbacks
  162. // 删除中间件
  163. middlewares []binding.Middleware
  164. }
  165. type UpdateOptions struct {
  166. // 关闭更新
  167. disable bool
  168. // 更新是否使用事务
  169. needTx bool
  170. // 更新需要最新更新用户ID
  171. needLastUpdateUserID bool
  172. // 更新回调
  173. callbacks *UpdateCallbacks
  174. // 更新中间件
  175. middlewares []binding.Middleware
  176. }
  177. const (
  178. StringFieldQueryConditionEqual = "equal"
  179. StringFieldQueryConditionTrimSpaceEqual = "trim-space-equal"
  180. StringFieldQueryConditionLike = "like"
  181. StringFieldQueryConditionTrimSpaceLike = "trim-space-like"
  182. )
  183. type QueryOptions[I any] struct {
  184. // 关闭查询
  185. disable bool
  186. // 查询条件构造回调
  187. conditionFieldCallback ConditionFieldCallback
  188. // 自定义添加构造函数
  189. formCustomConditionFunc FormCustomConditionFunc
  190. // 查询回调
  191. callbacks *QueryCallbacks[I]
  192. // 查询中间件
  193. middlewares []binding.Middleware
  194. // OrderBy
  195. orderBy string
  196. // 字符串类型字段使用的查询条件
  197. stringFieldQueryCondition string
  198. // 自定义字符串类型字段使用的查询条件,会覆盖stringFieldQueryCondition的设置
  199. customStringFieldQueryCondition map[string]string
  200. }
  201. type GetByIDOptions[I any] struct {
  202. // 关闭根据ID查询
  203. disable bool
  204. // 根据ID查询回调
  205. callbacks *GetByIDCallbacks[I]
  206. // 根据ID查询中间件
  207. middlewares []binding.Middleware
  208. }
  209. func WithGlobalMiddlewares(middlewares ...binding.Middleware) GlobalOption {
  210. return func(options *GlobalOptions) {
  211. options.middlewares = middlewares
  212. }
  213. }
  214. func WithGlobalScopeFields(scopeFields ...string) GlobalOption {
  215. return func(options *GlobalOptions) {
  216. options.scopeFields = scopeFields
  217. }
  218. }
  219. func WithDisableCreate() CreateOption {
  220. return func(options *CreateOptions) {
  221. options.disable = true
  222. }
  223. }
  224. func WithCreateTx() CreateOption {
  225. return func(options *CreateOptions) {
  226. options.needTx = true
  227. }
  228. }
  229. func WithCreateUserID() CreateOption {
  230. return func(options *CreateOptions) {
  231. options.needCreateUserID = true
  232. }
  233. }
  234. func WithCreateCallbacks(callbacks *CreateCallbacks) CreateOption {
  235. return func(options *CreateOptions) {
  236. options.callbacks = callbacks
  237. }
  238. }
  239. func WithCreateMiddlewares(middlewares ...binding.Middleware) CreateOption {
  240. return func(options *CreateOptions) {
  241. options.middlewares = middlewares
  242. }
  243. }
  244. func WithDisableDelete() DeleteOption {
  245. return func(options *DeleteOptions) {
  246. options.disable = true
  247. }
  248. }
  249. func WithDeleteTx() DeleteOption {
  250. return func(options *DeleteOptions) {
  251. options.needTx = true
  252. }
  253. }
  254. func WithDeleteCallbacks(callbacks *DeleteCallbacks) DeleteOption {
  255. return func(options *DeleteOptions) {
  256. options.callbacks = callbacks
  257. }
  258. }
  259. func WithDeleteMiddlewares(middlewares ...binding.Middleware) DeleteOption {
  260. return func(options *DeleteOptions) {
  261. options.middlewares = middlewares
  262. }
  263. }
  264. func WithDisableUpdate() UpdateOption {
  265. return func(options *UpdateOptions) {
  266. options.disable = true
  267. }
  268. }
  269. func WithUpdateTx() UpdateOption {
  270. return func(options *UpdateOptions) {
  271. options.needTx = true
  272. }
  273. }
  274. func WithLastUpdateUserID() UpdateOption {
  275. return func(options *UpdateOptions) {
  276. options.needLastUpdateUserID = true
  277. }
  278. }
  279. func WithUpdateCallbacks(callbacks *UpdateCallbacks) UpdateOption {
  280. return func(options *UpdateOptions) {
  281. options.callbacks = callbacks
  282. }
  283. }
  284. func WithUpdateMiddlewares(middlewares ...binding.Middleware) UpdateOption {
  285. return func(options *UpdateOptions) {
  286. options.middlewares = middlewares
  287. }
  288. }
  289. func WithDisableQuery[I any]() QueryOption[I] {
  290. return func(options *QueryOptions[I]) {
  291. options.disable = true
  292. }
  293. }
  294. func WithQueryConditionFieldCallback[I any](callback ConditionFieldCallback) QueryOption[I] {
  295. return func(options *QueryOptions[I]) {
  296. options.conditionFieldCallback = callback
  297. }
  298. }
  299. func WithQueryFormCustomConditionFunc[I any](formCustomConditionFunc FormCustomConditionFunc) QueryOption[I] {
  300. return func(options *QueryOptions[I]) {
  301. options.formCustomConditionFunc = formCustomConditionFunc
  302. }
  303. }
  304. func WithQueryCallbacks[I any](callbacks *QueryCallbacks[I]) QueryOption[I] {
  305. return func(options *QueryOptions[I]) {
  306. options.callbacks = callbacks
  307. }
  308. }
  309. func WithQueryMiddlewares[I any](middlewares ...binding.Middleware) QueryOption[I] {
  310. return func(options *QueryOptions[I]) {
  311. options.middlewares = middlewares
  312. }
  313. }
  314. func WithQueryOrderBy[I any](orderBy string) QueryOption[I] {
  315. return func(options *QueryOptions[I]) {
  316. options.orderBy = orderBy
  317. }
  318. }
  319. func WithQueryStringFieldQueryCondition[I any](queryCondition string) QueryOption[I] {
  320. return func(options *QueryOptions[I]) {
  321. options.stringFieldQueryCondition = queryCondition
  322. }
  323. }
  324. func WithQueryCustomStringFieldQueryCondition[I any](customStringFieldQueryCondition map[string]string) QueryOption[I] {
  325. return func(options *QueryOptions[I]) {
  326. options.customStringFieldQueryCondition = customStringFieldQueryCondition
  327. }
  328. }
  329. func WithDisableGetByID[I any]() GetByIDOption[I] {
  330. return func(options *GetByIDOptions[I]) {
  331. options.disable = true
  332. }
  333. }
  334. func WithGetByIDCallbacks[I any](callbacks *GetByIDCallbacks[I]) GetByIDOption[I] {
  335. return func(options *GetByIDOptions[I]) {
  336. options.callbacks = callbacks
  337. }
  338. }
  339. func WithGetByIDMiddlewares[I any](middlewares ...binding.Middleware) GetByIDOption[I] {
  340. return func(options *GetByIDOptions[I]) {
  341. options.middlewares = middlewares
  342. }
  343. }