chore: commit current workspace changes

This commit is contained in:
liufumingren 2026-03-25 13:17:51 +08:00
parent ab26e1e8e7
commit 67c6856d75
25 changed files with 20 additions and 3084 deletions

View File

@ -6,8 +6,6 @@
- AI项目协作工具箱:`AI_TOOLBOX.md`
- Method 路由映射说明:`AI_METHOD_ROUTING.md`
- Model 层级清单:`temp/docs/modelList.md`
- Method 输出一致性回归记录:`temp/docs/METHOD_OUTPUT_REGRESSION_20260322.md`
- system 接口文档源:`methods/system.json`
- qimen 接口文档源:`methods/qimen.json`
- 日报:`day.log`
@ -40,7 +38,6 @@
- `README.md`:项目入口文档,提供整体说明与规范入口。
- `AI_TOOLBOX.md`:AI/开发协作操作手册,包含脚本与工作流。
- `AI_METHOD_ROUTING.md`:接口入口与 method 到代码文件的映射。
- `temp/docs/modelList.md`:model 层级结构与关键说明清单。
- `methods/system.json`:system 接口定义(headers、groups、params、response、errors)。
- `methods/qimen.json`:qimen 接口定义(按奇门协议组织)。
- `day.log`:每日工作留痕。

BIN
day.log

Binary file not shown.

View File

@ -1,135 +1,23 @@
Model 重构总计划(数据库 + Migrations + Models)
更新时间: 2026-03-23
当前状态: 执行中(阶段 1-5 已完成,阶段 6 进行中)
负责人:
目标截止时间:
执行分支:
Model 重构总计划(已完成归档)
更新时间: 2026-03-25
当前状态: 已完成
[事务归属]
- 本子事务已纳入 `todo.txt` 总事务看板统一管理。
- 主里程碑对齐总事务 DDL(2026-04-15),以总事务验收为最终关闭条件。
[最终目标]
- 梳理数据库中所有表结构并形成统一基线。
- 补全并对齐 database/migrations 目录下的迁移文件。
- 规范所有 model 的命名与内部关联。
- 清理所有 model 内部能力(移除死代码、职责收敛、保持模型层可预测)。
[完成状态]
- [x] 阶段 1: 全量盘点与基线建立
- [x] 阶段 2: Migration 补全与执行顺序设计
- [x] 阶段 3: Model 命名规范化
- [x] 阶段 4: 关联关系规范化
- [x] 阶段 5: Model 内部能力清理
- [x] 阶段 6: 验证与交接
[执行规则]
- [x] 本文件用于规划拆解,已完成初始化。
- [x] 已收到新任务,开始执行阶段 1。
- [x] 进入代码改动前,先核对目标 service 的真实调用链。
- [x] 若 service 已被 system/qimen 入口使用,则必须同步更新对应 API 文档。
- [x] 所有联动修改需记录到 temp/docs/SERVICE_API_CHANGE_AUDIT_20260322.md,便于后续复盘。
- [x] 任何模型/关联改动前,使用测试账号执行 method 基线回放(配置与样本来源必须可追溯)。
- [x] 任何模型/关联改动后,执行同一批 method 对比回放并输出比对报告。
- [x] 新增交付条件:修改前后 method 输出结果一致(允许仅屏蔽 token/timestamp 等波动字段)。
- [x] 后续所有接口返回数据检测,统一使用“自动生成的 Egg.js 标注测试脚本”执行校验。
[收口说明]
- [x] 本文件由执行计划切换为归档摘要,不再保留阶段性过程清单。
- [x] 本任务相关临时文档已从 `temp/docs/` 清理。
- [x] 本任务相关临时中间文件已从 `temp/` 清理。
- [x] README 中对已清理临时文档的入口已移除。
[阶段 1: 全量盘点与基线建立]
- [x] 1.1 盘点所有数据表(字段、主键、索引、约束、注释)。
- [x] 1.2 盘点所有 model 文件(app/model 下文件、导出名、表映射)。
- [x] 1.3 盘点 model 关联(belongsTo/hasMany/hasOne/belongsToMany 与外键使用)。
- [x] 1.4 产出 DB 结构与 model 定义差异报告。
- [x] 1.5 在根目录生成 temp/docs/modelList.md,构建 model 层级结构与说明。
- [x] 1.6 在 README.md 增加对 temp/docs/modelList.md 的引用说明。
交付物:
- temp/docs/table_schema_inventory.md
- temp/docs/model_inventory.md
- temp/docs/model_association_inventory.md
- temp/docs/schema_model_gap_report.md
- temp/docs/modelList.md
退出标准:
- 100% 数据表与 100% model 文件覆盖完成。
- temp/docs/modelList.md 可用于快速定位模型层级与职责。
[阶段 2: Migration 补全与执行顺序设计]
- [x] 2.1 审核现有 database/migrations 的命名、顺序、幂等性。
- [x] 2.2 根据阶段 1 差异清单补齐缺失迁移任务。
- [x] 2.3 设计迁移执行顺序(先结构后索引/约束,必要时分批回填数据)。
- [x] 2.4 为每个迁移定义可执行回滚步骤。
- [x] 2.5 形成 local/test 环境演练方案。
交付物:
- temp/docs/migration_gap_list.md
- temp/docs/migration_execution_plan.md
- temp/docs/rollback_plan.md
退出标准:
- 每个结构差异都有明确迁移归属与回滚路径。
[阶段 3: Model 命名规范化]
- [x] 3.1 定义命名规范(文件名、类名、model key、表映射、alias)。
- [x] 3.2 产出非规范命名的重命名映射表。
- [x] 3.3 评估跨层影响(service/controller/query 调用点)。
- [x] 3.4 制定兼容策略(临时别名或分批重命名)。
交付物:
- temp/docs/model_naming_standard.md
- temp/docs/model_rename_map.md
- temp/docs/rename_impact_report.md
退出标准:
- 所有命名不规范项有明确修复路径与影响说明。
[阶段 4: 关联关系规范化]
- [x] 4.1 逐项校验关联定义与真实外键关系一致性(详见 temp/docs/association_fk_consistency_report.md)。
- [x] 4.2 统一 alias 命名与双向关联完整性。
- [x] 4.3 清理重复或冲突关联。
- [x] 4.4 形成 eager-loading 与 N+1 风险规约(详见 temp/docs/association_eager_loading_n_plus_one_guideline.md)。
交付物:
- temp/docs/association_fix_plan.md
- temp/docs/association_validation_checklist.md
退出标准:
- 关联关系可预测、无冲突、与数据库关系一致。
[阶段 5: Model 内部能力清理]
- [x] 5.1 识别应迁移到 service 层的方法能力(见 temp/docs/model_cleanup_list.md 第一批清单)。
- [x] 5.2 清理 model 内死代码与调试代码(已完成:P2 两批无调用静态方法清理 + P1 四组方法迁移并回收 model 同名方法)。
- [x] 5.3 规范 hooks/scopes/virtual fields 的使用边界(盘点完成并已产出 temp/docs/model_boundary_rules.md)。
- [x] 5.4 固化模型层边界规则(新增 script/model-boundary-check.cjs 并接入 npm run check:model-boundary)。
交付物:
- temp/docs/model_cleanup_list.md
- temp/docs/model_boundary_rules.md
退出标准:
- 模型层聚焦于数据映射与轻量领域行为,职责边界清晰。
[阶段 6: 验证与交接]
- [ ] 6.1 在干净库上回放 migration 全流程。
- [ ] 6.2 验证 model CRUD 与关联查询正确性。
- [ ] 6.3 执行关键 API 冒烟回归(包含 method-output 基线/对比)。
- [ ] 6.4 更新最终文档(README + methods + 内部交接文档)。
交付物:
- verification_report.md
- handover_notes.md
退出标准:
- 无迁移漂移、无关联错配、无阻断回归问题。
[风险]
- 历史遗留表或隐式依赖未被识别。
- 环境间数据漂移导致验证结果不一致。
- 命名调整引发跨层调用副作用。
[依赖]
- 稳定可访问的数据库环境(盘点与验证)。
- 统一确认的命名与关联规范。
- 可执行的迁移窗口与回滚窗口。
[下一步]
- 阶段 4 的 4.1-4.4 已完成(含 receiving 第一批收敛与 N+1/eager-loading 规约落地)。
- 高优先差异项推进: 已完成 store_warehouse/stock_warehouse 第二批收敛(stock_store include 语义约束补齐),并通过门禁。
- 高优先差异项推进: 已完成 role / role_permission / permission 第三批收敛(启用状态过滤 + 去重),并通过门禁。
- 已完成“DB 约束补齐”执行: `wms_role_permission.permission_id -> wms_permission.id` 外键已生效,SequelizeMeta 已登记 `20260323103000-align-role-permission-fk.js`。
- 已完成数据清洗与备份: 4 条 permission 孤儿、3 条 role.store_id=0 哨兵数据均已处理(备份表见 `temp/docs/role_permission_fk_data_cleanup_plan.md`)。
- 已完成 `wms_role.store_id` 外键策略落地:外键 `fk_wms_role_store` 已生效(ON DELETE SET NULL),SequelizeMeta 已登记 `20260323113000-add-role-store-fk.js`。
- 已完成 store_warehouse / stock_warehouse 模型层复合键语义治理(统一 include 构造器 + constraints:false 显式化)。
- 已完成阶段 4 收尾检查(第 1 项):全量 include alias 一致性扫描(service alias 与 model alias 差集=0)。
- 已完成阶段 4 收尾检查(第 2 项):permission.parent_id 自关联约束策略已落地(root=NULL + FK)。
- 已完成阶段 5.1:识别应迁移到 service 层的方法能力(第一批清单见 temp/docs/model_cleanup_list.md)。
- 已完成阶段 5.2 第一批 P2 清理:ApiApp / InterfaceType / PrintItem,门禁通过。
- 已完成阶段 5.2 第二批 P2 清理:I18nTranslation / StockStore,门禁通过。
- 已完成阶段 5.2 P1 第一组:EntryOrder / EntryItems 8 个方法迁移到 service 并回收 model 同名方法。
- 已完成阶段 5.2 P1 第二组:Storage 10 个方法迁移到 service 并回收 model 同名方法。
- 已完成阶段 5.2 P1 第三组:Role / RolePermission 7 个方法迁移到 service 并回收 model 同名方法。
- 已完成阶段 5.2 P1 第四组:Store 5 个方法迁移到 service 并回收 model 同名方法。
- 已完成阶段 5.3:hooks/scopes/virtual fields 边界盘点与规则固化(见 temp/docs/model_boundary_rules.md)。
- 已完成阶段 5.4:新增 model 边界检查脚本并接入 npm 命令与 CI(check:model-boundary)。
- 已复跑阶段 5.4 门禁命令:`npm run check:model-boundary`,结果 PASS(files=45, hooks=2, scopeFiles=1, virtualLines=0)。
- 过程门禁:compare mismatch=0;generated regression 与 smoke 持续通过;新增 model-boundary 检查门禁。
- 下一步进入阶段 6.1:在干净库上回放 migration 全流程。
[追溯方式]
- 需要查看过程细节时,优先使用 git 历史、`todo.txt` 总事务看板与 `versioning/` 本地版本记录。

View File

@ -111,7 +111,7 @@ function scanFile(filePath) {
relPath,
line: i + 1,
type: 'disallowed-hook',
message: '发现未登记的模型 hook,请先更新 temp/docs/model_boundary_rules.md 与 allowlist',
message: '发现未登记的模型 hook,请先更新模型边界规则与 allowlist',
content: line.trim(),
});
}
@ -124,7 +124,7 @@ function scanFile(filePath) {
relPath,
line: i + 1,
type: 'disallowed-scopes',
message: '发现未登记的 scopes 定义,请先更新 temp/docs/model_boundary_rules.md 与 allowlist',
message: '发现未登记的 scopes 定义,请先更新模型边界规则与 allowlist',
content: line.trim(),
});
}
@ -137,7 +137,7 @@ function scanFile(filePath) {
relPath,
line: i + 1,
type: 'disallowed-virtual-field',
message: '发现未登记的 virtual 字段定义,请先更新 temp/docs/model_boundary_rules.md 与 allowlist',
message: '发现未登记的 virtual 字段定义,请先更新模型边界规则与 allowlist',
content: line.trim(),
});
}

View File

@ -1,94 +0,0 @@
# Method 输出一致性回放说明
更新时间: 2026-03-22
## 1. 新交付条件
- 所有模型/关联相关改动,必须先执行 method 输出基线回放。
- 改动完成后,必须对同一批 method 执行 compare 回放。
- 交付标准: 修改前后 method 输出一致。
- 允许屏蔽波动字段: token、timestamp、last_login_at、created_at、updated_at、iat、exp。
## 2. 测试账号
- username: liufumingren
- password: 111111
## 3. 方法使用来源
- method 定义来源: methods/system.json
- 回放脚本会从该配置中读取 method 分组、描述、参数定义,作为样本元数据。
## 4. 测试数据来源
- 主来源表: wms_system_log
- 参考日志表:
- wms_api_log
- wms_operation_log
- wms_account_login_log
- 样本选择原则:
- 优先同账号(liufumingren)
- 优先只读方法(get/list/query/detail/info/stats)
- 优先较新数据(按日志 id 倒序)
- 优先方法去重
## 5. 执行脚本
脚本文件:
- script/method-output-regression.cjs
命令:
```powershell
# 修改前执行,生成基线
node .\script\method-output-regression.cjs baseline 8
# 修改后执行,对比输出
node .\script\method-output-regression.cjs compare
```
输出文件:
- temp/method-output/method-output-baseline.json
- temp/method-output/method-output-baseline.md
- temp/method-output/method-output-compare.json
## 6. 本次基线执行结果(修改前)
执行时间:
- baseline: 2026-03-22T13:56:52Z
- compare: 2026-03-22T13:56:57Z
样本数:
- 8
样本 method(来自 temp/method-output/method-output-baseline.md):
- storage.receiving.getReceivingDetail (sourceId: 10790)
- order.getOrderModels (sourceId: 10783)
- print.getList (sourceId: 10611)
- print.getComputerPrinter (sourceId: 10579)
- print.getItem (sourceId: 10578)
- print.getComputer (sourceId: 10577)
- store.getStoreRoles (sourceId: 10553)
- index.getExpressList (sourceId: 9820)
比对结果:
- total: 8
- mismatch: 0
- pass: true
说明:
- 当前样本中既包含 200 成功响应,也包含 403 权限响应。
- 403 响应同样纳入一致性校验范围(用于防止权限链路被意外改变)。
## 7. 后续执行要求
- 每次开始改动前,先运行 baseline 并保留输出文件。
- 每次改动后,必须运行 compare。
- 若 mismatch > 0,禁止进入交付,需先排查差异并补充说明。

View File

@ -1,791 +0,0 @@
# Service 使用与 API 文档联动审计
更新时间: 2026-03-22
适用阶段: Model 重构阶段 4 及后续代码改造
目的: 在修改 service 前,先确认真实使用链路;若 service 已被使用,则必须同步更新 service、对应 API 文档,并在本文件中记录变更,便于后续复盘。
## 1. 执行规则
- 任何计划修改的 service,必须先确认是否被 systemMethods、qimenMethods、controller 或其他 service 使用。
- 只要存在真实调用链,就不能只改底层 service,必须一起评估上游入口与返回结构。
- 对外暴露为 system/qimen method 的能力,必须同步更新 methods/system.json 或 methods/qimen.json。
- 每次实际修改完成后,必须在本文件末尾追加一条变更记录。
## 2. 本轮已确认的高风险 service 使用链路
### 2.1 账号-仓库-角色关联链路
#### A. app/service/systems/store.js
关键风险:
- 直接使用不存在的 ctx.model.AccountStoreRole。
- 影响门店申请审核、角色分配、角色列表查询。
已确认调用点:
- app/service/systems/store.js:464
- app/service/systems/store.js:679
- app/service/systems/store.js:690
上游 system method:
- app/service/systemMethods/store.js:35 -> store.getStoreRoles
- app/service/systemMethods/store.js:45 -> store.auditApply
对应 API 文档:
- methods/system.json:1976 -> store.getStoreRoles
- methods/system.json:1993 -> store.auditApply
联动要求:
- 若将 AccountStoreRole 收敛为 AccountStoreEmployee 或其他真实模型,必须同步更新:
- app/service/systems/store.js
- app/service/systemMethods/store.js
- methods/system.json 中 store.getStoreRoles / store.auditApply 的参数、返回结构描述
#### B. app/service/systems/auth/user.js
关键风险:
- 当前已部分切到 AccountStoreEmployee,但变量名和注释仍保留 accountStoreRole 旧语义。
- 平台激活逻辑会联动 user.login、user.info、user.changeRole。
已确认调用点:
- app/service/systems/auth/user.js:118 -> changeRole
- app/service/systems/auth/user.js:195 -> info
- app/service/systems/auth/user.js:328 -> findById
- app/service/systems/auth/user.js:877 -> ensurePlatformActiveRole
上游 system method:
- app/service/systemMethods/user.js:11 -> user.login
- app/service/systemMethods/user.js:24 -> user.info
- app/service/systemMethods/user.js:29 -> user.changeRole
对应 API 文档:
- methods/system.json:2016 附近 -> user.login
- methods/system.json:2051 附近 -> user.info
- methods/system.json:2067 附近 -> user.changeRole
联动要求:
- 若修改 activeEmployeeId、employee_id、role_id、roles 列表结构,必须同步更新:
- app/service/systems/auth/user.js
- app/service/systemMethods/user.js
- methods/system.json 中 user.login / user.info / user.changeRole 的返回字段说明
#### C. app/service/systems/account_platform.js
关键风险:
- 该 service 当前直接依赖 AccountStoreRole 幽灵 key。
- 虽然尚未发现对外直接暴露的 system method,但它承载的平台激活角色语义与 auth.user 高度耦合。
已确认调用点:
- app/service/systems/account_platform.js:13 -> switchActiveRole
- app/service/systems/account_platform.js:77 -> getActiveRoleByPlatform
- app/service/systems/account_platform.js:159 -> getMultiplePlatformActiveRoles
- app/service/systems/account_platform.js:219 -> getAllPlatformActives
- app/service/systems/account_platform.js:309 -> getAvailableRoles
间接受影响入口:
- app/service/systems/auth/user.js:58
- app/service/systems/auth/user.js:304
- app/service/systems/auth/user.js:877
文档联动策略:
- 当前没有独立 method 文档入口。
- 若修改本 service 的输入/输出语义,必须回写到 user.login / user.info / user.changeRole 的 API 文档,因为这些接口会消费平台激活角色结果。
### 2.2 动态分表工厂链路
#### A. app/service/systemMethods/order.js
关键风险:
- 依赖 OrderDeliveryFactory / OrderItemsFactory 获取动态模型。
- 若工厂 key、返回模型或字段映射调整,会直接影响系统订单接口。
已确认调用点:
- app/service/systemMethods/order.js:18 -> getOrderModels
- app/service/systemMethods/order.js:98 -> list
- 其他 order.* 方法共享同一组动态模型入口
对应 API 文档:
- methods/system.json:422 -> order.getOrderModels
- methods/system.json:439 -> order.list
- methods/system.json:471 -> order.detail
- methods/system.json:503 -> order.listItems
- methods/system.json:535 -> order.stats
- methods/system.json:560 -> order.updateStatus
- methods/system.json:676 -> order.updateDeliveryTime
联动要求:
- 若修改动态模型获取方式、字段名或订单明细结构,必须同步更新上述 order.* 文档。
#### B. app/service/systems/delivery_order.js 与 app/service/qimenMethods/deliveryorder.js
关键风险:
- qimen 发货单接口直接依赖 OrderDeliveryFactory。
- 若动态分表模型的 key 或查询字段变化,Qimen 接口会受影响。
已确认调用点:
- app/service/systems/delivery_order.js:14
- app/service/systems/delivery_order.js:311
- app/service/qimenMethods/deliveryorder.js:7
- app/service/qimenMethods/deliveryorder.js:8
对应 API 文档:
- methods/qimen.json:14 -> deliveryorder.batchcreate
- methods/qimen.json:88 -> deliveryorder.create
- methods/qimen.json:162 -> deliveryorder.query
联动要求:
- 若修改 deliveryorder 查询、创建、历史表读取逻辑,必须同步更新 qimen deliveryorder.* 文档。
#### C. app/service/apiMethods/test.js
关键风险:
- 存在错误调用名 WmsOrderDeliveryFactory / WmsOrderItemsFactory。
- 这是内部调试链路,不是正式 API 文档入口,但必须与正式工厂 key 保持一致。
已确认调用点:
- app/service/apiMethods/test.js:50
- app/service/apiMethods/test.js:51
联动要求:
- 改动时同步修正为 OrderDeliveryFactory / OrderItemsFactory。
- 无需更新 methods 文档,但必须在本文件记录修复事实。
## 3. 本轮结论
- 即将进入的关联治理不是纯 model 内部调整,至少会影响 store、user、account_platform、order、deliveryorder 这几条真实业务链路。
- 因此后续任何代码改动都不能只改 model。
- 必须按“model -> service -> systemMethods/qimenMethods -> methods 文档 -> 变更记录”的顺序联动处理。
## 4. 修改前检查清单
- 确认目标 service 是否被上游调用。
- 确认上游调用属于 system 还是 qimen 入口。
- 确认 methods/system.json 或 methods/qimen.json 是否存在对应 method。
- 若返回结构变化,先记录旧字段,再补文档。
- 修改完成后,在本文件追加一条变更记录。
## 5. 变更记录模板
### YYYY-MM-DD HH:mm
- 修改范围:
- 涉及 service:
- 上游入口:
- 更新的 API 文档:
- 返回结构变化:
- 兼容处理:
- 验证方式:
## 6. 当前记录
### 2026-03-22 关联治理准备
- 修改范围: 阶段 4 开始前的 service 使用与文档联动审计
- 涉及 service:
- app/service/systems/store.js
- app/service/systems/auth/user.js
- app/service/systems/account_platform.js
- app/service/systemMethods/order.js
- app/service/systems/delivery_order.js
- app/service/qimenMethods/deliveryorder.js
- app/service/apiMethods/test.js
- 上游入口:
- system: store.getStoreRoles, store.auditApply, user.login, user.info, user.changeRole, order.*
- qimen: deliveryorder.batchcreate, deliveryorder.create, deliveryorder.query
- 更新的 API 文档: 尚未改动代码,本轮只完成审计与联动范围确认
- 返回结构变化: 暂无
- 兼容处理: 暂无
- 验证方式: 通过 service 调用搜索、system/qimen method 搜索、methods 文档映射完成静态核对
### 2026-03-22 关联治理执行(第一批)
- 修改范围: 修复 store 链路中 AccountStoreRole 幽灵模型引用
- 涉及 service:
- app/service/systems/store.js
- 上游入口:
- system: store.getStoreRoles, store.auditApply
- 更新的 API 文档:
- methods/system.json
- store.getStoreRoles: 补充 code 参数定义
- store.auditApply: 补充 audit_status/code/store_id/role_ids/reject_reason 参数定义
- 返回结构变化: 无(维持原有 code/message/data 结构)
- 兼容处理:
- 将账号-门店关系绑定到 AccountStoreEmployee
- 将角色绑定落到 EmployeeRole(employee_id + role_id)
- 保持接口出参与状态码行为不变
- 验证方式:
- 运行生成的改造前回归样例测试
- 运行 method-output compare 对比报告
### 2026-03-22 关联治理执行(第二批)
- 修改范围: 修复 account_platform 链路中 AccountStoreRole 幽灵模型引用
- 涉及 service:
- app/service/systems/account_platform.js
- 上游入口:
- 间接影响 system: user.login, user.info, user.changeRole
- 更新的 API 文档:
- 无直接 method 文档变更(本批未新增/修改 system method 参数)
- 返回结构变化: 无(维持 role_id/role_name/role_code/store_id/store_name/store_code 字段)
- 兼容处理:
- switchActiveRole 保持历史参数名 accountStoreRoleId,内部按 employee_id 落库
- include 链路由 AccountStoreRole 改为 AccountStoreEmployee + EmployeeRole + Role + Store
- getAvailableRoles 改为从 AccountStoreEmployee/EmployeeRole 聚合返回
- 验证方式:
- npx egg-bin test test/app/controller/system.method-output.pre-refactor.generated.test.js
- node .\\script\\method-output-regression.cjs compare
- npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
### 2026-03-22 关联治理执行(第三批)
- 修改范围: 清理 model 层残留命名污染(不改接口结构)
- 涉及 service/model:
- app/model/account.js
- app/model/role.js
- 上游入口:
- 间接影响 system 全链路(仅模型关联定义清理)
- 更新的 API 文档:
- 无(接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- 仅移除 AccountStoreRole 的遗留注释/无效解构,不调整现有 alias
- 验证方式:
- node .\\script\\method-output-regression.cjs compare
- npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- npx egg-bin test test/app/controller/system.method-output.batch3.generated.test.js
### 2026-03-22 样例漂移策略更新
- 发现现象:
- 固定历史样例 `system.method-output.pre-refactor.generated.test.js` 因权限/业务数据变化出现与历史快照不一致。
- 策略调整:
- 每批改造前重新冻结当批 baseline,并生成当批 Egg.js 样例测试。
- 历史快照保留审计用途,不作为后续批次唯一门禁。
- 当前批次快照:
- run/method-output-baseline-batch3-20260322_224649.json
- test/app/controller/system.method-output.batch3.generated.test.js
### 2026-03-22 关联治理执行(第四批)
- 修改范围: 统一 alias 命名并引入双轨兼容(复数标准名 + 历史别名保留)
- 涉及 service/model:
- app/model/account.js
- app/model/account_store_employee.js
- app/model/role.js
- app/model/store.js
- app/service/systems/account_platform.js
- app/service/systems/auth/user.js
- 上游入口:
- 间接影响 system: user.login, user.info, user.changeRole, store.getStoreRoles
- 更新的 API 文档:
- 无(接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- 新增标准 alias:accountStoreEmployees / employeeRoles
- 保留历史 alias:accountStoreRoles / accountStoreEmployee / employeeRole
- service 查询切换到新 alias,并在读取层面对旧 alias 做回退兼容
- 验证方式:
- node .\\script\\method-output-regression.cjs compare
- node .\\script\\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js
- npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
### 2026-03-23 关联治理执行(第四批补充收敛)
- 修改范围: service 层去除旧 alias 回退依赖,统一使用新 alias(保留 model 兼容别名)
- 涉及 service:
- app/service/systems/account_platform.js
- app/service/systems/auth/user.js
- 上游入口:
- 间接影响 system: user.login, user.info, user.changeRole, store.getStoreRoles
- 更新的 API 文档:
- 无(接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- account_platform 内部读取改为 employeeRoles 单轨
- model 层兼容 alias 继续保留,避免外部未迁移调用中断
- auth/user 中 accountStoreRole 变量语义更新为 accountStoreEmployee
- 验证方式:
- node .\\script\\method-output-regression.cjs baseline 8
- node .\\script\\method-output-regression.cjs compare
- node .\\script\\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js
- npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
### 2026-03-23 关联治理执行(第五批)
- 修改范围: 移除 model 层重复兼容 alias,完成重复关联清理
- 涉及 model:
- app/model/account.js
- app/model/account_store_employee.js
- app/model/role.js
- app/model/store.js
- 上游入口:
- 间接影响 system: user.login, user.info, user.changeRole, store.getStoreRoles
- 更新的 API 文档:
- 无(接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- 删除旧 alias:accountStoreRoles / employeeRole / accountStoreEmployee(Store.hasMany 语义)
- 保留必要单数 alias:AccountPlatformActive.belongsTo(AccountStoreEmployee).as = accountStoreEmployee
- 验证方式:
- node .\\script\\method-output-regression.cjs baseline 8
- node .\\script\\method-output-regression.cjs compare
- node .\\script\\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js
- npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
### 2026-03-23 关联治理执行(4.1 全量一致性校验)
- 修改范围: 对 app/model 全量关联定义与数据库真实外键进行一致性审计(无业务代码改动)
- 审计产物:
- association_fk_consistency_report.md
- temp/association-fk-audit.json
- 审计结论:
- DB 外键 51 条,模型关联 89 条,可直接匹配 53 条
- 模型定义但 DB 无外键约束 28 条
- DB 有外键但模型未声明 13 条
- 动态模型/示例占位无法静态解析 5 条
- 影响判断:
- 当前 system 输出门禁未受影响,但存在“模型语义与 DB 约束不完全对齐”的技术债
- 已将高优先级差异并入后续 4.4 规约与治理清单
### 2026-03-23 关联治理执行(第六批:receiving 高优先差异第一批)
- 修改范围: 处理 receiving 链路高优先差异,移除无效模型关联并收敛仓库维度查询条件
- 涉及 service/model:
- app/model/receiving.js
- app/model/receiving_detail.js
- app/service/systems/storage/receiving.js
- 上游入口:
- 间接影响 system: storage.receiving.getReceivingDetail 及 receiving 相关查询/更新链路
- 更新的 API 文档:
- 无(接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- 删除无效关联: `Receiving.hasMany(Storage, foreignKey: 'receiving_id')`
- 删除无效关联: `ReceivingDetail.hasMany(Storage, foreignKey: 'receiving_detail_id')`
- `StoreWarehouse` include/query 统一增加 `warehouse_id + use_status` 过滤,避免跨仓库错关联
- `create` 流程 `store_name` 统一使用 `store_remask`
- 验证方式:
- node .\\script\\method-output-regression.cjs compare
- node .\\script\\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 验证结果:
- compare: total=8, mismatch=0
- tests: 14 passing
### 2026-03-23 关联治理执行(第七批:4.4 规约文档落地)
- 修改范围: 形成并落地 eager-loading 与 N+1 风险规约(文档治理,无业务代码改动)
- 涉及文档:
- association_eager_loading_n_plus_one_guideline.md
- association_validation_checklist.md
- model_todo.txt
- 上游入口:
- 无直接 system/qimen 行为变更
- 更新的 API 文档:
- 无
- 返回结构变化: 无
- 兼容处理:
- 将关联查询的最小约束(include attributes、上下文 where、门禁流程)固化为统一规约
- 验证方式:
- 以第六批回归结果作为当前代码基线(compare mismatch=0,tests 14 passing)
### 2026-03-23 关联治理执行(第八批:store_warehouse/stock_warehouse 语义收敛)
- 修改范围: 修复 stock_store 链路中 `StoreWarehouse` 仅按 `store_id` 关联导致的跨仓误匹配风险
- 涉及 service/model:
- app/service/systems/stock_store.js
- 上游入口:
- 间接影响 system: stock.* 查询链路(库存列表/搜索)
- 更新的 API 文档:
- 无(接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- `store_stock` include 在 count/findAll/search 三处统一增加 `warehouse_id + use_status` 过滤
- 保持 `required` 策略不变(列表仍 required=true,搜索路径 required=false)
- 验证方式:
- node .\\script\\method-output-regression.cjs compare
- node .\\script\\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 验证结果:
- compare: total=8, mismatch=0
- tests: 14 passing
### 2026-03-23 关联治理执行(第九批:role/permission 语义收敛)
- 修改范围: 修复 auth/user 权限链路对禁用角色/权限的过滤缺失问题
- 涉及 service/model:
- app/service/systems/auth/user.js
- 上游入口:
- 间接影响 system: user.info(权限与菜单加载链路)
- 更新的 API 文档:
- 无(接口参数与返回结构未变化)
- 返回结构变化: 无(仅收敛为“启用角色/启用权限可见”)
- 兼容处理:
- `getPermissions/getMenus` 在 EmployeeRole 查询中增加 Role.status=1 过滤
- Permission 查询增加 status=1 过滤
- role_id 与 permission_id 查询集合去重
- 验证方式:
- node .\\script\\method-output-regression.cjs compare
- node .\\script\\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 验证结果:
- compare: total=8, mismatch=0
- tests: 14 passing
### 2026-03-23 关联治理执行(第十批:role_permission 外键迁移落地)
- 修改范围: 落地 `role_permission.permission_id -> permission.id` 的可执行迁移脚本与模型类型对齐
- 涉及 service/model/migration:
- database/migrations/20260323103000-align-role-permission-fk.js
- app/model/role_permission.js
- 上游入口:
- 无直接 system/qimen 返回结构变化
- 更新的 API 文档:
- 无
- 返回结构变化: 无
- 兼容处理:
- 迁移脚本包含保护性校验:存在孤儿数据时直接失败,避免静默脏写
- down 提供外键回滚与字段类型回退
- 审计发现:
- `wms_role_permission.permission_id` 存在 4 条孤儿记录(id: 2, 3, 6, 10)
- `wms_role.store_id` 存在 3 条 `0` 哨兵值(当前不满足直接加 FK 条件)
- 验证方式:
- node .\\script\\method-output-regression.cjs compare
- node .\\script\\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 实际执行结果:
- 已创建备份表并落库:
- `wms_role_permission_orphan_backup_20260323`(4 条)
- `wms_role_store_zero_backup_20260323`(3 条)
- 已清洗数据:
- 删除 `wms_role_permission.permission_id` 孤儿 4 条
- 将 `wms_role.store_id=0` 修正为 `NULL` 共 3 条
- 已执行 DDL:
- `wms_role_permission.permission_id` -> `int(11)`
- 新增外键 `fk_wms_role_permission_permission`(ON UPDATE RESTRICT, ON DELETE CASCADE)
- SequelizeMeta 已登记 `20260323103000-align-role-permission-fk.js`
- 迁移后复核: 孤儿计数=0,role_store_zero=0
- 回归结果:
- compare: total=8, mismatch=0
- tests: 14 passing
### 2026-03-23 关联治理执行(第十一批:role.store_id 外键策略落地)
- 修改范围: 落地 `wms_role.store_id -> wms_store.id` 外键策略(NULL 语义)
- 涉及 migration:
- database/migrations/20260323113000-add-role-store-fk.js
- 上游入口:
- 无直接 system/qimen 返回结构变化
- 更新的 API 文档:
- 无
- 返回结构变化: 无
- 兼容处理:
- `store_id` 字段类型对齐为 `bigint(20) unsigned NULL`
- 新增索引 `idx_store_id`
- 外键策略采用 `ON DELETE SET NULL`,保留历史角色记录的 NULL 语义
- 实际执行结果:
- 外键 `fk_wms_role_store` 已生效(ON UPDATE RESTRICT, ON DELETE SET NULL)
- `wms_role` 孤儿数据复核: 0
- SequelizeMeta 已登记 `20260323113000-add-role-store-fk.js`
- 验证方式:
- node .\\script\\method-output-regression.cjs compare
- node .\\script\\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 回归结果:
- compare: total=8, mismatch=0
- tests: 14 passing
### 2026-03-23 关联治理执行(第十二批:store_warehouse/stock_warehouse 模型层语义治理)
- 修改范围: 收敛 `store_stock` 关联的模型层复合键表达,统一 include 构造入口
- 涉及 service/model:
- app/model/store_warehouse.js
- app/model/stock_warehouse.js
- app/model/receiving.js
- app/service/systems/stock_store.js
- app/service/systems/storage/receiving.js
- 上游入口:
- 间接影响 system: stock.* / storage.receiving.* 查询链路
- 更新的 API 文档:
- 无(接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- StoreWarehouse 新增 `buildScopedWhere` 与 `buildStoreStockInclude`,统一生成 `warehouse_id + use_status` 约束
- 复合键语义关联统一显式 `constraints:false`,避免单列外键误解
- service 查询改为复用模型构造器,保持原有 `required` 语义不变
- 验证方式:
- node .\\script\\method-output-regression.cjs compare
- node .\\script\\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 回归结果:
- compare: total=8, mismatch=0
- tests: 14 passing
### 2026-03-23 关联治理执行(第十三批:include alias 一致性收尾扫描)
- 修改范围: 阶段 4 收尾检查(全量 include alias 一致性扫描,无业务代码改动)
- 涉及范围:
- app/model/**/*.js(association `as` 定义)
- app/service/**/*.js(include `as` 使用)
- 上游入口:
- 无直接 system/qimen 行为变更
- 更新的 API 文档:
- 无
- 返回结构变化: 无
- 扫描方法:
- 全量检索 model association 与 service include 的 alias 使用
- 执行自动差集比对(service alias - model alias)
- 扫描结果:
- model alias 总数: 48
- 差集可疑项: 0
- 结论: 未发现 include alias 不一致问题
- 验证方式:
- 通过一次性 Node 差集脚本执行 `service alias - model alias` 自动比对(临时脚本未入库)
### 2026-03-23 关联治理执行(第十四批:permission.parent_id 自关联约束落地)
- 修改范围: 落地 `wms_permission.parent_id -> wms_permission.id` 自关联外键,并统一根节点语义
- 涉及 service/model/migration:
- database/migrations/20260323123000-add-permission-parent-fk.js
- app/model/permission.js
- app/service/systems/auth/user.js
- 上游入口:
- 间接影响 system: user.info(菜单树构建)
- 更新的 API 文档:
- 无(接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- 根节点语义由 `parent_id=0` 规范为 `parent_id IS NULL`
- 模型 setter 兼容历史输入:`0 -> NULL`
- 菜单树构建逻辑根判断由 `parent_id===0` 收敛为 `!parent_id`
- 实际执行结果:
- 落库复核:`root_zero_after=0`、`root_null_after=42`、`orphan_after=0`
- 外键 `fk_wms_permission_parent` 已生效(ON UPDATE RESTRICT, ON DELETE SET NULL)
- SequelizeMeta 已登记 `20260323123000-add-permission-parent-fk.js`
- 触发器状态:目标库因权限限制(binlog + SUPER)未创建触发器,采用应用层归一化方案替代
- 验证方式:
- node .\script\method-output-regression.cjs compare
- node .\script\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 回归结果:
- compare: total=8, mismatch=0
- tests: 14 passing
### 2026-03-23 模型能力治理执行(第十五批:阶段 5.1 清理清单盘点)
- 修改范围: 阶段 5.1(识别应迁移到 service 层的方法能力,文档治理)
- 涉及文档:
- model_cleanup_list.md
- model_todo.txt
- 上游入口:
- 无直接 system/qimen 行为变更
- 更新的 API 文档:
- 无
- 返回结构变化: 无
- 盘点结论:
- 模型方法总数: 102
- 第一批应迁移(P1)聚焦: EntryOrder / EntryItems / Storage / RolePermission / Store
- 第一批无调用可清理(P2)已形成清单,待阶段 5.2 执行删除前复核
- 验证方式:
- 静态扫描 model 方法清单与引用关系(仅文档盘点,无业务代码改动)
### 2026-03-23 模型能力治理执行(第十六批:阶段 5.2 第一批无调用方法清理)
- 修改范围: 清理 model 层第一批无调用静态方法(低风险)
- 涉及 model:
- app/model/api_app.js
- app/model/interface_type.js
- app/model/print_item.js
- 上游入口:
- 无直接 system/qimen 行为变更
- 更新的 API 文档:
- 无
- 返回结构变化: 无
- 兼容处理:
- 清理前执行全局引用复核,确认仅在定义处出现
- 仅删除静态 helper,不触碰关联定义与实例方法
- 删除项:
- ApiApp.findByAppKey / ApiApp.findByQimenConfig
- InterfaceType.findByCode / InterfaceType.findEnabled
- PrintItem.getGroupFields / PrintItem.getTableConfigs
- 验证方式:
- node .\script\method-output-regression.cjs compare
- node .\script\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 回归结果:
- compare: total=8, mismatch=0
- tests: 14 passing
### 2026-03-23 模型能力治理执行(第十七批:阶段 5.2 第二批无调用方法清理)
- 修改范围: 清理 model 层第二批无调用静态方法(低风险)
- 涉及 model:
- app/model/i18n_translation.js
- app/model/stock_store.js
- 上游入口:
- 无直接 system/qimen 行为变更
- 更新的 API 文档:
- 无
- 返回结构变化: 无
- 兼容处理:
- 清理前完成删除前引用复核(service/controller/test/script 全仓扫描)
- 仅删除静态 helper,不触碰关联定义、字段定义与实例方法
- 删除项:
- I18nTranslation.getTranslation / I18nTranslation.batchGetTranslations / I18nTranslation.getProjectTranslations / I18nTranslation.upsertTranslation / I18nTranslation.getUntranslated
- StockStore.findByItemCode / StockStore.findByStore
- 验证方式:
- node .\script\method-output-regression.cjs compare
- node .\script\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js
- npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 回归结果:
- compare: total=8, mismatch=0
- generated regression: 8 passing
- smoke: 6 passing
- tests: 14 passing
### 2026-03-23 模型能力治理执行(第十八批:阶段 5.2 P1 第一组迁移)
- 修改范围: 将 EntryOrder / EntryItems 的内部静态方法迁移到 service,收敛 model 职责
- 涉及 service/model:
- app/service/systems/entry_order.js
- app/model/entry_order.js
- app/model/entry_items.js
- 上游入口:
- 无直接新增 system/qimen method;属于内部服务能力收敛
- 更新的 API 文档:
- 无(对外接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- 迁移 EntryOrder.findByOrderCode/findByStatus/getStatsByWarehouse/updateSyncStatus/updateOrderStatus/calculateReceivedQuantities
- 迁移 EntryItems.batchUpdateReceived/getOrderProgress
- 验证方式:
- node .\script\method-output-regression.cjs compare
- node .\script\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js
- npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 回归结果:
- compare: total=8, mismatch=0
- generated regression: 8 passing
- smoke: 6 passing
- tests: 14 passing
### 2026-03-23 模型能力治理执行(第十九批:阶段 5.2 P1 第二组迁移)
- 修改范围: 将 Storage 的内部静态方法迁移到 service,收敛 model 职责
- 涉及 service/model:
- app/service/systems/storage/index.js
- app/model/storage.js
- 上游入口:
- 无直接新增 system/qimen method;属于内部服务能力收敛
- 更新的 API 文档:
- 无(对外接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- 迁移 Storage.findByStockAndBatch/findBySpace/findAvailableByWarehouse/findExpiringSoon/updateQuantity/lockQuantity/unlockQuantity/allocateQuantity/getStockSummary/getSpaceUsage
- 验证方式:
- node .\script\method-output-regression.cjs compare
- node .\script\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js
- npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 回归结果:
- compare: total=8, mismatch=0
- generated regression: 8 passing
- smoke: 7 passing
- tests: 15 passing
### 2026-03-23 模型能力治理执行(第二十批:阶段 5.2 P1 第三组迁移)
- 修改范围: 将 Role / RolePermission 的权限编排方法迁移到 service,收敛 model 职责
- 涉及 service/model:
- app/service/systems/auth/role_permission.js
- app/model/role.js
- app/model/role_permission.js
- 上游入口:
- 无直接新增 system/qimen method;属于内部服务能力收敛
- 更新的 API 文档:
- 无(对外接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- 迁移 Role.assignPermissions/getPermissionTree/getPermissionIds
- 迁移 RolePermission.bulkAssign/clearRolePermissions/getRolePermissions/hasPermission
- 验证方式:
- node .\script\method-output-regression.cjs compare
- node .\script\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js
- npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 回归结果:
- compare: total=8, mismatch=0
- generated regression: 8 passing
- smoke: 7 passing
- tests: 15 passing
### 2026-03-23 模型能力治理执行(第二十一批:阶段 5.2 P1 第四组迁移)
- 修改范围: 将 Store 的校验与查询助手方法迁移到 service,收敛 model 职责
- 涉及 service/model:
- app/service/systems/store.js
- app/model/store.js
- 上游入口:
- 无直接新增 system/qimen method;属于内部服务能力收敛
- 更新的 API 文档:
- 无(对外接口参数与返回结构未变化)
- 返回结构变化: 无
- 兼容处理:
- 迁移 Store.validateStoreData/checkCompanyNameExists/findByAccountId/findAllEnabled/findAllWarehouses
- 验证方式:
- node .\script\method-output-regression.cjs compare
- node .\script\tmp-generate-method-regression-test.cjs
- npx egg-bin test temp/generated-tests/system.method-output.generated.test.js
- npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
- 回归结果:
- compare: total=8, mismatch=0
- generated regression: 8 passing
- smoke: 7 passing
- tests: 15 passing
### 2026-03-23 系统接口兼容修复(第二十二批:project 请求头校验)
- 修改范围: 修复 system 请求上下文校验对历史 project=wms 请求头的误拒绝
- 涉及 service:
- app/service/system.js
- 变更内容:
- `ALLOWED_PROJECTS` 增加 `wms/scm/other`,保持与历史调用兼容
- 触发原因:
- generated regression 与 smoke 在无业务代码变更时统一出现 400(`project 不支持: wms`)
- 验证方式:
- 直接调用 `user.login`(platform=web, project=wms)回归
- compare + generated regression + smoke 全量重跑
- 回归结果:
- login: HTTP 200
- compare: total=8, mismatch=0
- generated regression: 8 passing
- smoke: 7 passing
- tests: 15 passing

View File

@ -1,102 +0,0 @@
# Association Eager-Loading 与 N+1 规约
更新时间: 2026-03-23
适用阶段: Model 重构阶段 4.4
范围: app/service/**/*.js 中涉及 Sequelize 关联查询的代码
## 1. 目标
- 降低关联查询的 SQL 次数与响应时间抖动。
- 统一 eager-loading 写法,避免 include 漂移导致错关联。
- 在不改变外部接口返回结构的前提下收敛查询成本。
## 2. 术语
- eager-loading: 通过 include 一次性加载关联数据。
- N+1: 先查 1 次主数据,再按每条主数据各查 1 次关联,导致总查询次数随 N 线性增长。
- 关联上下文约束: 在 include.where 中补齐业务维度(如 warehouse_id、use_status),避免跨上下文错关联。
## 3. 强制规则
1. 列表查询禁止在循环内按行查询关联表。
2. 只要关联数据是展示必需字段,优先使用 include 一次加载。
3. include 必须显式声明 attributes,禁止默认全字段拉取。
4. include 需要业务上下文约束时,必须补齐 where 条件(典型: warehouse_id + use_status)。
5. hasMany/hasOne/belongsTo 的 as 必须与 model 定义一致,禁止临时字符串别名。
6. 分页列表若包含 hasMany,优先控制返回列并评估 distinct/subQuery,防止计数与分页漂移。
7. count 与 findAll 不一致时,必须拆分并保持 where/include 语义一致。
## 4. 推荐写法
### 4.1 反模式(N+1)
```js
const list = await Model.findAll({ where });
for (const row of list) {
row.child = await Child.findOne({ where: { id: row.child_id } });
}
```
### 4.2 规约写法(eager-loading)
```js
const list = await Model.findAll({
where,
attributes: [ 'id', 'name', 'child_id' ],
include: [
{
model: Child,
as: 'child',
attributes: [ 'id', 'name' ],
required: false,
},
],
});
```
### 4.3 仓库维度约束(本仓库高频场景)
```js
include: [
{
model: ctx.model.StoreWarehouse,
as: 'store_stock',
attributes: [ 'store_id', 'store_remask' ],
where: {
warehouse_id: warehouseId,
use_status: 1,
},
required: false,
},
]
```
## 5. 当前代码落地点
- receiving 链路已按规约补齐仓库维度过滤,避免 StoreWarehouse 跨仓匹配。
- receiving 与 receiving_detail 已移除无效 Storage hasMany 关联,避免误导 include 设计。
- 后续优先治理:
- store_warehouse 与 stock_warehouse 的 store_id 语义对齐
- role / role_permission / permission 的关联约束与 include 一致性
## 6. 变更门禁
每批涉及关联查询的改动,至少执行以下门禁:
1. node .\\script\\method-output-regression.cjs compare
2. node .\\script\\tmp-generate-method-regression-test.cjs
3. npx egg-bin test temp/generated-tests/system.method-output.generated.test.js
4. npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
交付标准:
- compare 结果 mismatch=0
- 生成回归与关键冒烟测试全部通过
## 7. PR 自检清单
- [ ] 是否存在循环内数据库查询。
- [ ] include 是否补齐 attributes。
- [ ] include.where 是否补齐业务上下文约束。
- [ ] as 是否与 model 关联定义一致。
- [ ] 是否完成 method-output compare 与回归测试。

View File

@ -1,61 +0,0 @@
# Association Fix Plan
更新时间: 2026-03-23
适用阶段: Model 重构阶段 4(关联关系规范化)
## 1. 目标
- 统一 alias 命名规则(belongsTo/hasOne 用单数,hasMany/belongsToMany 用复数)。
- 清理重复或冲突关联定义,避免 include 歧义。
- 保持 system/qimen 输出结构不变,通过 baseline/compare 门禁验证。
## 2. 已完成修复
### 2.1 幽灵模型收敛(已完成)
- 将 AccountStoreRole 相关调用链迁移到 AccountStoreEmployee + EmployeeRole + Role + Store。
- 覆盖主链路:
- app/service/systems/store.js
- app/service/systems/account_platform.js
- app/service/systems/auth/user.js
### 2.2 alias 标准化(已完成)
- 新标准 alias:
- accountStoreEmployees
- employeeRoles
- 已完成调用迁移:
- account_platform 服务 include 与读取逻辑统一为 employeeRoles
- auth/user 服务 include 统一为 employeeRoles
### 2.3 重复关联清理(已完成)
- 已移除以下重复兼容 alias 定义:
- Account.accountStoreRoles
- AccountStoreEmployee.employeeRole
- Role.employeeRole
- Store.accountStoreEmployee
- 保留必要单数 alias(belongsTo 语义):
- AccountPlatformActive.accountStoreEmployee
## 3. 验证策略
每批改动执行以下门禁:
1. node .\\script\\method-output-regression.cjs baseline 8
2. node .\\script\\method-output-regression.cjs compare
3. node .\\script\\tmp-generate-method-regression-test.cjs
4. npx egg-bin test temp/generated-tests/system.method-output.generated.test.js
5. npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js
## 4. 当前状态
- 输出一致性门禁:通过(mismatch=0)。
- 关键冒烟测试:通过。
- 对外 API 参数/返回:无结构变更。
## 5. 剩余工作
- 全量扫描其余模型类方法中的 include alias 一致性(已完成,差集扫描异常项 0 个)。
- 评估并落地 permission.parent_id 自关联约束策略(已完成:root 语义归一为 NULL + 自关联 FK)。
- 进入阶段 5:Model 内部能力清理与边界固化。

View File

@ -1,65 +0,0 @@
# Association FK Consistency Report
更新时间: 2026-03-23T03:08:35.772Z
数据库: wms
## Summary
- DB 外键数: 51
- 模型关联数: 89
- 可直接匹配外键: 53
- 模型定义但 DB 无外键约束: 28
- 无法解析到模型表映射: 5
- DB 存在但模型未声明的外键: 13
## Missing Constraints (Top 20)
- wms_receiving.creator_id->wms_account_store_employee.id (app/model/account_store_employee.js, hasMany, as=Receiving)
- wms_api_app.warehouse_id->wms_store.id (app/model/api_app.js, belongsTo, as=warehouse)
- wms_fast_where.pid->wms_fast_where.id (app/model/fast_where.js, belongsTo, as=parent)
- wms_fast_where.pid->wms_fast_where.id (app/model/fast_where.js, hasMany, as=children)
- wms_location_space.zone_id->wms_location_zone.id (app/model/location_space.js, belongsTo, as=zone)
- wms_receiving_detail.space_id->wms_location_space.id (app/model/location_space.js, hasMany, as=receiving)
- wms_location_space.zone_id->wms_location_zone.id (app/model/location_zone.js, hasMany, as=spaces)
- wms_location_zone.warehouse_id->wms_location_zone.warehouse_id (app/model/location_zone.js, belongsTo, as=pickStartPoint)
- wms_permission.parent_id->wms_permission.id (app/model/permission.js, hasMany, as=children)
- wms_permission.parent_id->wms_permission.id (app/model/permission.js, belongsTo, as=parent)
- wms_receiving.warehouse_id->wms_store.id (app/model/receiving.js, belongsTo, as=warehouse)
- wms_receiving.creator_id->wms_account_store_employee.id (app/model/receiving.js, belongsTo, as=creator)
- wms_storage.receiving_id->wms_receiving.id (app/model/receiving.js, hasMany, as=storage_records)
- wms_receiving.store_id->wms_store_warehouse.store_id (app/model/receiving.js, belongsTo, as=store)
- wms_receiving_detail.system_product_id->wms_stock_warehouse.id (app/model/receiving_detail.js, belongsTo, as=system_product)
- wms_storage.receiving_detail_id->wms_receiving_detail.id (app/model/receiving_detail.js, hasMany, as=storage_details)
- wms_receiving_detail.space_id->wms_location_space.id (app/model/receiving_detail.js, belongsTo, as=receiving_space)
- wms_role.store_id->wms_store.id (app/model/role.js, belongsTo, as=store)
- wms_role_permission.permission_id->wms_permission.id (app/model/role_permission.js, belongsTo, as=permission)
- wms_stock_warehouse.store_id->wms_store_warehouse.store_id (app/model/stock_warehouse.js, belongsTo, as=store_stock)
## Unresolved Associations (Top 20)
- app/model/order_delivery_factory.js: DynamicModel -> ItemsModel (type=hasMany, fk=order_id)
- app/model/order_delivery_factory.js: ItemsModel -> DynamicModel (type=belongsTo, fk=order_id)
- app/model/order_delivery_factory.js: DynamicModel -> this.app.model.Store (type=belongsTo, fk=store_id)
- app/model/order_delivery_factory.js: DynamicModel -> this.app.model.Store (type=belongsTo, fk=warehouse_id)
- app/model/print_item.js: PrintItem -> app.model.OtherModel (type=belongsTo, fk=xxx)
## DB-only Foreign Keys (Top 20)
- wms_account_login_log.user_id->wms_account.id
- wms_embargo_policies.warehouse_id->wms_store.id
- wms_express_setting.express_code->wms_express.code
- wms_express_setting.warehouse_id->wms_store.id
- wms_order_delivery.store_id->wms_store.id
- wms_order_delivery.warehouse_id->wms_store.id
- wms_order_express.order_id->wms_order_delivery.id
- wms_order_express_print_data.express_id->wms_order_express.id
- wms_order_items.order_id->wms_order_delivery.id
- wms_stock_warehouse.warehouse_id->wms_store.id
- wms_store_join.account_id->wms_account.id
- wms_store_join.store_id->wms_store.id
- wms_system_log.store_id->wms_store.id
## Notes
- belongsToMany 通过中间表映射,未纳入本次“直接外键”匹配。
- 动态分表工厂中的关联(order_delivery_factory/order_items_factory)不做静态表级强校验。

View File

@ -1,165 +0,0 @@
# Association Validation Checklist
更新时间: 2026-03-23
范围: app/model/*.js + 核心系统 service 调用链
## 1. 核心检查项
- [x] AccountStoreRole 幽灵引用已移除(服务主链路)。
- [x] AccountStoreEmployee <-> EmployeeRole <-> Role 关系可用。
- [x] hasMany alias 复数化(employeeRoles/accountStoreEmployees)。
- [x] 重复兼容 alias 已清理(主链路)。
- [x] 对外接口输出一致(baseline/compare mismatch=0)。
- [x] 关键登录与用户信息链路测试通过。
## 2. 关键模型校验结果
| 模型 | 关键关联 | 结果 | 备注 |
| --- | --- | --- | --- |
| Account | hasMany AccountStoreEmployee as accountStoreEmployees | PASS | 已移除 accountStoreRoles |
| AccountStoreEmployee | hasMany EmployeeRole as employeeRoles | PASS | 已移除 employeeRole |
| Role | hasMany EmployeeRole as employeeRoles | PASS | 已移除 employeeRole |
| Store | hasMany AccountStoreEmployee as accountStoreEmployees | PASS | 已移除 accountStoreEmployee |
| AccountPlatformActive | belongsTo AccountStoreEmployee as accountStoreEmployee | PASS | belongsTo 单数语义保留 |
## 3. 服务调用链校验结果
| 服务 | 校验项 | 结果 |
| --- | --- | --- |
| systems/account_platform | include/读取 employeeRoles 一致 | PASS |
| systems/auth/user | include alias 使用 employeeRoles | PASS |
| systems/store | 角色绑定链路使用 EmployeeRole | PASS |
| systems/storage/receiving | StoreWarehouse 关联补 warehouse_id/use_status 过滤,避免跨仓错关联 | PASS |
## 4. 验证记录
- method-output compare: mismatch=0
- generated test: 8 passing
- smoke test (login/info/home): 6 passing
## 5. 4.1 全量审计结果(2026-03-23)
- 审计报告: association_fk_consistency_report.md
- DB 外键: 51
- 模型关联: 89
- 可直接匹配: 53
- 模型定义但 DB 无外键约束: 28
- DB 有外键但模型未声明: 13
- 动态模型/示例占位导致无法静态解析: 5
高优先级差异(建议先处理):
- receiving / receiving_detail / storage 三表关联的 FK 约束缺失项(第一批已处理:删除无效 hasMany(Storage) 关联,并修正 service include 过滤)
- store_warehouse 与 stock_warehouse/receiving 的 store_id 外键语义差异(已完成服务层与模型层双收敛)
- role / role_permission / permission 的部分 FK 未在 DB 层约束(核心约束已补齐,remaining: permission.parent_id 自关联约束策略评估)
### 5.1 高优先差异处理进展(receiving 第一批)
- 处理内容:
- 移除 `Receiving.hasMany(Storage, foreignKey: 'receiving_id')` 无效关联(storage 表不存在 receiving_id)。
- 移除 `ReceivingDetail.hasMany(Storage, foreignKey: 'receiving_detail_id')` 无效关联(storage 表不存在 receiving_detail_id)。
- `systems/storage/receiving` 多处 `StoreWarehouse` include/query 增加 `warehouse_id + use_status` 过滤,规避跨仓库错关联。
- `create` 流程中 `store_name` 改为来源 `store_remask`,与仓库门店展示语义对齐。
- 验证结果:
- method-output compare: mismatch=0
- generated regression + smoke: 14 passing
### 5.2 高优先差异处理进展(store_warehouse/stock_warehouse 第二批)
- 处理内容:
- `systems/stock_store` 的 `store_stock` include 全量补齐 `warehouse_id + use_status` 条件,避免仅按 `store_id` 关联导致跨仓误匹配。
- 覆盖 count/findAll/search 三处核心查询路径,保持原有返回结构不变。
- 验证结果:
- method-output compare: mismatch=0
- generated regression + smoke: 14 passing
### 5.3 高优先差异处理进展(role/permission 第三批)
- 处理内容:
- `systems/auth/user` 的权限与菜单查询链路补齐 `Role.status=1` 约束,仅启用角色参与授权。
- 权限查询补齐 `Permission.status=1` 约束,禁用权限不再进入 `user.permissions` 与菜单树。
- 对 role_id/permission_id 增加去重处理,避免重复关联导致的冗余查询和重复路径。
- 验证结果:
- method-output compare: mismatch=0
- generated regression + smoke: 14 passing
### 5.4 DB 约束补齐进展(role_permission 第四批)
- 处理内容:
- 新增迁移 `database/migrations/20260323103000-align-role-permission-fk.js`:
- 将 `wms_role_permission.permission_id` 对齐为 `int(11)`(与 `wms_permission.id` 一致)。
- 在无孤儿数据时添加 `fk_wms_role_permission_permission` 外键(ON DELETE CASCADE, ON UPDATE RESTRICT)。
- 同步模型字段类型: `app/model/role_permission.js` 的 `permission_id` 改为 `INTEGER`。
- 执行结果:
- 已完成数据清洗:`wms_role_permission.permission_id` 孤儿记录 4 条已备份并删除;`wms_role.store_id=0` 的 3 条记录已备份并修正为 `NULL`。
- 已执行迁移核心动作:`permission_id` 类型已对齐为 `int(11)`,且外键 `fk_wms_role_permission_permission` 已生效。
- SequelizeMeta 已登记 `20260323103000-align-role-permission-fk.js`。
- 门禁结果:method-output compare mismatch=0,generated regression + smoke: 14 passing。
### 5.5 DB 约束补齐进展(role.store_id 第五批)
- 处理内容:
- 新增迁移 `database/migrations/20260323113000-add-role-store-fk.js`:
- 将 `wms_role.store_id` 对齐为 `bigint(20) unsigned NULL`。
- 补充索引 `idx_store_id`。
- 添加外键 `fk_wms_role_store`(ON UPDATE RESTRICT, ON DELETE SET NULL)。
- 执行结果:
- `wms_role.store_id` 外键已生效,孤儿计数=0。
- SequelizeMeta 已登记 `20260323113000-add-role-store-fk.js`。
- 门禁结果:method-output compare mismatch=0,generated regression + smoke: 14 passing。
### 5.6 模型层复合键语义治理进展(store_warehouse/stock_warehouse 第六批)
- 处理内容:
- `StoreWarehouse` 模型新增统一构造器:`buildScopedWhere` / `buildStoreStockInclude`,收敛 `store_stock` include 的复合键语义。
- `StockWarehouse.belongsTo(StoreWarehouse as store_stock)` 与 `StoreWarehouse.hasMany(StockWarehouse as store_stock)` 显式标记 `constraints: false`,避免误导为单列外键。
- `Receiving.belongsTo(StoreWarehouse as store)` 显式标记 `constraints: false`,与 `store_id + warehouse_id` 业务语义对齐。
- `systems/stock_store` 与 `systems/storage/receiving` 已改为复用模型构造器,减少散落条件。
- 验证结果:
- method-output compare: mismatch=0
- generated regression + smoke: 14 passing
### 5.7 DB 约束补齐进展(permission.parent_id 第七批)
- 处理内容:
- 新增迁移 `database/migrations/20260323123000-add-permission-parent-fk.js`:
- 将 `wms_permission.parent_id` 根节点语义从 `0` 规范为 `NULL`。
- 添加自关联外键 `fk_wms_permission_parent`(ON UPDATE RESTRICT, ON DELETE SET NULL)。
- 模型与服务语义对齐:
- `Permission.parent_id` 改为 `allowNull: true` / `defaultValue: null`,并在 setter 中兼容输入 `0 -> NULL`。
- 权限树构建根节点判断由 `parent_id===0` 收敛为 `!parent_id`(兼容历史与新语义)。
- 执行结果:
- 数据复核: `root_zero_after=0`、`root_null_after=42`、`orphan_after=0`。
- 外键生效: `fk_wms_permission_parent` 已存在。
- SequelizeMeta 已登记 `20260323123000-add-permission-parent-fk.js`。
- 触发器策略: 目标库因权限限制(binlog + SUPER)未创建触发器,改由应用层归一化 `0 -> NULL`。
- 验证结果:
- method-output compare: mismatch=0
- generated regression + smoke: 14 passing
## 6. 后续检查
- [x] 全量扫描其余模型类方法中的 include 别名一致性(service as 与 model as 差集扫描结果: 0)。
- [x] 补充 N+1 风险清单与 eager-loading 建议(见 association_eager_loading_n_plus_one_guideline.md)。
### 6.1 include alias 一致性收尾扫描(2026-03-23)
- 扫描范围:
- `app/model/**/*.js` 中 association `as` 定义
- `app/service/**/*.js` 中 include `as` 使用
- 扫描方式:
- 先做全量检索(model association / service include)
- 再做集合差集(service alias - model alias)自动比对
- 扫描结论:
- model alias 总数: 48
- 差集可疑项: 0
- 结论: 未发现 include alias 不一致问题,可关闭阶段 4 收尾检查第 1 项。
## 7. 4.4 规约落地记录(2026-03-23)
- 规约文档: association_eager_loading_n_plus_one_guideline.md
- 已固化要求:
- 禁止循环内逐条查询关联表(N+1)。
- include 必须声明 attributes。
- 仓库链路 include 必须补齐 warehouse_id + use_status 约束。
- 涉及关联查询改动必须执行 compare + generated test + smoke。

View File

@ -1,76 +0,0 @@
# migration_execution_plan
更新时间: 2026-03-22
## 1. 执行原则
- 先解决 SequelizeMeta 漂移,再补新增 migration。
- 先补静态基表,再补关联表,再补日志/配置/打印等扩展表。
- 动态分表与视图单独治理,不混入普通 createTable 批次。
- 所有 migration 需保证幂等,避免现有环境重复执行报错。
## 2. 推荐顺序
### 步骤 1: 漂移核对
- 核对以下 4 个未进入 SequelizeMeta 的 migration 与当前数据库实际结构是否一致:
- 20251111083733-create-wms-stock-store.js
- 20251112085825-create-wms-entry-order.js
- 20251112085844-create-wms-entry-items.js
- 20260322061000-add-delivery-time-to-order-delivery-tables.js
- 若结构已存在且一致,优先制定“补登记基线方案”而不是直接重跑。
### 步骤 2: 补齐有 model 的静态表 migration
优先级建议:
1. 权限与组织类
2. 库位与库存类
3. 打印类
4. 日志与国际化类
### 步骤 3: 补齐无 model 但业务依赖的表 migration
优先补以下类型:
- system_log / api_log
- print_log / print_batch / printer_config
- platform_print_config
- wave_batch / wave_operation_log
- order_operation_log
### 步骤 4: 动态分表治理
- 为 order_delivery/order_items 动态分表建立统一 migration 策略。
- 后续迁移以“母表 + 动态建表 SQL 模板/工厂策略同步”为主,不逐仓库表固化。
### 步骤 5: 视图治理
- 为以下视图补充 create/drop migration:
- v_pick_space
- vw_warehouse_quota
## 3. 建议批次
- 批次 A: 漂移核对与基线修正
- 批次 B: 静态核心表 migration 补齐
- 批次 C: 日志/配置/打印扩展表 migration 补齐
- 批次 D: 动态分表与视图治理
## 4. local/test 演练方案
### local
- 先在本地库回放已有 migration。
- 再逐批执行新增 migration。
- 每批完成后执行 schema 对比与关键 API 冒烟。
### test
- 按 local 已验证通过的批次顺序执行。
- 保留每批执行前后的表结构快照。
- 若发现 drift 或兼容问题,先暂停后续批次。
## 5. 阶段 2 目标
- 明确每类表的 migration 补齐范围。
- 明确执行顺序和批次边界。
- 为后续正式补 migration 提供可直接执行的方案基础。

View File

@ -1,107 +0,0 @@
# migration_gap_list
更新时间: 2026-03-22
## 1. 现状摘要
- migration 文件数: 11
- SequelizeMeta 已执行数: 7
- 仓库文件与执行记录差值: 4
- createTable 覆盖表数: 10
- DB 物理表数: 68
- 视图数: 2
## 2. 命名与顺序审计
- 现有 migration 文件命名整体符合“时间戳-动作-对象.js”规范。
- 当前 migration 主要集中在 2025-11 和 2026-03 两个时间段。
- 当前主要问题不是命名,而是覆盖率不足和执行状态漂移。
## 3. 执行状态漂移
以下 migration 文件存在于仓库,但未记录在 SequelizeMeta:
- 20251111083733-create-wms-stock-store.js
- 20251112085825-create-wms-entry-order.js
- 20251112085844-create-wms-entry-items.js
- 20260322061000-add-delivery-time-to-order-delivery-tables.js
说明:
- 当前数据库中相关表或字段已存在,说明存在“结构已生效但 migration 未登记”或“迁移在其他环境/手工执行过”的漂移风险。
- 后续处理时不能直接盲跑这些 migration,必须先做结构一致性核对。
## 4. 有 model 但缺 create migration 的表
- wms_account_platform_active (app/model/account_platform_active.js)
- wms_account_store_employee (app/model/account_store_employee.js)
- wms_employee_role (app/model/employee_role.js)
- wms_fast_where (app/model/fast_where.js)
- wms_file (app/model/file.js)
- wms_file_reference (app/model/file_reference.js)
- wms_i18n_keys (app/model/i18n_key.js)
- wms_i18n_translations (app/model/i18n_translation.js)
- wms_location_space (app/model/location_space.js)
- wms_location_type (app/model/location_type.js)
- wms_location_zone (app/model/location_zone.js)
- wms_operation_log (app/model/operation_log.js)
- wms_order_delivery (app/model/order_delivery.js)
- wms_order_items (app/model/order_items.js)
- wms_permission (app/model/permission.js)
- wms_platform (app/model/platform.js)
- wms_platfrom_setting (app/model/platform_setting.js)
- wms_print_computer (app/model/print_computer.js)
- wms_print_items (app/model/print_item.js)
- wms_print_record (app/model/print_record.js)
- wms_print_station_express (app/model/print_station_express.js)
- wms_print_stations (app/model/print_stations.js)
- wms_print_template (app/model/print_template.js)
- wms_prohibited_type (app/model/prohibited_type.js)
- wms_qimen_log (app/model/qimen_log.js)
- wms_receiving (app/model/receiving.js)
- wms_receiving_detail (app/model/receiving_detail.js)
- wms_role (app/model/role.js)
- wms_role_permission (app/model/role_permission.js)
- wms_stock_barcodes (app/model/stock_barcode.js)
- wms_stock_unit (app/model/stock_unit.js)
- wms_stock_warehouse (app/model/stock_warehouse.js)
- wms_storage (app/model/storage.js)
- wms_store_join (app/model/store_join.js)
## 5. 无 model 且无 create migration 的 DB 表
- SequelizeMeta
- wms_api_log
- wms_embargo_policies
- wms_express
- wms_express_print_record
- wms_express_setting
- wms_order_delivery_100000
- wms_order_delivery_1000028
- wms_order_express
- wms_order_express_print_data
- wms_order_items_100000
- wms_order_items_1000028
- wms_order_operation
- wms_order_operation_log
- wms_order_picking
- wms_picking_strategy
- wms_platform_print_config
- wms_print_batch
- wms_print_log
- wms_printer_config
- wms_system_config
- wms_system_log
- wms_wave_batch
- wms_wave_operation_log
## 6. 特殊对象说明
- 动态分表:
- wms_order_delivery_*
- wms_order_items_*
这类表不建议逐张固化 create migration,应通过“母表迁移 + 动态建表策略”统一治理。
- 视图:
- vw_warehouse_quota
- v_pick_space
需要单独使用 view migration 管理。
- SequelizeMeta 属于迁移元数据表,不纳入业务模型补齐范围。

View File

@ -1,105 +0,0 @@
# modelList
更新时间: 2026-03-22
扫描范围: app/model/*.js
模型文件数: 45
## 1. 目标
- 用于快速查看模型层级结构。
- 用于后续 model 命名规范、关联规范、迁移补全的基线输入。
## 2. 模型层级结构
```text
app/model/
├─ 账号与权限
│ ├─ account.js
│ ├─ account_platform_active.js
│ ├─ account_store_employee.js
│ ├─ employee_role.js
│ ├─ permission.js
│ ├─ role.js
│ └─ role_permission.js
├─ 组织与仓库
│ ├─ store.js
│ ├─ store_join.js
│ ├─ store_warehouse.js
│ ├─ storage.js
│ ├─ receiving.js
│ ├─ receiving_detail.js
│ ├─ entry_order.js
│ └─ entry_items.js
├─ 库位与查询
│ ├─ location_type.js
│ ├─ location_zone.js
│ ├─ location_space.js
│ └─ fast_where.js
├─ 库存与商品
│ ├─ stock_store.js
│ ├─ stock_warehouse.js
│ ├─ stock_unit.js
│ ├─ stock_barcode.js
│ └─ prohibited_type.js
├─ 订单与履约
│ ├─ order_delivery.js
│ ├─ order_items.js
│ ├─ order_delivery_factory.js
│ └─ order_items_factory.js
├─ 打印能力
│ ├─ print_template.js
│ ├─ print_item.js
│ ├─ print_record.js
│ ├─ print_stations.js
│ ├─ print_station_express.js
│ └─ print_computer.js
├─ 开放平台与接口
│ ├─ api_app.js
│ ├─ qimen_app.js
│ ├─ qimen_log.js
│ ├─ platform.js
│ ├─ platform_setting.js
│ └─ interface_type.js
└─ 文件、日志与国际化
├─ file.js
├─ file_reference.js
├─ operation_log.js
├─ i18n_key.js
└─ i18n_translation.js
```
## 3. 关键说明
### 3.1 动态分表模型
- order_delivery_factory.js
- 负责按 warehouse 维度动态创建/获取发货单模型。
- order_items_factory.js
- 负责按 warehouse 维度动态创建/获取订单商品模型。
说明:
- 这两个文件不是普通静态 Sequelize 定义文件,而是动态模型工厂能力。
### 3.2 典型关联模型
- fast_where.js
- 自关联: parent/children。
- location_zone.js
- 自关联 + 与 Store、LocationSpace 的关联。
- i18n_translation.js
- 关联 i18n_key。
- prohibited_type.js
- 关联 Store、StockWarehouse。
- stock_barcode.js
- 关联 StockWarehouse。
### 3.3 命名现状观察
- define 名称存在 snake_case 与 PascalCase 混用。
- 部分模型文件命名与 define 名称不完全一致。
- 后续需结合 model_naming_standard 做统一收敛。
## 4. 后续维护规则
- 每次新增/删除/重命名 model 文件后,需同步更新本文件。
- 每次新增/调整关联后,需同步更新本文件的关键说明章节。

View File

@ -1,52 +0,0 @@
# model_association_inventory
Updated: 2026-03-22
Source: app/model/*.js
| key | file | associations |
| --- | --- | --- |
| account_platform_active | app/model/account_platform_active.js | - |
| account_store_employee | app/model/account_store_employee.js | - |
| account | app/model/account.js | - |
| api_app | app/model/api_app.js | - |
| employee_role | app/model/employee_role.js | - |
| entry_items | app/model/entry_items.js | - |
| entry_order | app/model/entry_order.js | - |
| fast_where | app/model/fast_where.js | belongsTo->FastWhere, hasMany->FastWhere |
| file_reference | app/model/file_reference.js | - |
| file | app/model/file.js | - |
| i18n_key | app/model/i18n_key.js | - |
| i18n_translation | app/model/i18n_translation.js | belongsTo->I18nKey |
| interface_type | app/model/interface_type.js | - |
| location_space | app/model/location_space.js | - |
| location_type | app/model/location_type.js | belongsTo->Store |
| location_zone | app/model/location_zone.js | belongsTo->LocationZone, hasMany->LocationZone, belongsTo->Store, hasMany->LocationSpace |
| operation_log | app/model/operation_log.js | - |
| order_delivery_factory | app/model/order_delivery_factory.js | - |
| order_delivery | app/model/order_delivery.js | - |
| order_items_factory | app/model/order_items_factory.js | - |
| order_items | app/model/order_items.js | - |
| permission | app/model/permission.js | - |
| platform_setting | app/model/platform_setting.js | - |
| platform | app/model/platform.js | - |
| print_computer | app/model/print_computer.js | - |
| print_item | app/model/print_item.js | - |
| print_record | app/model/print_record.js | - |
| print_station_express | app/model/print_station_express.js | - |
| print_stations | app/model/print_stations.js | - |
| print_template | app/model/print_template.js | - |
| prohibited_type | app/model/prohibited_type.js | belongsTo->Store, hasMany->StockWarehouse |
| qimen_app | app/model/qimen_app.js | - |
| qimen_log | app/model/qimen_log.js | - |
| receiving_detail | app/model/receiving_detail.js | - |
| receiving | app/model/receiving.js | - |
| role_permission | app/model/role_permission.js | - |
| role | app/model/role.js | - |
| stock_barcode | app/model/stock_barcode.js | belongsTo->StockWarehouse |
| stock_store | app/model/stock_store.js | - |
| stock_unit | app/model/stock_unit.js | - |
| stock_warehouse | app/model/stock_warehouse.js | - |
| storage | app/model/storage.js | - |
| store_join | app/model/store_join.js | - |
| store_warehouse | app/model/store_warehouse.js | - |
| store | app/model/store.js | - |

View File

@ -1,105 +0,0 @@
# model_boundary_rules
更新时间: 2026-03-23
适用范围: app/model/**/*.js
目标: 约束 model 层仅承担数据映射与轻量领域行为,避免业务编排回流到模型层。
## 1. 当前盘点结果(阶段 5.3)
- hooks:
- app/model/entry_items.js
- EntryItems.beforeSave
- EntryItems.beforeUpdate
- scopes:
- app/model/print_item.js
- tableFields
- groupFields
- active
- byBusiness
- byPlatform
- virtual fields:
- 当前未检出 DataTypes.VIRTUAL / VIRTUAL 字段定义。
结论:
- 目前模型层 hooks/scopes 使用量较低,适合在当前阶段一次性固化边界规则。
## 2. 模型层职责边界
模型层允许:
- 表结构映射(字段、索引、注释、主键、表名映射)。
- 关联定义(belongsTo/hasMany/hasOne/belongsToMany)与关联语义辅助。
- 轻量实例行为(如 isEnabled/isExpired/getProgress 等纯实例判断)。
- 与单行数据一致性相关的同步校验(例如数量非负、上下限关系)。
模型层禁止:
- 跨表业务编排(批量流转、聚合统计、分配策略、权限树组装)。
- 事务边界控制(begin/commit/rollback)与重试策略。
- 外部副作用(调用第三方接口、写 Redis、发消息、发通知)。
- 依赖请求上下文(ctx、当前登录人、租户动态鉴权)。
## 3. Hooks 规则
允许场景:
- 单行数据写入前的确定性校验。
- 无 I/O 的轻量数据规整(例如 trim、默认值兜底)。
禁止场景:
- hook 中查询其他 model 决定业务分支。
- hook 中进行跨记录批处理或库存/权限编排。
- hook 中访问 service、http、cache、mq。
实现要求:
- 必须保持幂等与可重复执行安全。
- 必须是低成本逻辑,避免在热路径引入重查询。
- 错误信息聚焦数据约束,不承载业务流程语义。
## 4. Scopes 规则
允许场景:
- 静态筛选片段复用(状态、业务类型、平台等)。
- 参数化但纯查询片段的 where 条件构造。
禁止场景:
- 将权限判断或业务流程分支下沉到 scope。
- 在 scope 中拼装复杂 include 链并耦合排序/分页策略。
- 在 scope 中引入时间窗口策略或上下文依赖(如当前用户、当前 project)。
实现要求:
- scope 输出应稳定、可预期、可独立单测。
- 命名必须体现过滤语义,不使用模糊命名。
## 5. Virtual Fields 规则
允许场景:
- 展示层只读衍生值(字段拼接、标签映射、轻量格式化)。
禁止场景:
- virtual getter 内进行数据库查询或异步调用。
- 承载鉴权、状态流转或可写业务语义。
实现要求:
- 明确只读语义,不作为持久化字段参与写入。
- 若需要跨表推导,改由 service 返回 DTO 字段。
## 6. 现有代码归属说明
- app/model/entry_items.js hooks 保留原因:
- 仅执行已收货数量与计划数量的单行一致性校验。
- 未引入跨表查询、事务或副作用,符合模型边界。
- app/model/print_item.js scopes 保留原因:
- 仅复用静态筛选条件,不承载业务编排。
- 范围清晰,可作为查询片段复用。
## 7. 变更准入清单(新增/修改 model 时必须检查)
- 是否引入了跨表编排逻辑?若是,必须移至 app/service/systems/*。
- 是否引入了事务控制?若是,必须移至 service。
- 是否新增 hook 且包含 I/O?若是,不允许合入。
- 是否新增 scope 且耦合业务流程/鉴权?若是,不允许合入。
- 是否新增 virtual 并依赖查询/异步?若是,不允许合入。
## 8. 与阶段计划的映射
- 阶段 5.3: 已完成(盘点 + 规则固化)。
- 阶段 5.4: 基于本文件持续执行审查,作为后续模型改动的门禁依据。

View File

@ -1,292 +0,0 @@
# 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 及时阻断。

View File

@ -1,53 +0,0 @@
# model_inventory
Updated: 2026-03-22
Source: app/model/*.js
Count: 45
| key | file | defineName | tableName | kind |
| --- | --- | --- | --- | --- |
| account_platform_active | app/model/account_platform_active.js | account_platform_active | wms_account_platform_active | Model |
| account_store_employee | app/model/account_store_employee.js | wms_account_store_employee | wms_account_store_employee | Model |
| account | app/model/account.js | account | wms_account | Model |
| api_app | app/model/api_app.js | api_app | wms_api_app | Model |
| employee_role | app/model/employee_role.js | employee_role | wms_employee_role | Model |
| entry_items | app/model/entry_items.js | wms_entry_items | wms_entry_items | Model |
| entry_order | app/model/entry_order.js | wms_entry_order | wms_entry_order | Model |
| fast_where | app/model/fast_where.js | fast_where | wms_fast_where | Model |
| file_reference | app/model/file_reference.js | wms_file_reference | wms_file_reference | Model |
| file | app/model/file.js | wms_file | wms_file | Model |
| i18n_key | app/model/i18n_key.js | wms_i18n_key | wms_i18n_keys | Model |
| i18n_translation | app/model/i18n_translation.js | wms_i18n_translation | wms_i18n_translations | Model |
| interface_type | app/model/interface_type.js | interface_type | wms_interface_type | Model |
| location_space | app/model/location_space.js | wms_location_space | wms_location_space | Model |
| location_type | app/model/location_type.js | location_type | wms_location_type | Model |
| location_zone | app/model/location_zone.js | wms_location_zone | wms_location_zone | Model |
| operation_log | app/model/operation_log.js | operation_log | wms_operation_log | Model |
| order_delivery_factory | app/model/order_delivery_factory.js | - | - | Factory |
| order_delivery | app/model/order_delivery.js | order_delivery | wms_order_delivery | Model |
| order_items_factory | app/model/order_items_factory.js | - | - | Factory |
| order_items | app/model/order_items.js | wms_order_items | wms_order_items | Model |
| permission | app/model/permission.js | permission | wms_permission | Model |
| platform_setting | app/model/platform_setting.js | platform_setting | wms_platfrom_setting | Model |
| platform | app/model/platform.js | platform | wms_platform | Model |
| print_computer | app/model/print_computer.js | print_computer | wms_print_computer | Model |
| print_item | app/model/print_item.js | print_item | wms_print_items | Model |
| print_record | app/model/print_record.js | PrintRecord | wms_print_record | Model |
| print_station_express | app/model/print_station_express.js | print_station_express | wms_print_station_express | Model |
| print_stations | app/model/print_stations.js | print_stations | wms_print_stations | Model |
| print_template | app/model/print_template.js | print_template | wms_print_template | Model |
| prohibited_type | app/model/prohibited_type.js | prohibitedType | wms_prohibited_type | Model |
| qimen_app | app/model/qimen_app.js | qimen_app | wms_qimen_apps | Model |
| qimen_log | app/model/qimen_log.js | qimen_log | wms_qimen_log | Model |
| receiving_detail | app/model/receiving_detail.js | wms_receiving_detail | wms_receiving_detail | Model |
| receiving | app/model/receiving.js | wms_receiving | wms_receiving | Model |
| role_permission | app/model/role_permission.js | role_permission | wms_role_permission | Model |
| role | app/model/role.js | role | wms_role | Model |
| stock_barcode | app/model/stock_barcode.js | stock_barcodes | wms_stock_barcodes | Model |
| stock_store | app/model/stock_store.js | stock_store | wms_stock_store | Model |
| stock_unit | app/model/stock_unit.js | wms_stock_unit | wms_stock_unit | Model |
| stock_warehouse | app/model/stock_warehouse.js | stock_warehouse | wms_stock_warehouse | Model |
| storage | app/model/storage.js | wms_storage | wms_storage | Model |
| store_join | app/model/store_join.js | StoreJoin | wms_store_join | Model |
| store_warehouse | app/model/store_warehouse.js | store_warehouse | wms_store_warehouse | Model |
| store | app/model/store.js | store | wms_store | Model |

View File

@ -1,184 +0,0 @@
# Model 命名规范
更新时间: 2026-03-22
适用范围: app/model、app/service、app/controller 中的 app.model / ctx.model 调用
## 1. 目标
- 统一 model 文件名、运行时 key、defineName、tableName、关联 alias 的命名规则。
- 将“可直接收敛的风格问题”和“会影响业务语义的结构问题”拆开处理。
- 为阶段 4 的关联规范化和阶段 5 的模型能力清理提供稳定基线。
## 2. 五层命名对象
当前仓库里,单个模型至少同时存在以下 5 个命名层:
1. 文件名: app/model 下的文件名。
2. 运行时 key: 代码里通过 app.model.Xxx / ctx.model.Xxx 使用的名称。
3. defineName: Sequelize 的 app.model.define(name, attributes, options) 第一个参数。
4. tableName: options.tableName,对应数据库真实对象名。
5. alias: 关联查询里的 as 字段。
后续规范要求这 5 层职责分离,不再互相混用。
## 3. 统一规则
### 3.1 文件名
- 一律使用 snake_case。
- 文件名表达“模型职责”,不表达数据库前缀。
- 工厂模型必须以 _factory 结尾。
- 除非是稳定历史兼容项,否则不在文件名中保留 wms 前缀。
示例:
- account_store_employee.js
- platform_setting.js
- order_delivery_factory.js
### 3.2 运行时 key
- 一律使用 PascalCase。
- 运行时 key 由文件名去掉扩展名后转为 PascalCase。
- 这是 service/controller/model 之间的主兼容面,优先级高于 defineName。
- 工厂模型保留 Factory 后缀。
示例:
- account_store_employee.js -> AccountStoreEmployee
- platform_setting.js -> PlatformSetting
- order_delivery_factory.js -> OrderDeliveryFactory
### 3.3 defineName
- 静态模型的 defineName 必须与运行时 key 保持一致。
- 不再使用 snake_case、wms_ 前缀或局部 lowerCamelCase 作为 defineName。
- 动态分表模型允许在运行时使用真实 tableName 作为 defineName,但外部只允许通过工厂 key 获取,不直接在业务层引用动态 defineName。
示例:
- PlatformSetting: 正确
- platform_setting: 不再推荐
- prohibitedType: 不再推荐
- wms_account_store_employee: 不再推荐
### 3.4 tableName
- tableName 只负责映射数据库真实对象。
- 一律保持数据库现状,不因 model 命名规范化而强制修改表名。
- 物理表继续保留现有 wms_ 前缀、复数形式、历史拼写问题。
- 视图、动态分表、历史表单独记录,不纳入静态命名统一的修改范围。
示例:
- PlatformSetting -> tableName: wms_platfrom_setting
- StockBarcode -> tableName: wms_stock_barcodes
- PrintStations -> tableName: wms_print_stations
说明:
- tableName 中的历史拼写错误属于数据库治理问题,不属于本阶段命名规范化问题。
### 3.5 alias
- belongsTo / hasOne 使用 lowerCamelCase 单数。
- hasMany / belongsToMany 使用 lowerCamelCase 复数。
- alias 反映关联语义,不复用旧表名或旧模型名。
- alias 必须与真实关系一致,不能把 employee 关系继续命名为 role。
示例:
- belongsTo(Store, { as: 'store' })
- hasMany(EmployeeRole, { as: 'employeeRoles' })
- belongsTo(AccountStoreEmployee, { as: 'accountStoreEmployee' })
## 4. 兼容优先级
按风险从高到低分三类处理:
### A 类: 运行时 key 不存在或调用错误
- 必须先修。
- 这类问题会直接导致运行时取不到模型,或拿到错误关联。
- 典型例子:
- AccountStoreRole
- WmsOrderDeliveryFactory
- WmsOrderItemsFactory
### B 类: defineName 不规范但运行时可用
- 可分批修。
- 前提是 tableName 已显式声明,且不存在依赖 defineName 字符串的外部逻辑。
- 典型例子:
- platform_setting
- qimen_app
- qimen_log
- prohibitedType
- stock_barcodes
### C 类: alias 与业务语义不一致
- 必须与阶段 4 一起处理。
- 不能只改 alias 文本,需要一起核对外键、include、返回结构。
- 典型例子:
- accountStoreRoles
- accountStoreRole
- employeeRole
## 5. 仓库内落地规则
### 5.1 本项目允许保留的历史兼容项
以下项目前阶段不因“风格统一”而强制改文件名:
- print_stations.js
- 原因: 运行时大量使用 PrintStations,且 tableName 为 wms_print_stations。
- store_join.js
- 原因: 运行时与 defineName 已一致,当前主要问题不在命名层。
- order_delivery_factory.js / order_items_factory.js
- 原因: 工厂职责明确,外部兼容面稳定。
### 5.2 本项目必须执行的统一动作
- 所有静态模型的 defineName 逐步收敛到 PascalCase 运行时 key。
- 所有业务代码统一通过 ctx.model.Xxx / app.model.Xxx 的 PascalCase key 调用。
- 任何 include/as 字段都必须与当前模型关联定义一致。
- 不再新增任何带 wms 前缀的 defineName。
- 不再新增任何与真实语义不一致的 alias。
## 6. 参考示例
### 6.1 标准静态模型
- 文件名: platform_setting.js
- 运行时 key: PlatformSetting
- defineName: PlatformSetting
- tableName: wms_platfrom_setting
### 6.2 标准关联模型
- 文件名: account_store_employee.js
- 运行时 key: AccountStoreEmployee
- defineName: AccountStoreEmployee
- tableName: wms_account_store_employee
- alias:
- belongsTo(Account, { as: 'account' })
- belongsTo(Store, { as: 'store' })
- hasMany(EmployeeRole, { as: 'employeeRoles' })
### 6.3 标准工厂模型
- 文件名: order_delivery_factory.js
- 运行时 key: OrderDeliveryFactory
- 对外入口:
- ctx.model.OrderDeliveryFactory.getCurrentModel(warehouseId)
- ctx.model.OrderDeliveryFactory.getHistoryModel(warehouseId)
- 约束:
- 业务代码不直接引用动态表 defineName。
## 7. 执行边界
- 本阶段先统一标准、映射和影响面,不直接大规模改名。
- 运行时 key 修复优先于 defineName 收敛。
- alias 修复必须与关联关系校验一起推进。
- 数据库表名不在本阶段统一修改范围内。

View File

@ -1,100 +0,0 @@
# Model 重命名映射表
更新时间: 2026-03-22
来源:
- model_inventory.md
- app/model/*.js
- app/service/**/*.js
- app/controller/**/*.js
## 1. 使用说明
- 本表只记录阶段 3 已确认的命名规范化项。
- 变更级别分为 4 类:
- P0-调用修复: 现有代码引用错误或运行时 key 不存在,必须先修。
- P1-defineName 收敛: 只调整 defineName,不动文件名和 tableName。
- P2-alias 收敛: 需要和关联定义一起调整。
- 保持不动: 暂不建议改动。
## 2. P0: 必须先修的运行时调用
| 当前调用/命名 | 建议标准名 | 变更级别 | 原因 | 备注 |
| --- | --- | --- | --- | --- |
| WmsOrderDeliveryFactory | OrderDeliveryFactory | P0-调用修复 | 仓库内主流调用均为 OrderDeliveryFactory,当前写法与文件名不匹配 | 先修 app/service/apiMethods/test.js |
| WmsOrderItemsFactory | OrderItemsFactory | P0-调用修复 | 仓库内主流调用均为 OrderItemsFactory,当前写法与文件名不匹配 | 先修 app/service/apiMethods/test.js |
| AccountStoreRole | AccountStoreEmployee 或补回独立模型 | P0-调用修复 | 仓库内无 account_store_role.js,且当前表结构已落到 account_store_employee + employee_role | 需要先确认目标数据关系 |
| accountStoreRole | accountStoreEmployee | P0-调用修复 | AccountPlatformActive 当前关联 alias 为 accountStoreEmployee,service 仍按 accountStoreRole 取值 | 要与 include 返回结构一起改 |
## 3. P1: defineName 收敛为运行时 key
以下项优先采用“只改 defineName,不改文件名、不改 tableName”的方式收敛。
| 文件 | 当前运行时 key | 当前 defineName | 建议 defineName | 变更级别 |
| --- | --- | --- | --- | --- |
| app/model/account_platform_active.js | AccountPlatformActive | account_platform_active | AccountPlatformActive | P1-defineName 收敛 |
| app/model/account_store_employee.js | AccountStoreEmployee | wms_account_store_employee | AccountStoreEmployee | P1-defineName 收敛 |
| app/model/account.js | Account | account | Account | P1-defineName 收敛 |
| app/model/api_app.js | ApiApp | api_app | ApiApp | P1-defineName 收敛 |
| app/model/employee_role.js | EmployeeRole | employee_role | EmployeeRole | P1-defineName 收敛 |
| app/model/entry_items.js | EntryItems | wms_entry_items | EntryItems | P1-defineName 收敛 |
| app/model/entry_order.js | EntryOrder | wms_entry_order | EntryOrder | P1-defineName 收敛 |
| app/model/fast_where.js | FastWhere | fast_where | FastWhere | P1-defineName 收敛 |
| app/model/file_reference.js | FileReference | wms_file_reference | FileReference | P1-defineName 收敛 |
| app/model/file.js | File | wms_file | File | P1-defineName 收敛 |
| app/model/i18n_key.js | I18nKey | wms_i18n_key | I18nKey | P1-defineName 收敛 |
| app/model/i18n_translation.js | I18nTranslation | wms_i18n_translation | I18nTranslation | P1-defineName 收敛 |
| app/model/interface_type.js | InterfaceType | interface_type | InterfaceType | P1-defineName 收敛 |
| app/model/location_space.js | LocationSpace | wms_location_space | LocationSpace | P1-defineName 收敛 |
| app/model/location_type.js | LocationType | location_type | LocationType | P1-defineName 收敛 |
| app/model/location_zone.js | LocationZone | wms_location_zone | LocationZone | P1-defineName 收敛 |
| app/model/operation_log.js | OperationLog | operation_log | OperationLog | P1-defineName 收敛 |
| app/model/order_delivery.js | OrderDelivery | order_delivery | OrderDelivery | P1-defineName 收敛 |
| app/model/order_items.js | OrderItems | wms_order_items | OrderItems | P1-defineName 收敛 |
| app/model/permission.js | Permission | permission | Permission | P1-defineName 收敛 |
| app/model/platform_setting.js | PlatformSetting | platform_setting | PlatformSetting | P1-defineName 收敛 |
| app/model/platform.js | Platform | platform | Platform | P1-defineName 收敛 |
| app/model/print_computer.js | PrintComputer | print_computer | PrintComputer | P1-defineName 收敛 |
| app/model/print_item.js | PrintItem | print_item | PrintItem | P1-defineName 收敛 |
| app/model/print_station_express.js | PrintStationExpress | print_station_express | PrintStationExpress | P1-defineName 收敛 |
| app/model/print_stations.js | PrintStations | print_stations | PrintStations | P1-defineName 收敛 |
| app/model/print_template.js | PrintTemplate | print_template | PrintTemplate | P1-defineName 收敛 |
| app/model/prohibited_type.js | ProhibitedType | prohibitedType | ProhibitedType | P1-defineName 收敛 |
| app/model/qimen_app.js | QimenApp | qimen_app | QimenApp | P1-defineName 收敛 |
| app/model/qimen_log.js | QimenLog | qimen_log | QimenLog | P1-defineName 收敛 |
| app/model/receiving_detail.js | ReceivingDetail | wms_receiving_detail | ReceivingDetail | P1-defineName 收敛 |
| app/model/receiving.js | Receiving | wms_receiving | Receiving | P1-defineName 收敛 |
| app/model/role_permission.js | RolePermission | role_permission | RolePermission | P1-defineName 收敛 |
| app/model/role.js | Role | role | Role | P1-defineName 收敛 |
| app/model/stock_barcode.js | StockBarcode | stock_barcodes | StockBarcode | P1-defineName 收敛 |
| app/model/stock_store.js | StockStore | stock_store | StockStore | P1-defineName 收敛 |
| app/model/stock_unit.js | StockUnit | wms_stock_unit | StockUnit | P1-defineName 收敛 |
| app/model/stock_warehouse.js | StockWarehouse | stock_warehouse | StockWarehouse | P1-defineName 收敛 |
| app/model/storage.js | Storage | wms_storage | Storage | P1-defineName 收敛 |
| app/model/store_warehouse.js | StoreWarehouse | store_warehouse | StoreWarehouse | P1-defineName 收敛 |
| app/model/store.js | Store | store | Store | P1-defineName 收敛 |
## 4. 保持不动或低优先级处理项
| 文件 | 当前运行时 key | 当前 defineName | 建议 | 说明 |
| --- | --- | --- | --- | --- |
| app/model/order_delivery_factory.js | OrderDeliveryFactory | 动态 tableName | 保持不动 | 工厂模型,不参与静态 defineName 收敛 |
| app/model/order_items_factory.js | OrderItemsFactory | 动态 tableName | 保持不动 | 工厂模型,不参与静态 defineName 收敛 |
| app/model/print_record.js | PrintRecord | PrintRecord | 保持不动 | 已符合标准 |
| app/model/store_join.js | StoreJoin | StoreJoin | 保持不动 | 已符合标准 |
## 5. P2: alias 收敛候选
| 位置 | 当前 alias | 建议 alias | 变更级别 | 说明 |
| --- | --- | --- | --- | --- |
| app/model/account.js | accountStoreRoles | accountStoreEmployees | P2-alias 收敛 | 当前关联对象实际为 AccountStoreEmployee |
| app/model/account_platform_active.js | accountStoreEmployee | accountStoreEmployee | 保持 | 当前 alias 合理,问题在 service 调用侧 |
| app/model/account_store_employee.js | employeeRole | employeeRoles | P2-alias 收敛 | hasMany 建议使用复数 |
| app/model/store.js | accountStoreEmployee | accountStoreEmployees | P2-alias 收敛 | hasMany 建议使用复数 |
| app/model/role.js | employeeRole | employeeRoles | P2-alias 收敛 | hasMany 建议使用复数 |
## 6. 执行顺序建议
1. 先修 P0 调用错误,保证所有 ctx.model / app.model 均能拿到正确对象。
2. 再做 P1 defineName 收敛,限定在显式声明了 tableName 的静态模型。
3. 最后做 P2 alias 收敛,并与阶段 4 的关联核对同步执行。

View File

@ -1,168 +0,0 @@
# Model 命名影响评估报告
更新时间: 2026-03-22
范围:
- app/model/*.js
- app/service/**/*.js
- app/controller/**/*.js
## 1. 结论摘要
当前命名问题分成两层:
1. 真正会影响运行的调用错误。
2. 还能运行,但会持续制造理解成本和后续重构风险的 defineName/alias 漂移。
本轮确认的最高优先级风险有 3 个:
### 1.1 AccountStoreRole 是仓库内不存在的运行时 key
- 代码大量使用 ctx.model.AccountStoreRole。
- app/model 下没有对应的 account_store_role.js。
- 现有 schema 已落到 AccountStoreEmployee + EmployeeRole 两层关系。
- 这不是单纯命名风格问题,而是“旧关系名残留到新模型结构”的兼容断层。
### 1.2 动态分表工厂存在一组错误调用名
- 仓库主流调用是 OrderDeliveryFactory / OrderItemsFactory。
- 仅 app/service/apiMethods/test.js 仍在使用 WmsOrderDeliveryFactory / WmsOrderItemsFactory。
- 这会导致测试/调试路径与正式业务路径使用不同的模型入口。
### 1.3 alias 已经切到 employee 语义,但 service 仍按 role 语义取值
- app/model/account_platform_active.js 中 alias 是 accountStoreEmployee。
- 但 app/service/systems/account_platform.js 仍按 accountStoreRole 进行 include 和结果读取。
- 这说明 model 层与 service 层对同一关系的语义认知已经分叉。
## 2. 关键证据
### 2.1 不存在的 model key: AccountStoreRole
受影响位置:
- app/service/systems/account_platform.js:21
- app/service/systems/account_platform.js:102
- app/service/systems/account_platform.js:169
- app/service/systems/account_platform.js:226
- app/service/systems/account_platform.js:321
- app/service/systems/store.js:464
- app/service/systems/store.js:679
- app/service/systems/store.js:690
- app/model/role.js:151
现状说明:
- app/model/account_store_employee.js:6 定义的是 AccountStoreEmployee,表为 wms_account_store_employee。
- app/model/account_store_employee.js:82-99 说明当前关系是 AccountStoreEmployee -> EmployeeRole -> Role。
- app/model/account_platform_active.js:79-86 已把激活关系关联到 AccountStoreEmployee。
风险判断:
- 如果继续沿用 AccountStoreRole,后续关联收敛会同时破坏 include、字段读取、缓存结构与返回结构。
- 该问题必须在正式改 defineName 之前先做数据关系确认。
建议动作:
1. 先确认“平台激活”想绑定的是员工记录还是员工-角色明细。
2. 若绑定员工记录,则将 AccountStoreRole 全量替换为 AccountStoreEmployee,并改造 role 读取路径。
3. 若绑定员工-角色明细,则需要新增独立模型,而不是继续使用幽灵 key。
### 2.2 动态工厂 key 调用漂移
正常调用样本:
- app/service/systemMethods/order.js:22-23
- app/service/systems/delivery_order.js:14
- app/service/systems/delivery_order.js:311
- app/service/qimenMethods/deliveryorder.js:7-8
异常调用样本:
- app/service/apiMethods/test.js:50
- app/service/apiMethods/test.js:51
风险判断:
- 正式链路与调试链路的 model 入口不一致,后续如果只修主链路,测试链路会继续漂移。
- 这是低成本高收益修复项,应优先纳入第一批代码修正。
建议动作:
1. 将 WmsOrderDeliveryFactory 改为 OrderDeliveryFactory。
2. 将 WmsOrderItemsFactory 改为 OrderItemsFactory。
3. 回归验证动态表 current/history 获取能力是否一致。
### 2.3 alias 与语义漂移
证据位置:
- app/model/account.js:139 使用 alias accountStoreRoles,但实际模型是 AccountStoreEmployee。
- app/model/account_platform_active.js:84 使用 alias accountStoreEmployee。
- app/model/account_store_employee.js:95 使用 hasMany(EmployeeRole, { as: 'employeeRole' })。
- app/model/role.js:171 使用 hasMany(EmployeeRole, { as: 'employeeRole' })。
- app/service/systems/account_platform.js:102-136 仍按 accountStoreRole 读取嵌套字段。
风险判断:
- 当前 alias 命名混合了“员工关系”和“角色关系”两种语义。
- 若不先统一语义,后续只做名字替换会把问题从命名层转移到数据层。
建议动作:
1. 阶段 4 先梳理 employee、role、store 三者的真实关系。
2. hasMany alias 收敛为复数形式,如 employeeRoles、accountStoreEmployees。
3. service 层返回结构与 include 路径同步改名,避免只改 model 不改消费方。
## 3. defineName 漂移影响
以下问题当前通常不会直接导致运行失败,但会持续造成阅读成本与重构误判:
| 文件 | 证据 | 当前情况 | 风险 |
| --- | --- | --- | --- |
| app/model/platform_setting.js | :7 | defineName 为 platform_setting,运行时 key 为 PlatformSetting | 阅读时容易误以为 key 与 defineName 同名 |
| app/model/qimen_app.js | :6 | defineName 为 qimen_app,运行时 key 为 QimenApp | service 调用与模型定义风格分裂 |
| app/model/qimen_log.js | :8 | defineName 为 qimen_log,运行时 key 为 QimenLog | 日志模型定位成本高 |
| app/model/account_store_employee.js | :6 | defineName 为 wms_account_store_employee,运行时 key 为 AccountStoreEmployee | 将表名语义混入模型名 |
| app/model/stock_barcode.js | :6 | defineName 为 stock_barcodes,运行时 key 为 StockBarcode | 单复数与 key 同时漂移 |
| app/model/prohibited_type.js | :6 | defineName 为 prohibitedType,运行时 key 为 ProhibitedType | lowerCamelCase 与 PascalCase 混用 |
| app/model/print_stations.js | :5 | defineName 为 print_stations,运行时 key 为 PrintStations | 虽可运行,但风格不统一 |
影响判断:
- 新增 include、调试 SQL、追踪关联时,很容易把 defineName、key、tableName 当成同一件事。
- 后续如果继续新增 snake_case defineName,会放大维护面。
建议动作:
1. 先完成 P0 调用修复。
2. 再按 model_rename_map.md 分批将 defineName 收敛到 PascalCase。
3. 每次改 defineName 后,回归关联加载与 SQL 日志输出,确认未引入隐式副作用。
## 4. 稳定项与例外项
以下命名虽然不完全理想,但当前不建议仅因风格而改动:
- app/model/print_record.js
- defineName 已为 PrintRecord,运行时 key 与之保持一致。
- app/model/store_join.js
- defineName 已为 StoreJoin,当前问题主要不在命名层。
- app/model/order_delivery_factory.js
- 工厂模型对外 key 稳定,重点是调用方统一。
- app/model/order_items_factory.js
- 工厂模型对外 key 稳定,重点是调用方统一。
- app/model/print_stations.js
- 文件名和表名均为复数,当前更适合先保留为历史兼容项,不单独改文件名。
## 5. 推荐执行顺序
1. 第一批: 修正不存在的运行时 key 和错误工厂调用名。
2. 第二批: 收敛静态模型 defineName,保持 tableName 不变。
3. 第三批: 在关联核对完成后统一 alias 和 include 路径。
4. 第四批: 更新测试、README、modelList.md、关联清单等文档。
## 6. 对后续阶段的输入
- 阶段 4 需要重点核对 AccountPlatformActive、AccountStoreEmployee、EmployeeRole、Role、Store 的外键与 include 结构。
- 阶段 5 需要顺带清理与命名漂移绑定的死代码、调试日志和旧语义变量名。
- 阶段 6 验证时必须覆盖平台激活、仓库角色分配、动态订单分表、打印链路四类高风险场景。

View File

@ -1,104 +0,0 @@
# role_permission_fk_data_cleanup_plan
更新时间: 2026-03-23
目标: 清理 role/permission 相关孤儿数据,解除 `20260323103000-align-role-permission-fk.js` 执行阻塞。
## 1. 审计现状
- `wms_role_permission.permission_id` 孤儿记录: 4 条(id: 2, 3, 6, 10)
- `wms_role.store_id` 非法哨兵值: 3 条(store_id = 0)
- 字段类型差异:
- `wms_permission.id`: `int(11)`
- `wms_role_permission.permission_id`: `bigint(20) unsigned`(迁移已处理为对齐)
## 2. 执行顺序
1. 备份孤儿数据
2. 删除 `wms_role_permission` 孤儿行
3. 规范 `wms_role.store_id = 0` 为 `NULL`(仅对可空字段)
4. 复核计数
5. 执行迁移 `20260323103000-align-role-permission-fk.js`
## 3. 推荐 SQL(先在测试环境执行)
### 3.1 备份 role_permission 孤儿行
```sql
CREATE TABLE IF NOT EXISTS wms_role_permission_orphan_backup_20260323 AS
SELECT rp.*
FROM wms_role_permission rp
LEFT JOIN wms_permission p ON p.id = rp.permission_id
WHERE p.id IS NULL;
```
### 3.2 删除 role_permission 孤儿行
```sql
DELETE rp
FROM wms_role_permission rp
LEFT JOIN wms_permission p ON p.id = rp.permission_id
WHERE p.id IS NULL;
```
### 3.3 规范 role.store_id 哨兵值
```sql
UPDATE wms_role
SET store_id = NULL
WHERE store_id = 0;
```
### 3.4 复核
```sql
SELECT 'rp_perm_orphan' AS metric, COUNT(*) AS cnt
FROM wms_role_permission rp
LEFT JOIN wms_permission p ON p.id = rp.permission_id
WHERE p.id IS NULL
UNION ALL
SELECT 'role_store_zero' AS metric, COUNT(*) AS cnt
FROM wms_role
WHERE store_id = 0;
```
## 4. 回滚思路
- 若删除孤儿行后需要回滚,可从备份表恢复:
```sql
INSERT INTO wms_role_permission (id, role_id, permission_id, created_at)
SELECT id, role_id, permission_id, created_at
FROM wms_role_permission_orphan_backup_20260323;
```
- `wms_role.store_id` 从 `0 -> NULL` 回滚需结合业务语义,不建议盲目全量回写 `0`。
## 5. 交付门禁
清洗和迁移完成后,执行:
1. `node .\\script\\method-output-regression.cjs compare`
2. `node .\\script\\tmp-generate-method-regression-test.cjs`
3. `npx egg-bin test temp/generated-tests/system.method-output.generated.test.js`
4. `npx egg-bin test test/app/controller/system.user.login.test.js test/app/controller/system.user.info.test.js test/app/controller/home.test.js`
通过标准:
- compare: mismatch=0
- 回归测试: 全部通过
## 6. 执行记录(2026-03-23)
- 备份执行结果:
- `wms_role_permission_orphan_backup_20260323`: 4 行
- `wms_role_store_zero_backup_20260323`: 3 行
- 清洗执行结果:
- role_permission 孤儿删除: 4 行
- role.store_id=0 -> NULL: 3 行
- 迁移执行结果:
- `wms_role_permission.permission_id` 已对齐为 `int(11)`
- 外键 `fk_wms_role_permission_permission` 已生效
- SequelizeMeta 已登记 `20260323103000-align-role-permission-fk.js`
- 门禁结果:
- method-output compare: mismatch=0
- generated regression + smoke: 14 passing

View File

@ -1,49 +0,0 @@
# rollback_plan
更新时间: 2026-03-22
## 1. 通用回滚规则
- 所有新增 migration 必须提供 down。
- 对现网已有表,down 不应默认直接 drop 整表。
- 优先回滚新增字段、索引、约束,避免误删存量数据。
- 涉及数据回填的 migration,必须保留影响范围快照或备份。
## 2. 分类型回滚策略
### 建表 migration
- 新环境可使用 dropTable 回滚。
- 现网已有表不建议通过 down 删除,应改为“标记基线 + 停止继续执行”。
### 加字段 migration
- down 使用 dropColumn。
- 执行前需确认字段不被线上代码强依赖。
### 索引 migration
- down 使用 removeIndex。
- 若为性能补丁索引,回滚前需评估查询退化风险。
### 视图 migration
- down 使用 drop view。
- 回滚前确认是否有查询依赖视图。
### 动态分表策略 migration
- 只回滚策略与模板,不批量 drop 已创建的仓库动态表。
- 已存在分表应通过单独治理,不纳入统一 down 删除范围。
## 3. 当前优先风险
- 未进入 SequelizeMeta 的 migration 不能按常规 down 处理,必须先确认其是否已在数据库中手工生效。
- order_delivery/order_items 主表与动态表结构存在差异,回滚时必须区分主表与动态表。
- 日志类表通常已有存量数据,回滚需要避免整表删除。
## 4. 建议执行前准备
- 每批 migration 执行前导出目标表结构快照。
- 若涉及数据变更,先做行数统计与影响范围确认。
- 为每批次准备单独回滚脚本,不依赖临场拼写 SQL。

View File

@ -1,93 +0,0 @@
# 根目录 Markdown 使用方与清理结果
生成时间: 2026-03-24
## 保留在根目录
- `README.md`
- 使用方: `model_todo.txt`
- 动作: 保留(项目入口文档)
- `AI_TOOLBOX.md`
- 使用方: `README.md`
- 动作: 保留(AI 协作工具箱)
- `AI_METHOD_ROUTING.md`
- 使用方: `AI_TOOLBOX.md`, `README.md`, `script/tmp-update-ai-method-routing.cjs`
- 动作: 保留(路由映射主文档)
## 迁移到 temp/docs(需要保留)
- `METHOD_OUTPUT_REGRESSION_20260322.md`
- 原使用方: `README.md`
- 新路径: `temp/docs/METHOD_OUTPUT_REGRESSION_20260322.md`
- `SERVICE_API_CHANGE_AUDIT_20260322.md`
- 原使用方: `model_todo.txt`
- 新路径: `temp/docs/SERVICE_API_CHANGE_AUDIT_20260322.md`
- `association_eager_loading_n_plus_one_guideline.md`
- 原使用方: `association_validation_checklist.md`, `model_todo.txt`, `SERVICE_API_CHANGE_AUDIT_20260322.md`
- 新路径: `temp/docs/association_eager_loading_n_plus_one_guideline.md`
- `association_fix_plan.md`
- 原使用方: `model_todo.txt`
- 新路径: `temp/docs/association_fix_plan.md`
- `association_fk_consistency_report.md`
- 原使用方: `association_validation_checklist.md`, `model_todo.txt`, `SERVICE_API_CHANGE_AUDIT_20260322.md`, `temp/audit-association-fk.cjs`
- 新路径: `temp/docs/association_fk_consistency_report.md`
- `association_validation_checklist.md`
- 原使用方: `model_todo.txt`, `SERVICE_API_CHANGE_AUDIT_20260322.md`
- 新路径: `temp/docs/association_validation_checklist.md`
- `migration_execution_plan.md`
- 原使用方: `model_todo.txt`
- 新路径: `temp/docs/migration_execution_plan.md`
- `migration_gap_list.md`
- 原使用方: `model_todo.txt`
- 新路径: `temp/docs/migration_gap_list.md`
- `modelList.md`
- 原使用方: `model_todo.txt`, `README.md`, `rename_impact_report.md`
- 新路径: `temp/docs/modelList.md`
- `model_association_inventory.md`
- 原使用方: `model_todo.txt`
- 新路径: `temp/docs/model_association_inventory.md`
- `model_boundary_rules.md`
- 原使用方: `model_cleanup_list.md`, `model_todo.txt`, `script/model-boundary-check.cjs`
- 新路径: `temp/docs/model_boundary_rules.md`
- `model_cleanup_list.md`
- 原使用方: `model_todo.txt`, `SERVICE_API_CHANGE_AUDIT_20260322.md`
- 新路径: `temp/docs/model_cleanup_list.md`
- `model_inventory.md`
- 原使用方: `model_rename_map.md`, `model_todo.txt`
- 新路径: `temp/docs/model_inventory.md`
- `model_naming_standard.md`
- 原使用方: `model_todo.txt`
- 新路径: `temp/docs/model_naming_standard.md`
- `model_rename_map.md`
- 原使用方: `model_todo.txt`, `rename_impact_report.md`
- 新路径: `temp/docs/model_rename_map.md`
- `rename_impact_report.md`
- 原使用方: `model_todo.txt`
- 新路径: `temp/docs/rename_impact_report.md`
- `role_permission_fk_data_cleanup_plan.md`
- 原使用方: `model_todo.txt`
- 新路径: `temp/docs/role_permission_fk_data_cleanup_plan.md`
- `rollback_plan.md`
- 原使用方: `model_todo.txt`
- 新路径: `temp/docs/rollback_plan.md`
- `schema_model_gap_report.md`
- 原使用方: `model_todo.txt`
- 新路径: `temp/docs/schema_model_gap_report.md`
- `table_schema_inventory.md`
- 原使用方: `model_todo.txt`
- 新路径: `temp/docs/table_schema_inventory.md`
## 已清理(不需要)
- `tmp-order-schema-workflow.md`
- 原使用方: 无
- 动作: 已从根目录删除(历史临时流程文档)
## 引用更新范围
- `README.md`
- `model_todo.txt`
- `script/model-boundary-check.cjs`
- `temp/audit-association-fk.cjs`
所有上述文件中的旧根目录引用已替换为 `temp/docs/*` 新路径。

View File

@ -1,98 +0,0 @@
# schema_model_gap_report
Updated: 2026-03-22
## Scope
- DB source: information_schema.TABLES / COLUMNS / STATISTICS
- Model source: app/model/*.js (tableName option)
## Count
- Model files: 45
- Model with tableName: 43
- DB tables: 68
- modelOnly table count: 0
- dbOnly table count: 25
## modelOnly tables
- none
## dbOnly tables
- SequelizeMeta
- wms_account_login_log
- wms_api_log
- wms_embargo_policies
- wms_express
- wms_express_print_record
- wms_express_setting
- wms_order_delivery_100000
- wms_order_delivery_1000028
- wms_order_express
- wms_order_express_print_data
- wms_order_items_100000
- wms_order_items_1000028
- wms_order_operation
- wms_order_operation_log
- wms_order_picking
- wms_picking_strategy
- wms_platform_print_config
- wms_print_batch
- wms_print_log
- wms_printer_config
- wms_system_config
- wms_system_log
- wms_wave_batch
- wms_wave_operation_log
## Model mapping snapshot
| key | file | defineName | tableName |
| --- | --- | --- | --- |
| account | app/model/account.js | account | wms_account |
| account_platform_active | app/model/account_platform_active.js | account_platform_active | wms_account_platform_active |
| account_store_employee | app/model/account_store_employee.js | wms_account_store_employee | wms_account_store_employee |
| api_app | app/model/api_app.js | api_app | wms_api_app |
| employee_role | app/model/employee_role.js | employee_role | wms_employee_role |
| entry_items | app/model/entry_items.js | wms_entry_items | wms_entry_items |
| entry_order | app/model/entry_order.js | wms_entry_order | wms_entry_order |
| fast_where | app/model/fast_where.js | fast_where | wms_fast_where |
| file | app/model/file.js | wms_file | wms_file |
| file_reference | app/model/file_reference.js | wms_file_reference | wms_file_reference |
| i18n_key | app/model/i18n_key.js | wms_i18n_key | wms_i18n_keys |
| i18n_translation | app/model/i18n_translation.js | wms_i18n_translation | wms_i18n_translations |
| interface_type | app/model/interface_type.js | interface_type | wms_interface_type |
| location_space | app/model/location_space.js | wms_location_space | wms_location_space |
| location_type | app/model/location_type.js | location_type | wms_location_type |
| location_zone | app/model/location_zone.js | wms_location_zone | wms_location_zone |
| operation_log | app/model/operation_log.js | operation_log | wms_operation_log |
| order_delivery | app/model/order_delivery.js | order_delivery | wms_order_delivery |
| order_delivery_factory | app/model/order_delivery_factory.js | - | - |
| order_items | app/model/order_items.js | wms_order_items | wms_order_items |
| order_items_factory | app/model/order_items_factory.js | - | - |
| permission | app/model/permission.js | permission | wms_permission |
| platform | app/model/platform.js | platform | wms_platform |
| platform_setting | app/model/platform_setting.js | platform_setting | wms_platfrom_setting |
| print_computer | app/model/print_computer.js | print_computer | wms_print_computer |
| print_item | app/model/print_item.js | print_item | wms_print_items |
| print_record | app/model/print_record.js | PrintRecord | wms_print_record |
| print_station_express | app/model/print_station_express.js | print_station_express | wms_print_station_express |
| print_stations | app/model/print_stations.js | print_stations | wms_print_stations |
| print_template | app/model/print_template.js | print_template | wms_print_template |
| prohibited_type | app/model/prohibited_type.js | prohibitedType | wms_prohibited_type |
| qimen_app | app/model/qimen_app.js | qimen_app | wms_qimen_apps |
| qimen_log | app/model/qimen_log.js | qimen_log | wms_qimen_log |
| receiving | app/model/receiving.js | wms_receiving | wms_receiving |
| receiving_detail | app/model/receiving_detail.js | wms_receiving_detail | wms_receiving_detail |
| role | app/model/role.js | role | wms_role |
| role_permission | app/model/role_permission.js | role_permission | wms_role_permission |
| stock_barcode | app/model/stock_barcode.js | stock_barcodes | wms_stock_barcodes |
| stock_store | app/model/stock_store.js | stock_store | wms_stock_store |
| stock_unit | app/model/stock_unit.js | wms_stock_unit | wms_stock_unit |
| stock_warehouse | app/model/stock_warehouse.js | stock_warehouse | wms_stock_warehouse |
| storage | app/model/storage.js | wms_storage | wms_storage |
| store | app/model/store.js | store | wms_store |
| store_join | app/model/store_join.js | StoreJoin | wms_store_join |
| store_warehouse | app/model/store_warehouse.js | store_warehouse | wms_store_warehouse |

View File

@ -1,85 +0,0 @@
# table_schema_inventory
Updated: 2026-03-22
Database: wms
Object count: 70
## Summary
- Tables: 68
- Views: 2
## Objects
| object | type | engine | collation | rows | columns | pk_cols | auto_inc | index_count |
| --- | --- | --- | --- | ---: | ---: | ---: | ---: | ---: |
| SequelizeMeta | TABLE | InnoDB | utf8_unicode_ci | 7 | 1 | 1 | 0 | 2 |
| vw_warehouse_quota | VIEW | - | - | - | 5 | 0 | 0 | 0 |
| v_pick_space | VIEW | - | - | - | 44 | 0 | 0 | 0 |
| wms_account | TABLE | InnoDB | utf8mb4_general_ci | 2 | 13 | 1 | 1 | 5 |
| wms_account_login_log | TABLE | InnoDB | utf8mb4_general_ci | 108 | 7 | 1 | 1 | 2 |
| wms_account_platform_active | TABLE | InnoDB | utf8mb4_general_ci | 3 | 5 | 2 | 0 | 5 |
| wms_account_store_employee | TABLE | InnoDB | utf8mb4_general_ci | 5 | 8 | 1 | 1 | 5 |
| wms_api_app | TABLE | InnoDB | utf8mb4_unicode_ci | 4 | 22 | 1 | 1 | 6 |
| wms_api_log | TABLE | InnoDB | utf8mb4_general_ci | 421 | 10 | 1 | 1 | 1 |
| wms_embargo_policies | TABLE | InnoDB | utf8mb4_unicode_ci | 0 | 13 | 1 | 1 | 5 |
| wms_employee_role | TABLE | InnoDB | utf8mb4_general_ci | 4 | 3 | 1 | 1 | 4 |
| wms_entry_items | TABLE | InnoDB | utf8mb4_general_ci | 2 | 12 | 1 | 1 | 3 |
| wms_entry_order | TABLE | InnoDB | utf8mb4_unicode_ci | 5 | 28 | 1 | 1 | 10 |
| wms_express | TABLE | InnoDB | utf8mb4_general_ci | 0 | 2 | 1 | 0 | 1 |
| wms_express_print_record | TABLE | InnoDB | utf8mb4_general_ci | 0 | 31 | 1 | 1 | 13 |
| wms_express_setting | TABLE | InnoDB | utf8mb4_general_ci | 0 | 4 | 1 | 1 | 3 |
| wms_fast_where | TABLE | InnoDB | utf8mb4_general_ci | 38 | 9 | 1 | 1 | 1 |
| wms_file | TABLE | InnoDB | utf8mb4_unicode_ci | 5806 | 20 | 1 | 1 | 8 |
| wms_file_reference | TABLE | InnoDB | utf8mb4_unicode_ci | 8299 | 8 | 1 | 1 | 5 |
| wms_i18n_keys | TABLE | InnoDB | utf8mb4_general_ci | 182 | 10 | 1 | 1 | 4 |
| wms_i18n_translations | TABLE | InnoDB | utf8mb4_general_ci | 421 | 11 | 1 | 1 | 5 |
| wms_interface_type | TABLE | InnoDB | utf8mb4_unicode_ci | 2 | 9 | 1 | 1 | 2 |
| wms_location_space | TABLE | InnoDB | utf8mb4_general_ci | 1898 | 38 | 1 | 1 | 13 |
| wms_location_type | TABLE | InnoDB | utf8mb4_general_ci | 5 | 10 | 1 | 1 | 3 |
| wms_location_zone | TABLE | InnoDB | utf8mb4_general_ci | 20 | 30 | 1 | 1 | 10 |
| wms_operation_log | TABLE | InnoDB | utf8mb4_general_ci | 2856 | 12 | 1 | 1 | 8 |
| wms_order_delivery | TABLE | InnoDB | utf8mb4_general_ci | 0 | 54 | 1 | 1 | 4 |
| wms_order_delivery_100000 | TABLE | InnoDB | utf8mb4_general_ci | 10 | 72 | 1 | 1 | 9 |
| wms_order_delivery_1000028 | TABLE | InnoDB | utf8mb4_general_ci | 0 | 72 | 1 | 1 | 9 |
| wms_order_express | TABLE | InnoDB | utf8mb4_general_ci | 0 | 13 | 1 | 1 | 2 |
| wms_order_express_print_data | TABLE | InnoDB | utf8mb4_general_ci | 0 | 6 | 1 | 1 | 2 |
| wms_order_items | TABLE | InnoDB | utf8mb4_general_ci | 0 | 15 | 1 | 1 | 2 |
| wms_order_items_100000 | TABLE | InnoDB | utf8mb4_unicode_ci | 11 | 18 | 1 | 1 | 9 |
| wms_order_items_1000028 | TABLE | InnoDB | utf8mb4_unicode_ci | 0 | 18 | 1 | 1 | 9 |
| wms_order_operation | TABLE | InnoDB | utf8mb4_general_ci | 0 | 1 | 1 | 1 | 1 |
| wms_order_operation_log | TABLE | InnoDB | utf8mb4_general_ci | 0 | 15 | 1 | 1 | 6 |
| wms_order_picking | TABLE | InnoDB | utf8mb4_general_ci | 0 | 1 | 1 | 1 | 1 |
| wms_permission | TABLE | InnoDB | utf8mb4_general_ci | 40 | 15 | 1 | 1 | 4 |
| wms_picking_strategy | TABLE | InnoDB | utf8mb4_unicode_ci | 0 | 25 | 1 | 1 | 3 |
| wms_platform | TABLE | InnoDB | utf8mb4_general_ci | 13 | 3 | 1 | 0 | 1 |
| wms_platform_print_config | TABLE | InnoDB | utf8mb4_general_ci | 7 | 12 | 1 | 1 | 3 |
| wms_platfrom_setting | TABLE | InnoDB | utf8mb4_general_ci | 0 | 4 | 1 | 1 | 4 |
| wms_printer_config | TABLE | InnoDB | utf8mb4_general_ci | 0 | 11 | 1 | 1 | 4 |
| wms_print_batch | TABLE | InnoDB | utf8mb4_general_ci | 0 | 16 | 1 | 1 | 6 |
| wms_print_computer | TABLE | InnoDB | utf8mb4_general_ci | 0 | 4 | 1 | 1 | 1 |
| wms_print_items | TABLE | InnoDB | utf8mb4_general_ci | 39 | 24 | 1 | 1 | 5 |
| wms_print_log | TABLE | InnoDB | utf8mb4_general_ci | 0 | 12 | 1 | 1 | 5 |
| wms_print_record | TABLE | InnoDB | utf8mb4_general_ci | 277 | 13 | 1 | 1 | 6 |
| wms_print_stations | TABLE | InnoDB | utf8mb4_unicode_ci | 3 | 11 | 1 | 1 | 7 |
| wms_print_station_express | TABLE | InnoDB | utf8mb4_unicode_ci | 0 | 10 | 1 | 1 | 5 |
| wms_print_template | TABLE | InnoDB | utf8mb4_general_ci | 4 | 15 | 1 | 1 | 4 |
| wms_prohibited_type | TABLE | InnoDB | utf8mb4_unicode_ci | 13 | 9 | 1 | 1 | 4 |
| wms_qimen_apps | TABLE | InnoDB | utf8mb4_general_ci | 27 | 4 | 1 | 1 | 2 |
| wms_qimen_log | TABLE | InnoDB | utf8mb4_general_ci | 27756 | 14 | 1 | 1 | 1 |
| wms_receiving | TABLE | InnoDB | utf8mb4_unicode_ci | 43 | 25 | 1 | 1 | 9 |
| wms_receiving_detail | TABLE | InnoDB | utf8mb4_unicode_ci | 38 | 26 | 1 | 1 | 8 |
| wms_role | TABLE | InnoDB | utf8mb4_general_ci | 5 | 13 | 1 | 1 | 6 |
| wms_role_permission | TABLE | InnoDB | utf8mb4_general_ci | 72 | 4 | 1 | 1 | 4 |
| wms_stock_barcodes | TABLE | InnoDB | utf8mb4_unicode_ci | 25992 | 6 | 1 | 1 | 3 |
| wms_stock_store | TABLE | InnoDB | utf8mb4_unicode_ci | 472 | 34 | 1 | 1 | 11 |
| wms_stock_unit | TABLE | InnoDB | utf8mb4_general_ci | 11 | 4 | 1 | 1 | 3 |
| wms_stock_warehouse | TABLE | InnoDB | utf8mb4_unicode_ci | 25718 | 41 | 1 | 1 | 6 |
| wms_storage | TABLE | InnoDB | utf8mb4_unicode_ci | 0 | 20 | 1 | 1 | 8 |
| wms_store | TABLE | InnoDB | utf8mb4_unicode_ci | 121 | 20 | 1 | 1 | 5 |
| wms_store_join | TABLE | InnoDB | utf8mb4_unicode_ci | 4 | 14 | 1 | 1 | 7 |
| wms_store_warehouse | TABLE | InnoDB | utf8mb4_general_ci | 119 | 21 | 1 | 1 | 8 |
| wms_system_config | TABLE | InnoDB | utf8mb4_general_ci | 1 | 5 | 1 | 1 | 1 |
| wms_system_log | TABLE | InnoDB | utf8mb4_general_ci | 4591 | 14 | 1 | 1 | 2 |
| wms_wave_batch | TABLE | InnoDB | utf8mb4_general_ci | 0 | 20 | 1 | 1 | 5 |
| wms_wave_operation_log | TABLE | InnoDB | utf8mb4_general_ci | 0 | 11 | 1 | 1 | 5 |