196 lines
11 KiB
Markdown
196 lines
11 KiB
Markdown
# FMS 后端核心表结构设计
|
|
|
|
> 文档版本：V1.1（精简方案）
|
|
> 编制日期：2026-10-12
|
|
> 状态：待评审
|
|
> 数据库：SQL Server
|
|
> 配套文档：[后端架构设计.md](./后端架构设计.md)
|
|
|
|
## 1. 范围与原则
|
|
|
|
本文沿用现有 FMS 的模块表结构和 SQL 驱动方式，只说明模块运行需要的核心元数据表，并增加一张轻量的模块版本历史表。业务表、用户/权限、菜单、多语言、工作流等既有表和接口不在本文重定义。
|
|
|
|
- 业务数据仍保存在 SQL Server 的真实表和视图中。
|
|
- `s_module`、`s_field`、`s_module_schema`、`s_relation` 描述模块及其界面、字段和关联；不采用 EAV 存业务记录。
|
|
- 常规功能用模块配置；配置不够或 SQL 更直接时，可通过模块的 `b_query_sql` 使用 SQL 查询。
|
|
- 运行时继续读取现有模块配置表；版本表仅保存可查看、可恢复的历史配置，不引入新的运行时快照目录。
|
|
- 保持现有命名和数据类型；不增加模板体系、草稿/发布状态机、额外快照表或元数据编译器。
|
|
- 与现有 FMS 数据库约定一致：模块关联完整性、JSON 和类型校验由应用层负责，不依赖外键、`CHECK` 约束或触发器。
|
|
|
|
## 2. 核心表清单
|
|
|
|
| 表 | 职责 | 是否新增 |
|
|
|---|---|---|
|
|
| `s_module` | 模块树、查询来源、保存目标和默认行为 | 否，沿用现有设计 |
|
|
| `s_field` | 模块字段编码、名称和业务类型 | 否，沿用现有设计 |
|
|
| `s_module_schema` | 列表、表单、查询等界面 JSON 配置 | 否，沿用现有设计 |
|
|
| `s_relation` | 模块之间的字段关系 | 否，沿用现有设计 |
|
|
| `s_module_version` | 手动保存的模块配置历史及恢复来源 | 是，唯一新增表 |
|
|
|
|
现有 `s_user_module_pref`、`s_autocode`、`s_delete_rule` 等辅助配置表继续按原设计使用；权限、菜单和工作流表也保持原状。它们不因本方案改名或迁移。
|
|
|
|
## 3. 模块 `s_module`
|
|
|
|
```sql
|
|
create table dbo.s_module (
|
|
b_id varchar(50) not null primary key, -- 模块编码，稳定业务键
|
|
b_parent_id varchar(50) null, -- 父模块编码，根节点为空
|
|
b_depth int not null default 0, -- 模块树层级，根节点为 0
|
|
b_path varchar(1000) not null, -- 模块树路径，由应用层维护
|
|
b_name nvarchar(200) not null, -- 模块名称
|
|
b_i18n varchar(150) null, -- 多语言资源编码
|
|
b_module_type varchar(20) not null, -- module / data / virtual
|
|
b_view_table varchar(128) null, -- 默认查询表或视图名
|
|
b_save_table varchar(128) null, -- 默认保存目标表名
|
|
b_key_field varchar(50) null, -- 数据主键字段
|
|
b_scope_field varchar(50) null, -- 数据范围字段，如记录归属人字段
|
|
b_order_sql varchar(500) null, -- 默认排序规则
|
|
b_query_sql nvarchar(max) null, -- 可选查询 SQL 或 SQL 模板
|
|
b_config_json nvarchar(max) null, -- 低频模块扩展配置
|
|
b_canuse tinyint not null default 1, -- 是否启用：1 启用，0 停用
|
|
b_xh int not null default 0, -- 同级模块显示顺序
|
|
b_bz nvarchar(2000) null, -- 备注
|
|
b_updated_at datetime2 null -- 模块配置最后保存时间
|
|
);
|
|
|
|
create index ix_s_module_parent
|
|
on dbo.s_module (b_parent_id, b_canuse, b_depth, b_xh, b_id);
|
|
|
|
create index ix_s_module_path
|
|
on dbo.s_module (b_path, b_canuse, b_id);
|
|
|
|
create index ix_s_module_type
|
|
on dbo.s_module (b_module_type, b_canuse, b_xh, b_id);
|
|
|
|
create index ix_s_module_view_table
|
|
on dbo.s_module (b_view_table, b_canuse, b_id);
|
|
|
|
create index ix_s_module_save_table
|
|
on dbo.s_module (b_save_table, b_canuse, b_id);
|
|
```
|
|
|
|
### 3.1 字段约定
|
|
|
|
- `module` 是模块分组；`data` 是标准数据模块；`virtual` 是由查询 SQL 或业务实现提供数据的虚拟模块。
|
|
- `b_view_table` 是普通查询的数据源；配置 `b_query_sql` 时，模块查询使用该 SQL；两者都没有时，由虚拟模块的业务实现提供数据。
|
|
- `b_save_table` 和 `b_key_field` 描述标准保存目标；业务写入仍走现有保存接口或业务服务。
|
|
- `b_query_sql` 是可选的 SQL 兜底配置，不是后端代码中的固定 SQL 编码。可按现有机构/数据库配置维护不同 SQL。它用于查询，不替代标准保存流程。
|
|
- `b_order_sql` 保存该模块的默认排序；值按现有 SQL 标识符和排序校验规则处理。
|
|
- `b_parent_id` 是模块树的权威关系；`b_depth`、`b_path` 是派生字段，新增或移动节点时由应用层在事务内维护。
|
|
|
|
## 4. 字段 `s_field`
|
|
|
|
```sql
|
|
create table dbo.s_field (
|
|
b_module_id varchar(50) not null, -- 所属 data / virtual 模块编码
|
|
b_field varchar(50) not null, -- 模块字段编码或查询结果别名
|
|
b_name nvarchar(200) not null, -- 字段名称
|
|
b_i18n varchar(150) null, -- 多语言资源编码
|
|
b_type varchar(30) not null, -- 字段业务类型
|
|
b_canuse tinyint not null default 1, -- 是否启用：1 启用，0 停用
|
|
b_xh int not null default 0, -- 字段默认顺序
|
|
primary key (b_module_id, b_field)
|
|
);
|
|
|
|
create index ix_s_field_module_order
|
|
on dbo.s_field (b_module_id, b_canuse, b_xh, b_field);
|
|
```
|
|
|
|
`b_type` 表示业务层字段类型；SQL Server 实际类型通过表/视图结构探测获得，不在 `s_field` 重复保存。字段分组、控件、必填、只读、显示顺序等界面行为放在 `s_module_schema` 的 JSON 中。
|
|
|
|
## 5. 界面配置 `s_module_schema`
|
|
|
|
```sql
|
|
create table dbo.s_module_schema (
|
|
b_module_id varchar(50) not null, -- 所属 data / virtual 模块编码
|
|
b_schema_type varchar(20) not null, -- view / edit / query
|
|
b_schema_json nvarchar(max) not null, -- 对应界面的完整 JSON 配置
|
|
b_canuse tinyint not null default 1, -- 是否启用：1 启用，0 停用
|
|
b_updated_by varchar(50) null, -- 最后修改人编码
|
|
b_updated_at datetime2 null, -- 最后修改时间
|
|
primary key (b_module_id, b_schema_type)
|
|
);
|
|
|
|
create index ix_s_module_schema_type
|
|
on dbo.s_module_schema (b_module_id, b_schema_type, b_canuse);
|
|
```
|
|
|
|
每个模块按需配置 `view`（列表）、`edit`（表单）、`query`（查询条件）。每种类型当前一份 JSON；JSON 结构版本由 JSON 顶层的 `schemaVersion` 管理。字段编码引用 `s_field.b_field`。个人偏好仍使用现有 `s_user_module_pref`，不混入系统默认配置。
|
|
|
|
## 6. 模块关系 `s_relation`
|
|
|
|
```sql
|
|
create table dbo.s_relation (
|
|
b_source_module_id varchar(50) not null, -- 源模块编码
|
|
b_source_field varchar(50) not null, -- 源字段编码
|
|
b_target_module_id varchar(50) not null, -- 目标模块编码
|
|
b_target_field varchar(50) not null, -- 目标字段编码
|
|
b_relation_type varchar(20) not null, -- one_to_one / one_to_many / many_to_one
|
|
b_on_delete varchar(20) not null default 'restrict', -- restrict / cascade / none
|
|
b_canuse tinyint not null default 1, -- 是否启用：1 启用，0 停用
|
|
b_xh int not null default 0, -- 关系显示顺序
|
|
primary key (
|
|
b_source_module_id,
|
|
b_source_field,
|
|
b_target_module_id,
|
|
b_target_field
|
|
)
|
|
);
|
|
|
|
create index ix_s_relation_source
|
|
on dbo.s_relation (b_source_module_id, b_canuse, b_xh, b_source_field, b_target_module_id);
|
|
|
|
create index ix_s_relation_target
|
|
on dbo.s_relation (b_target_module_id, b_canuse, b_source_module_id);
|
|
```
|
|
|
|
模块树只表达业务分组；主子表、引用和多对多关系通过 `s_relation` 或中间表模块表达。关系目标及删除策略由应用层校验，不建立通用业务外键。
|
|
|
|
## 7. 模块版本历史 `s_module_version`
|
|
|
|
该表是本方案唯一新增表。它保存模块配置的历史副本，用于查看和恢复；不引入模板版本、独立快照表、发布状态机或运行时版本目录。
|
|
|
|
```sql
|
|
create table dbo.s_module_version (
|
|
b_module_id varchar(50) not null, -- 所属模块编码
|
|
b_version_no int not null, -- 模块内递增版本号
|
|
b_snapshot_json nvarchar(max) not null, -- 该版本的完整模块配置快照
|
|
b_change_note nvarchar(1000) null, -- 版本说明
|
|
b_created_by varchar(50) null, -- 创建版本的用户编码
|
|
b_created_at datetime2 not null default sysdatetime(), -- 创建版本时间
|
|
primary key (b_module_id, b_version_no)
|
|
);
|
|
```
|
|
|
|
快照 JSON 使用独立的 `snapshotVersion` 描述快照格式。它至少包含模块行、字段行、界面配置和相关关系；如需完整恢复模块行为，也包含该模块对应的自动编码、删除规则等配置。示意：
|
|
|
|
```json
|
|
{
|
|
"snapshotVersion": 1,
|
|
"module": {},
|
|
"fields": [],
|
|
"schemas": [],
|
|
"relations": [],
|
|
"autocodes": [],
|
|
"deleteRules": []
|
|
}
|
|
```
|
|
|
|
### 7.1 保存与恢复规则
|
|
|
|
1. 管理员显式创建版本时，后端在同一事务中读取当前模块配置并写入 `s_module_version`；版本记录创建后不修改。
|
|
2. `b_version_no` 按模块递增；并发创建时由后端事务锁定模块并分配下一个号码。
|
|
3. 恢复版本时先校验快照格式和模块引用，再在一个事务内将快照恢复到现有配置表。
|
|
4. 恢复操作成功后，当前运行行为仍由 `s_module` 等现有配置表决定；为保留操作历史，可将恢复结果另存为一个新版本，不覆盖旧版本。
|
|
5. 版本快照只保存模块配置，不保存业务数据、用户个人偏好、权限授权、菜单、翻译内容或数据库建表脚本。
|
|
|
|
这套版本历史不提供独立草稿或“线上发布版本”隔离：模块配置仍按现有方式生效。若未来确实需要草稿/发布隔离，再单独评估，不作为本次改造前提。
|
|
|
|
## 8. 既有表与校验边界
|
|
|
|
- `s_user_module_pref`：沿用个人视图偏好；它是用户级显示覆盖，不属于模块版本快照。
|
|
- `s_autocode`、`s_delete_rule`：继续按现有规则工作；模块版本需要完整回滚时，其模块配置一并纳入快照。
|
|
- `s_menu`、权限、多语言、日志、工作流及业务表：沿用各自现有设计，不在本文件重建。
|
|
- 模块/字段/关系存在性、`b_module_type`、`b_schema_type` 和 JSON 内容由后端校验；不新增外键、`CHECK` 或触发器。
|
|
- 业务数据库结构变更仍通过 SQL migration 管理；模块版本不替代数据库 migration。
|