WMS_MAIN/temp/docs/model_cleanup_list.md

8.2 KiB
Raw Blame History

model_cleanup_list

更新时间: 2026-03-23 阶段: 5.4 模型边界规则固化与门禁脚本接入(已执行)

1. 盘点结论

  • 扫描范围: app/model/**/*.js
  • 检出方法总数: 102(实例 + 静态)
  • 高优先候选(应迁移到 service): 24
  • 低风险可移除候选(当前未发现业务调用): 18
  • 保留在模型层(轻量领域判断/展示映射): 22

说明:

  • 本次调用扫描采用“静态方法名精确匹配”策略(Model.method(...))。
  • 对“应迁移”项,目标是把跨表编排、状态机、批量事务、库存分配等逻辑从 model 剥离到 systems service。

2. 第一批应迁移(P1)

2.1 入库单聚合与状态流转

  • 文件: app/model/entry_order.js
  • 候选方法:
    • findByOrderCode
    • findByStatus
    • getStatsByWarehouse
    • updateSyncStatus
    • updateOrderStatus
    • calculateReceivedQuantities
  • 迁移目标:
    • app/service/systems/entry_order.js
  • 原因:
    • 含分页查询、跨表 include、状态流转约束、聚合统计,属于业务编排而非数据映射。

2.2 入库明细批量更新与进度汇总

  • 文件: app/model/entry_items.js
  • 候选方法:
    • batchUpdateReceived
    • getOrderProgress
  • 迁移目标:
    • app/service/systems/entry_order.js(或 app/service/systems/storage/receiving.js)
  • 原因:
    • 含事务控制、批量更新和跨记录校验,属于服务层职责。

2.3 库存分配/锁定编排

  • 文件: app/model/storage.js
  • 候选方法:
    • updateQuantity
    • lockQuantity
    • unlockQuantity
    • allocateQuantity
    • getStockSummary
    • getSpaceUsage
    • findByStockAndBatch
    • findBySpace
    • findAvailableByWarehouse
    • findExpiringSoon
  • 迁移目标:
    • app/service/systems/stock_store.js
    • app/service/systems/storage/receiving.js
  • 原因:
    • 涉及库存扣减/锁定语义、聚合统计和业务筛选,属于库存域服务。

2.4 角色权限写入与查询编排

  • 文件: app/model/role.js
  • 候选方法:
    • assignPermissions
    • getPermissionTree
    • getPermissionIds
  • 文件: app/model/role_permission.js
  • 候选方法:
    • bulkAssign
    • clearRolePermissions
    • getRolePermissions
    • hasPermission
  • 迁移目标:
    • app/service/systems/auth/user.js
    • 新增 app/service/systems/auth/role_permission.js(推荐)
  • 原因:
    • 包含权限关系写操作、树构建和权限判定,应集中在鉴权服务边界。

2.5 商家数据校验与查询助手

  • 文件: app/model/store.js
  • 候选方法:
    • validateStoreData
    • checkCompanyNameExists
    • findByAccountId
    • findAllEnabled
    • findAllWarehouses
  • 迁移目标:
    • app/service/systems/store.js
  • 原因:
    • 请求参数校验和查询策略属于服务层,不应下沉到 model。

3. 可移除候选(P2,先验证后删)

  • 已执行(第一批):

    • app/model/api_app.js: findByAppKey、findByQimenConfig(已删除)
    • app/model/interface_type.js: findByCode、findEnabled(已删除)
    • app/model/print_item.js: getGroupFields、getTableConfigs(已删除)
    • 门禁结果: compare mismatch=0,generated regression + smoke=14 passing
  • app/model/i18n_translation.js:

    • getTranslation
    • batchGetTranslations
    • getProjectTranslations
    • upsertTranslation
    • getUntranslated
  • app/model/interface_type.js:

    • findByCode
    • findEnabled
  • app/model/print_item.js:

    • getGroupFields
    • getTableConfigs
  • app/model/api_app.js:

    • findByAppKey
    • findByQimenConfig
  • app/model/stock_store.js:

    • findByItemCode
    • findByStore

说明:

  • 上述方法本轮未检出业务层调用,建议先完成一次“删除前引用复核”再执行清理。

4. 保留在模型层(P3)

建议保留:

  • 轻量实例判断(isEnabled/isHidden/isExpired 等)。
  • 纯格式/展示映射(getTypeName/getRoleTypeName/getScopeName)。
  • 与关联语义绑定的 include 构造器(StoreWarehouse.buildStoreStockInclude)。

5. 阶段状态(截至 2026-03-23)

  1. 已完成 P1 四组迁移(EntryOrder/EntryItems、Storage、Role/RolePermission、Store)到 service。
  2. 已完成 P2 第二批清理(I18nTranslation / StockStore),并通过门禁。
  3. 已完成 5.3:完成 hooks/scopes/virtual fields 全量盘点并形成规则。
  4. 已完成 5.4:新增可执行门禁脚本并接入 npm/CI。

6. 已执行(P2 第二批)

  • 执行时间: 2026-03-23
  • 删除范围:
    • app/model/i18n_translation.js
    • app/model/stock_store.js
  • 删除方法:
    • I18nTranslation.getTranslation
    • I18nTranslation.batchGetTranslations
    • I18nTranslation.getProjectTranslations
    • I18nTranslation.upsertTranslation
    • I18nTranslation.getUntranslated
    • StockStore.findByItemCode
    • StockStore.findByStore
  • 门禁结果:
    • compare mismatch=0
    • generated regression=8 passing
    • smoke=6 passing
    • tests=14 passing

7. 已执行(P1 第一组)

  • 执行时间: 2026-03-23
  • 迁移范围:
    • app/model/entry_order.js
    • app/model/entry_items.js
    • app/service/systems/entry_order.js
  • 迁移方法:
    • EntryOrder.findByOrderCode
    • EntryOrder.findByStatus
    • EntryOrder.getStatsByWarehouse
    • EntryOrder.updateSyncStatus
    • EntryOrder.updateOrderStatus
    • EntryOrder.calculateReceivedQuantities
    • EntryItems.batchUpdateReceived
    • EntryItems.getOrderProgress
  • 门禁结果:
    • compare mismatch=0
    • generated regression=8 passing
    • smoke=6 passing
    • tests=14 passing

8. 已执行(P1 第二组)

  • 执行时间: 2026-03-23
  • 迁移范围:
    • app/model/storage.js
    • app/service/systems/storage/index.js
  • 迁移方法:
    • Storage.findByStockAndBatch
    • Storage.findBySpace
    • Storage.findAvailableByWarehouse
    • Storage.findExpiringSoon
    • Storage.updateQuantity
    • Storage.lockQuantity
    • Storage.unlockQuantity
    • Storage.allocateQuantity
    • Storage.getStockSummary
    • Storage.getSpaceUsage
  • 门禁结果:
    • compare mismatch=0
    • generated regression=8 passing
    • smoke=7 passing
    • tests=15 passing

9. 已执行(P1 第三组)

  • 执行时间: 2026-03-23
  • 迁移范围:
    • app/model/role.js
    • app/model/role_permission.js
    • app/service/systems/auth/role_permission.js
  • 迁移方法:
    • Role.assignPermissions
    • Role.getPermissionTree
    • Role.getPermissionIds
    • RolePermission.bulkAssign
    • RolePermission.clearRolePermissions
    • RolePermission.getRolePermissions
    • RolePermission.hasPermission
  • 门禁结果:
    • compare mismatch=0
    • generated regression=8 passing
    • smoke=7 passing
    • tests=15 passing

10. 已执行(P1 第四组)

  • 执行时间: 2026-03-23
  • 迁移范围:
    • app/model/store.js
    • app/service/systems/store.js
  • 迁移方法:
    • Store.validateStoreData
    • Store.checkCompanyNameExists
    • Store.findByAccountId
    • Store.findAllEnabled
    • Store.findAllWarehouses
  • 门禁结果:
    • compare mismatch=0
    • generated regression=8 passing
    • smoke=7 passing
    • tests=15 passing

11. 已执行(5.3 边界规范)

  • 执行时间: 2026-03-23
  • 扫描范围:
    • app/model/**/*.js
  • 扫描结果:
    • hooks: 2 处(EntryItems.beforeSave / EntryItems.beforeUpdate)
    • scopes: 1 处定义(PrintItem.scopes)
    • virtual fields: 0
  • 产出文档:
    • model_boundary_rules.md
  • 执行结论:
    • 现有 hooks/scopes 均符合“单行一致性校验/静态筛选片段”边界。
    • 后续新增或修改模型逻辑时,按 model_boundary_rules.md 作为合入门禁。

12. 已执行(5.4 门禁脚本验证)

  • 执行时间: 2026-03-23
  • 执行命令:
    • npm run check:model-boundary
  • 结果摘要:
    • [MODEL-BOUNDARY] files=45
    • [MODEL-BOUNDARY] hooks=2
    • [MODEL-BOUNDARY] scopeFiles=1
    • [MODEL-BOUNDARY] virtualLines=0
    • [MODEL-BOUNDARY] PASS
  • 结论:
    • 模型边界检查脚本可稳定执行,已具备本地与 CI 统一门禁能力。

13. 已执行(5.4 门禁固化)

  • 执行时间: 2026-03-23
  • 新增脚本:
    • script/model-boundary-check.cjs
  • 覆盖规则:
    • 禁止 model 直接调用 service
    • 禁止 model 外部 HTTP 调用
    • 禁止 model 读写 Redis/缓存
    • 禁止 model 通过 ctx.model 进行跨模型编排
    • 禁止 model 定义事务控制逻辑
    • hooks/scopes/virtual 使用 allowlist 准入
  • 接入方式:
    • npm run check:model-boundary
    • npm run ci(已串联)
  • 执行结论:
    • 模型层边界已具备自动化门禁能力,后续新增越界代码可在本地与 CI 及时阻断。