crud.go 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342
  1. package rest
  2. import (
  3. "context"
  4. "fmt"
  5. "git.nspix.com/golang/micro/gateway/http"
  6. "git.nspix.com/golang/micro/log"
  7. "git.nspix.com/golang/rest/v2/pkg/logger"
  8. "gorm.io/driver/mysql"
  9. "gorm.io/driver/sqlite"
  10. "gorm.io/gorm"
  11. "reflect"
  12. "sync"
  13. )
  14. type (
  15. CRUD struct {
  16. db *gorm.DB
  17. entities sync.Map
  18. httpSvr *http.Server
  19. httpMiddleware []http.Middleware
  20. callback *Callback
  21. }
  22. treeValue struct {
  23. Label string `json:"label"`
  24. Value string `json:"value"`
  25. Children []*treeValue `json:"children"`
  26. }
  27. contextKey struct{}
  28. )
  29. var (
  30. ctxKey = contextKey{}
  31. )
  32. func (t *treeValue) Append(v *treeValue) {
  33. if t.Children == nil {
  34. t.Children = make([]*treeValue, 0)
  35. }
  36. t.Children = append(t.Children, v)
  37. }
  38. //DB 获取当前数据库实例
  39. func (crud *CRUD) DB() *gorm.DB {
  40. return crud.db
  41. }
  42. //WithDB 设置当前数据库实例
  43. func (crud *CRUD) WithDB(db *gorm.DB) {
  44. crud.db = db
  45. }
  46. //Callback 获取回调管理器
  47. func (crud *CRUD) Callback() *Callback {
  48. return crud.callback
  49. }
  50. //handleQueryCrudModules 处理
  51. func (crud *CRUD) handleQueryCrudModules(ctx *http.Context) (err error) {
  52. ts := make([]*treeValue, 0)
  53. crud.entities.Range(func(key, value interface{}) bool {
  54. e := value.(*Entity)
  55. for _, tv := range ts {
  56. if tv.Value == e.model.ModuleName() {
  57. tv.Append(&treeValue{Value: e.model.ModuleName() + "-" + e.model.TableName(), Label: e.model.TableName()})
  58. return true
  59. }
  60. }
  61. tv := &treeValue{Label: e.model.ModuleName(), Value: e.model.ModuleName()}
  62. tv.Append(&treeValue{Value: e.model.ModuleName() + "-" + e.model.TableName(), Label: e.model.TableName()})
  63. ts = append(ts, tv)
  64. return true
  65. })
  66. return ctx.Success(ts)
  67. }
  68. //handleQuerySchema 处理http查询schema请求
  69. func (crud *CRUD) handleQuerySchema(ctx *http.Context) (err error) {
  70. var (
  71. schemas []*Schema
  72. modelEntity *Entity
  73. )
  74. moduleName := ctx.ParamValue("module")
  75. tableName := ctx.ParamValue("table")
  76. crud.entities.Range(func(key, value interface{}) bool {
  77. entity := value.(*Entity)
  78. if entity.model.ModuleName() == moduleName {
  79. if entity.model.TableName() == tableName {
  80. modelEntity = entity
  81. return false
  82. }
  83. if entity.opts.RemoveTablePrefix {
  84. for _, prefix := range entity.opts.TablePrefixes {
  85. if prefix+tableName == entity.model.TableName() {
  86. modelEntity = entity
  87. return false
  88. }
  89. }
  90. }
  91. }
  92. return true
  93. })
  94. if modelEntity == nil {
  95. return ctx.Error(10011, fmt.Sprintf("module %s table %s schema not found", moduleName, tableName))
  96. }
  97. if schemas, err = getSchemasNoCache(crud.db, ctx.ParamValue(NamespaceVariable), modelEntity.model.ModuleName(), modelEntity.model.TableName()); err == nil {
  98. return ctx.Success(schemas)
  99. }
  100. return ctx.Error(10011, err.Error())
  101. }
  102. //handleSaveSchema 保存schema
  103. func (crud *CRUD) handleSaveSchema(ctx *http.Context) (err error) {
  104. var (
  105. modelEntity *Entity
  106. )
  107. moduleName := ctx.ParamValue("module")
  108. tableName := ctx.ParamValue("table")
  109. crud.entities.Range(func(key, value interface{}) bool {
  110. entity := value.(*Entity)
  111. if entity.model.ModuleName() == moduleName {
  112. if entity.model.TableName() == tableName {
  113. modelEntity = entity
  114. return false
  115. }
  116. if entity.opts.RemoveTablePrefix {
  117. for _, prefix := range entity.opts.TablePrefixes {
  118. if prefix+tableName == entity.model.TableName() {
  119. modelEntity = entity
  120. return false
  121. }
  122. }
  123. }
  124. }
  125. return true
  126. })
  127. if modelEntity == nil {
  128. return ctx.Error(10011, fmt.Sprintf("module %s table %s schema not found", moduleName, tableName))
  129. }
  130. schemas := make([]*Schema, 0)
  131. if err = ctx.Bind(&schemas); err != nil {
  132. return ctx.Error(HttpInvalidPayload, err.Error())
  133. }
  134. if err = crud.db.Transaction(func(tx *gorm.DB) error {
  135. for _, scm := range schemas {
  136. if err2 := tx.Save(scm).Error; err2 != nil {
  137. return err2
  138. }
  139. }
  140. return nil
  141. }); err == nil {
  142. invalidCache(ctx.ParamValue(NamespaceVariable), modelEntity.model.ModuleName(), modelEntity.model.TableName())
  143. return ctx.Success(map[string]interface{}{
  144. "count": len(schemas),
  145. "state": "success",
  146. })
  147. }
  148. return ctx.Error(10014, err.Error())
  149. }
  150. //handleDeleteSchema 删除表的schema
  151. func (crud *CRUD) handleDeleteSchema(ctx *http.Context) (err error) {
  152. id := ctx.ParamValue("id")
  153. model := &Schema{}
  154. if err = crud.db.Where("id=?", id).First(model).Error; err == nil {
  155. invalidCache(ctx.ParamValue(NamespaceVariable), model.Module, model.Table)
  156. if err = crud.db.Where("id=?", id).Delete(&Schema{}).Error; err == nil {
  157. return ctx.Success(map[string]string{
  158. "id": id,
  159. "state": "success",
  160. })
  161. } else {
  162. return ctx.Error(10012, err.Error())
  163. }
  164. } else {
  165. return ctx.Error(10012, err.Error())
  166. }
  167. }
  168. //router 绑定路由
  169. func (crud *CRUD) router() {
  170. if crud.httpSvr == nil {
  171. return
  172. }
  173. //获取注册上来的模块
  174. crud.httpSvr.Handle("GET", "/crud/modules", crud.handleQueryCrudModules, crud.httpMiddleware...)
  175. //获取所有schema
  176. crud.httpSvr.Handle("GET", "/schema/:module/:table", crud.handleQuerySchema, crud.httpMiddleware...)
  177. //更新schema
  178. crud.httpSvr.Handle("POST", "/schema/:module/:table", crud.handleSaveSchema, crud.httpMiddleware...)
  179. //删除schema
  180. crud.httpSvr.Handle("DELETE", "/schema/:id", crud.handleDeleteSchema, crud.httpMiddleware...)
  181. }
  182. // Attach 附加一个模型数据
  183. func (crud *CRUD) Attach(model Model, ops ...Option) (err error) {
  184. opts := NewOptions()
  185. for _, op := range ops {
  186. op(opts)
  187. }
  188. if opts.DB == nil {
  189. opts.DB = crud.db
  190. }
  191. //auto migrate database struct
  192. if err = crud.db.AutoMigrate(model); err != nil {
  193. return
  194. }
  195. //migrate table schema
  196. if err = migrateUp("", model); err != nil {
  197. return
  198. }
  199. scenarios := model.Scenario()
  200. entity := newEntity(model, opts)
  201. entity.callback = crud.callback
  202. if len(scenarios) == 0 {
  203. entity.scenarios = []string{ScenarioList, ScenarioCreate, ScenarioUpdate, ScenarioDelete, ScenarioExport, ScenarioView}
  204. } else {
  205. entity.scenarios = model.Scenario()
  206. }
  207. crud.entities.Store(entity.ID(), entity)
  208. return
  209. }
  210. // Detach 删除一个模型数据
  211. func (crud *CRUD) Detach(model Model) {
  212. id := model.TableName() + "@" + model.ModuleName()
  213. crud.entities.Delete(id)
  214. }
  215. //Routes 生成增删改查的路由
  216. func (crud *CRUD) Routes(svr *http.Server, ms ...http.Middleware) {
  217. var (
  218. method string
  219. uri string
  220. )
  221. if crud.httpSvr == nil {
  222. crud.httpSvr = svr
  223. }
  224. if crud.httpSvr == nil {
  225. return
  226. }
  227. crud.httpMiddleware = ms
  228. crud.entities.Range(func(key, value interface{}) bool {
  229. entity := value.(*Entity)
  230. if entity.opts.Middleware == nil || len(entity.opts.Middleware) == 0 {
  231. entity.opts.Middleware = crud.httpMiddleware
  232. }
  233. for _, scenario := range entity.scenarios {
  234. method = entity.getScenarioMethod(scenario)
  235. uri = entity.getScenarioUrl(scenario)
  236. log.Debugf("CRUD: register %s %s", method, uri)
  237. crud.httpSvr.Handle(
  238. method,
  239. uri,
  240. entity.getScenarioHandle(scenario),
  241. entity.opts.Middleware...,
  242. )
  243. }
  244. //注册获取键值对数据格式
  245. if entity.isKvMapping() {
  246. crud.httpSvr.Handle("GET", entity.getScenarioUrl("mapping"), entity.getScenarioHandle("mapping"), entity.opts.Middleware...)
  247. }
  248. return true
  249. })
  250. crud.router()
  251. }
  252. //Schemas 获取一个模型的显示字段
  253. func (crud *CRUD) Schemas(namespace, moduleName, tableName, scenario string) []*Schema {
  254. if v, ok := crud.entities.Load(tableName + "@" + moduleName); ok {
  255. e := v.(*Entity)
  256. return visibleSchemas(namespace, e.model.ModuleName(), e.model.TableName(), scenario)
  257. }
  258. return nil
  259. }
  260. // IsNewRecord 判断该模型是不是一条新记录
  261. func (crud *CRUD) IsNewRecord(value reflect.Value, stmt *gorm.Statement) bool {
  262. for _, pf := range stmt.Schema.PrimaryFields {
  263. if _, isZero := pf.ValueOf(value); isZero {
  264. return true
  265. }
  266. }
  267. return false
  268. }
  269. //NewCRUD 创建一个新的CRUD模型
  270. func NewCRUD(db *gorm.DB, svr *http.Server) (crud *CRUD, err error) {
  271. if err = initSchema(db); err != nil {
  272. return
  273. }
  274. crud = &CRUD{
  275. db: db,
  276. callback: newCallback(),
  277. httpSvr: svr,
  278. }
  279. return
  280. }
  281. func openDatabase(cfg *Config) (db *gorm.DB, err error) {
  282. dbCfg := &gorm.Config{Logger: logger.NewGormLogger()}
  283. switch cfg.Driver {
  284. case "sqlite3":
  285. db, err = gorm.Open(sqlite.Open(cfg.ParseDSN()), dbCfg)
  286. case "mysql":
  287. db, err = gorm.Open(mysql.Open(cfg.ParseDSN()), dbCfg)
  288. default:
  289. err = fmt.Errorf("unsupported sql driver %s", cfg.Driver)
  290. }
  291. return
  292. }
  293. //Dialer 连接一个数据库
  294. func Dialer(cfg *Config) (crud *CRUD, err error) {
  295. var (
  296. db *gorm.DB
  297. )
  298. if db, err = openDatabase(cfg); err != nil {
  299. return
  300. }
  301. if err = initSchema(db); err != nil {
  302. return
  303. }
  304. crud = &CRUD{
  305. db: db,
  306. callback: newCallback(),
  307. }
  308. return
  309. }
  310. func FromContext(ctx context.Context) *CRUD {
  311. if v := ctx.Value(ctxKey); v != nil {
  312. return v.(*CRUD)
  313. }
  314. return nil
  315. }
  316. func WithContext(ctx context.Context, r *CRUD) context.Context {
  317. return context.WithValue(ctx, ctxKey, r)
  318. }