pangu-user-platform/docs/05-模块技术方案/学校管理/README.md

152 lines
3.7 KiB
Markdown
Raw Normal View History

# 学校管理模块 - 技术文档
---
| 文档信息 | 内容 |
|---------|------|
| **模块名称** | 学校管理模块 |
| **编写团队** | pangu |
| **创建日期** | 2026-01-31 |
| **文档状态** | 待评审 |
---
## 文档清单
| 序号 | 文档名称 | 说明 | 状态 |
|:----:|---------|------|:----:|
| 1 | [学校管理模块技术方案_v1.0.md](./学校管理模块技术方案_v1.0.md) | 完整的前后端技术方案 | 待评审 |
| 2 | [学校管理模块_开发任务清单.md](./学校管理模块_开发任务清单.md) | 详细的任务分解与跟踪 | 待评审 |
| 3 | [学校管理模块_测试方案.md](./学校管理模块_测试方案.md) | 测试用例与验收标准 | 待评审 |
---
## 功能概览
### 核心功能
```
学校管理模块
├── 学校管理
│ ├── 学校列表查询(区域树 + 学校树)
│ ├── 新增学校
│ ├── 编辑学校
│ └── 删除学校
├── 年级挂载
│ ├── 为学校挂载年级
│ └── 删除学校年级
└── 班级挂载
├── 为年级挂载班级
└── 删除学校班级
```
### 业务规则摘要
| 规则 | 说明 |
|-----|------|
| 编码生成 | 学校编码自动生成SCH + 年份 + 4位序号 |
| 挂载模式 | 年级/班级采用选择挂载,非新建 |
| 删除校验 | 删除前检查子级和学生引用 |
| 软删除 | 所有删除操作均为软删除 |
---
## 工作量估算
| 类别 | 任务数 | 工时 |
|-----|:------:|:------:|
| 后端开发 | 14 | 25h |
| 前端开发 | 10 | 23h |
| 测试 | 3 | 8h |
| **合计** | **27** | **56h** |
**预计开发周期7-8个工作日**
---
## 技术要点
### 前端关键点
1. **左右分栏布局**:左侧区域树 + 右侧学校树表格
2. **树形表格**:使用 el-table 的 tree-props 实现三级树
3. **级联选择**:所属区域使用 el-cascader 级联选择
4. **多选挂载**:年级/班级支持多选挂载
### 后端关键点
1. **编码生成**SCH + 年份 + 4位序号唯一索引保证
2. **删除校验**:检查子级、检查学生引用
3. **树形查询**:批量查询 + 内存组装避免N+1问题
4. **数据权限**@DataScope 注解实现分公司数据隔离
---
## 依赖关系
| 依赖模块 | 依赖说明 |
|---------|---------|
| 区域管理 | 学校必须关联区域 |
| 年级字典 | 年级挂载依赖年级字典 |
| 班级字典 | 班级挂载依赖班级字典 |
| 学生管理 | 删除校验需检查学生引用 |
---
## 评审检查清单
### 技术方案评审
| 检查项 | 评审意见 | 状态 |
|-------|---------|:----:|
| 需求覆盖完整性 | | ☐ |
| 技术方案可行性 | | ☐ |
| 前端组件设计合理性 | | ☐ |
| 后端接口设计规范性 | | ☐ |
| 数据库设计合理性 | | ☐ |
| 数据权限设计正确性 | | ☐ |
| 异常处理完整性 | | ☐ |
| 性能考虑充分性 | | ☐ |
### 任务分解评审
| 检查项 | 评审意见 | 状态 |
|-------|---------|:----:|
| 任务粒度合理性 | | ☐ |
| 任务依赖关系正确 | | ☐ |
| 工时估算合理性 | | ☐ |
| 验收标准明确 | | ☐ |
### 测试方案评审
| 检查项 | 评审意见 | 状态 |
|-------|---------|:----:|
| 用例覆盖完整性 | | ☐ |
| 边界条件考虑 | | ☐ |
| 测试数据准备 | | ☐ |
| 验收标准明确 | | ☐ |
---
## 评审记录
| 评审时间 | 参与人员 | 评审结论 | 备注 |
|---------|---------|---------|------|
| | | | |
---
## 签字确认
| 角色 | 姓名 | 日期 | 签字 |
|-----|------|------|------|
| 技术负责人 | | | |
| 前端负责人 | | | |
| 后端负责人 | | | |
| 测试负责人 | | | |
| 产品负责人 | | | |
---
*文档结束*