fangxh2013
/
pangu-user-platform
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
pangu-user-platform/docs/05-模块技术方案/应用管理-开发检查清单.md

344 lines
11 KiB
Markdown
Raw Normal View History

feat: 基础数据模块全栈开发及登录接口 - 后端：pangu-admin/common/framework/system 多模块结构 - 基础数据：年级/班级/学科/区域 CRUD 及区域树形 - 登录：开发阶段简化版 LoginController（captchaImage/login/getInfo/getRouters/logout） - 数据库：pguser-db，SQL 脚本 pangu_base_data.sql - 前端：ruoyi-ui 联调配置，VITE_APP_MOCK 可切换
2026-01-31 17:55:58 +08:00
# 盘古用户平台 - 应用管理模块开发检查清单
---
| 文档信息 | 内容 |
|---------|------|
| **文档版本** | V1.0 |
| **模块名称** | 应用管理模块 |
| **编写团队** | 湖北新华业务中台研发团队 |
| **创建日期** | 2026-01-31 |
---
## 1. 开发阶段概览
| 阶段 | 主要任务 | 负责人 | 状态 |
|------|---------|--------|:----:|
| 阶段一 | 技术方案评审 | - | ⬜ 待开始 |
| 阶段二 | 后端开发 | - | ⬜ 待开始 |
| 阶段三 | 前端开发 | - | ⬜ 待开始 |
| 阶段四 | 联调测试 | - | ⬜ 待开始 |
| 阶段五 | 验收上线 | - | ⬜ 待开始 |
> 状态说明：⬜ 待开始 | 🔄 进行中 | ✅ 已完成 | ❌ 已取消
---
## 2. 阶段一：技术方案评审
### 2.1 评审材料准备
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 1.1 | 应用管理模块技术方案_v1.0.md | - | ✅ | 已完成 |
| 1.2 | 应用管理-前端技术方案.md | - | ✅ | 已完成 |
| 1.3 | 应用管理-后端技术方案.md | - | ✅ | 已完成 |
| 1.4 | 应用管理-测试用例.md | - | ✅ | 已完成 |
### 2.2 评审会议
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 2.1 | 组织技术方案评审会 | - | ⬜ | |
| 2.2 | 记录评审意见 | - | ⬜ | |
| 2.3 | 修改技术方案（如有） | - | ⬜ | |
| 2.4 | 评审通过确认 | - | ⬜ | |
---
## 3. 阶段二：后端开发
### 3.1 数据库
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 3.1.1 | 创建 pg_application 表 | - | ⬜ | |
| 3.1.2 | 创建 pg_app_api 表 | - | ⬜ | |
| 3.1.3 | 创建 pg_api_dict 表 | - | ⬜ | |
| 3.1.4 | 插入 API接口字典初始数据 | - | ⬜ | 6条记录 |
| 3.1.5 | 插入 菜单数据 | - | ⬜ | |
| 3.1.6 | 数据库脚本评审 | - | ⬜ | |
### 3.2 实体层
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 3.2.1 | Application.java | - | ⬜ | 应用实体 |
| 3.2.2 | AppApi.java | - | ⬜ | 应用接口授权实体 |
| 3.2.3 | ApiDict.java | - | ⬜ | 接口字典实体 |
| 3.2.4 | ApplicationDTO.java | - | ⬜ | 传输对象 |
| 3.2.5 | ApplicationVO.java | - | ⬜ | 视图对象 |
### 3.3 Mapper层
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 3.3.1 | ApplicationMapper.java | - | ⬜ | |
| 3.3.2 | AppApiMapper.java | - | ⬜ | |
| 3.3.3 | ApiDictMapper.java | - | ⬜ | |
| 3.3.4 | Mapper XML文件（如有） | - | ⬜ | |
### 3.4 Service层
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 3.4.1 | IApplicationService.java | - | ⬜ | 服务接口 |
| 3.4.2 | ApplicationServiceImpl.java | - | ⬜ | 服务实现 |
| 3.4.3 | 应用编码生成逻辑 | - | ⬜ | YY+6位序号 |
| 3.4.4 | 密钥生成逻辑 | - | ⬜ | 32位随机 |
| 3.4.5 | 接口授权保存逻辑 | - | ⬜ | |
| 3.4.6 | 缓存处理逻辑 | - | ⬜ | Redis |
### 3.5 Controller层
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 3.5.1 | ApplicationController.java | - | ⬜ | 应用管理控制器 |
| 3.5.2 | 权限注解配置 | - | ⬜ | @PreAuthorize |
| 3.5.3 | 操作日志注解 | - | ⬜ | @Log |
### 3.6 开放API
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 3.6.1 | ApiAuthInterceptor.java | - | ⬜ | 签名验证拦截器 |
| 3.6.2 | OpenApiConfig.java | - | ⬜ | 拦截器配置 |
| 3.6.3 | 签名生成算法 | - | ⬜ | MD5 |
| 3.6.4 | 时间戳验证 | - | ⬜ | 5分钟有效期 |
| 3.6.5 | 权限校验 | - | ⬜ | |
### 3.7 单元测试
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 3.7.1 | ApplicationServiceTest.java | - | ⬜ | |
| 3.7.2 | 测试新增应用 | - | ⬜ | |
| 3.7.3 | 测试应用编码生成 | - | ⬜ | |
| 3.7.4 | 测试重置密钥 | - | ⬜ | |
| 3.7.5 | 测试接口权限校验 | - | ⬜ | |
### 3.8 后端自测
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 3.8.1 | 服务正常启动 | - | ⬜ | |
| 3.8.2 | Postman接口测试 | - | ⬜ | |
| 3.8.3 | 开放API签名测试 | - | ⬜ | |
---
## 4. 阶段三：前端开发
### 4.1 API封装
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 4.1.1 | api/application.js | - | ✅ | 已有框架代码 |
| 4.1.2 | 接口路径调整（如需） | - | ⬜ | |
### 4.2 页面开发
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 4.2.1 | views/application/index.vue | - | ✅ | 已有框架代码 |
| 4.2.2 | 搜索区域 | - | ✅ | |
| 4.2.3 | 表格区域 | - | ✅ | |
| 4.2.4 | 分页功能 | - | ✅ | |
| 4.2.5 | 操作按钮 | - | ✅ | |
### 4.3 弹窗组件
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 4.3.1 | components/AppDialog.vue | - | ✅ | 已有框架代码 |
| 4.3.2 | 新增表单 | - | ✅ | |
| 4.3.3 | 编辑表单 | - | ✅ | |
| 4.3.4 | 接口授权勾选 | - | ✅ | |
| 4.3.5 | 表单验证 | - | ✅ | |
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 4.3.6 | components/SecretDialog.vue | - | ✅ | 已有框架代码 |
| 4.3.7 | 密钥展示 | - | ✅ | |
| 4.3.8 | 复制功能 | - | ✅ | |
### 4.4 Mock数据
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 4.4.1 | mock/application.js | - | ✅ | 已有 |
| 4.4.2 | Mock数据完善（如需） | - | ⬜ | |
### 4.5 路由配置
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 4.5.1 | 添加应用管理路由 | - | ⬜ | |
| 4.5.2 | 权限配置 | - | ⬜ | |
### 4.6 前端自测
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 4.6.1 | Mock模式功能测试 | - | ⬜ | |
| 4.6.2 | 页面样式检查 | - | ⬜ | |
| 4.6.3 | 表单验证测试 | - | ⬜ | |
---
## 5. 阶段四：联调测试
### 5.1 接口联调
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 5.1.1 | 关闭Mock，切换真实接口 | - | ⬜ | |
| 5.1.2 | 应用列表接口联调 | - | ⬜ | |
| 5.1.3 | 应用详情接口联调 | - | ⬜ | |
| 5.1.4 | 新增应用接口联调 | - | ⬜ | |
| 5.1.5 | 修改应用接口联调 | - | ⬜ | |
| 5.1.6 | 删除应用接口联调 | - | ⬜ | |
| 5.1.7 | 重置密钥接口联调 | - | ⬜ | |
| 5.1.8 | API接口列表联调 | - | ⬜ | |
### 5.2 功能测试
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 5.2.1 | 执行功能测试用例 | - | ⬜ | 参考测试用例文档 |
| 5.2.2 | 记录缺陷 | - | ⬜ | |
| 5.2.3 | 缺陷修复 | - | ⬜ | |
| 5.2.4 | 回归测试 | - | ⬜ | |
### 5.3 开放API测试
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 5.3.1 | 签名验证测试 | - | ⬜ | |
| 5.3.2 | 时间戳验证测试 | - | ⬜ | |
| 5.3.3 | 权限校验测试 | - | ⬜ | |
| 5.3.4 | 异常场景测试 | - | ⬜ | |
### 5.4 权限测试
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 5.4.1 | 超级管理员权限测试 | - | ⬜ | |
| 5.4.2 | 分公司用户权限测试 | - | ⬜ | |
| 5.4.3 | 学校用户权限测试 | - | ⬜ | |
---
## 6. 阶段五：验收上线
### 6.1 验收准备
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 6.1.1 | 测试报告编写 | - | ⬜ | |
| 6.1.2 | 验收环境部署 | - | ⬜ | |
| 6.1.3 | 测试数据准备 | - | ⬜ | |
### 6.2 用户验收
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 6.2.1 | 组织验收会议 | - | ⬜ | |
| 6.2.2 | 演示功能 | - | ⬜ | |
| 6.2.3 | 收集验收意见 | - | ⬜ | |
| 6.2.4 | 问题修复（如有） | - | ⬜ | |
| 6.2.5 | 验收签字确认 | - | ⬜ | |
### 6.3 上线部署
| 序号 | 任务项 | 负责人 | 状态 | 备注 |
|:----:|-------|--------|:----:|------|
| 6.3.1 | 生产环境数据库脚本执行 | - | ⬜ | |
| 6.3.2 | 后端服务部署 | - | ⬜ | |
| 6.3.3 | 前端部署 | - | ⬜ | |
| 6.3.4 | 生产环境验证 | - | ⬜ | |
| 6.3.5 | 上线报告 | - | ⬜ | |
---
## 7. 代码规范检查
### 7.1 后端代码检查
| 序号 | 检查项 | 状态 | 备注 |
|:----:|-------|:----:|------|
| 7.1.1 | 所有类有作者注释 | ⬜ | @author 湖北新华业务中台研发团队 |
| 7.1.2 | 公共方法有Javadoc注释 | ⬜ | |
| 7.1.3 | 无console打印语句 | ⬜ | 使用log |
| 7.1.4 | 代码格式化 | ⬜ | |
| 7.1.5 | 无硬编码 | ⬜ | 使用常量或配置 |
| 7.1.6 | 异常处理完善 | ⬜ | |
| 7.1.7 | 日志记录关键操作 | ⬜ | |
### 7.2 前端代码检查
| 序号 | 检查项 | 状态 | 备注 |
|:----:|-------|:----:|------|
| 7.2.1 | 组件有作者注释 | ⬜ | |
| 7.2.2 | 无console.log | ⬜ | |
| 7.2.3 | 代码格式化 | ⬜ | |
| 7.2.4 | 无无用代码 | ⬜ | |
| 7.2.5 | 使用Composition API | ⬜ | |
| 7.2.6 | 复杂逻辑有注释 | ⬜ | |
---
## 8. 文档交付清单
| 序号 | 文档名称 | 状态 | 备注 |
|:----:|---------|:----:|------|
| 1 | 应用管理模块技术方案_v1.0.md | ✅ | |
| 2 | 应用管理-前端技术方案.md | ✅ | |
| 3 | 应用管理-后端技术方案.md | ✅ | |
| 4 | 应用管理-测试用例.md | ✅ | |
| 5 | 应用管理-开发检查清单.md | ✅ | 本文档 |
| 6 | 接口设计文档（更新） | ⬜ | |
| 7 | 测试报告 | ⬜ | |
| 8 | 上线报告 | ⬜ | |
---
## 9. 问题跟踪
| 序号 | 问题描述 | 提出人 | 提出日期 | 状态 | 解决方案 | 解决日期 |
|:----:|---------|--------|---------|:----:|---------|---------|
| 1 | | | | | | |
| 2 | | | | | | |
| 3 | | | | | | |
> 状态说明：⬜ 待处理 | 🔄 处理中 | ✅ 已解决 | ❌ 关闭
---
## 10. 里程碑
| 里程碑 | 完成标准 | 计划日期 | 实际日期 | 状态 |
|--------|---------|---------|---------|:----:|
| M1 设计评审通过 | 技术方案评审通过 | - | - | ⬜ |
| M2 后端开发完成 | 接口可用，Postman测试通过 | - | - | ⬜ |
| M3 前端开发完成 | 页面可用，Mock测试通过 | - | - | ⬜ |
| M4 联调测试完成 | 功能测试用例通过 | - | - | ⬜ |
| M5 验收上线完成 | 用户验收通过，生产部署 | - | - | ⬜ |
---
## 附录：相关文档链接
| 文档 | 路径 |
|------|------|
| 需求规格说明书 | docs/01-需求文档/需求规格说明书_v1.0.md |
| 系统设计文档 | docs/02-系统设计/系统设计文档_v1.0.md |
| 数据库设计文档 | docs/03-数据库设计/数据库设计文档_v1.0.md |
| 接口设计文档 | docs/04-接口文档/接口设计文档_v1.0.md |
| 应用管理技术方案 | docs/05-模块技术方案/应用管理模块技术方案_v1.0.md |
---
*文档结束*