Files
user-system/docs/processes/FRONTEND_BACKEND_REVIEW.md

196 lines
4.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 前后端联调评审流程
## 1. 概述
本流程确保前后端联调质量,防止设计断链和接口不匹配问题。
## 2. 适用范围
- 所有前后端集成开发
- 新功能开发联调
- Bug 修复联调
- 性能优化联调
## 3. 评审角色
| 角色 | 职责 |
|------|------|
| 后端负责人 | API 设计评审,数据模型验证 |
| 前端负责人 | UI/UX 验证,接口对接验证 |
| 测试工程师 | 联调测试计划,测试用例验证 |
| 技术负责人 | 架构一致性评审,最终决策 |
## 4. 评审时机
- Sprint 开发初期API 接口评审
- Sprint 中期:联调问题评审
- Sprint 结束前:上线前评审
## 5. 评审内容
### 5.1 API 接口评审
- [ ] 接口路径符合 RESTful 规范
- [ ] 请求/响应格式一致
- [ ] 错误码定义完整
- [ ] 分页、排序、筛选参数统一
- [ ] 权限控制明确
### 5.2 数据模型评审
- [ ] 前后端数据结构一致
- [ ] 字段命名统一camelCase/snake_case
- [ ] 数据类型匹配
- [ ] 可选字段/必填字段明确
- [ ] 枚举值定义一致
### 5.3 业务逻辑评审
- [ ] 前后端业务逻辑一致
- [ ] 边界条件处理一致
- [ ] 异常场景处理覆盖
- [ ] 用户交互流程验证
### 5.4 性能评审
- [ ] 接口响应时间满足要求
- [ ] 数据库查询优化
- [ ] 前端渲染性能优化
- [ ] 并发处理机制验证
### 5.5 安全评审
- [ ] 认证授权机制完善
- [ ] 敏感数据传输加密
- [ ] 输入验证防注入
- [ ] XSS/CSRF 防护
## 6. 评审流程
### 6.1 API 接口评审Sprint 开始)
**输入**
- API 设计文档Swagger/OpenAPI
- 数据模型定义
- 权限设计文档
**输出**
- API 接口评审报告
- 接口变更记录
**步骤**
1. 后端负责人提交 API 设计文档
2. 前端负责人审查接口与前端需求的匹配度
3. 技术负责人审查架构一致性
4. 评审会议讨论并记录问题
5. 后端负责人更新接口文档
### 6.2 联调问题评审Sprint 中期)
**输入**
- 联调中发现的问题列表
- 问题复现步骤
- 问题影响分析
**输出**
- 问题解决方案
- 优先级排序
- 解决时间表
**步骤**
1. 前后端负责人汇总联调问题
2. 评审会议讨论解决方案
3. 技术负责人评估解决方案可行性
4. 确定解决优先级和时间表
### 6.3 上线前评审Sprint 结束)
**输入**
- 联调测试报告
- 性能测试报告
- 安全测试报告
- 代码审查报告
**输出**
- 上线决策(通过/不通过/条件通过)
- 上线风险清单
- 回滚方案
**步骤**
1. 测试工程师提交测试报告
2. 评审会议审查测试结果
3. 技术负责人评估上线风险
4. 团队决策是否上线
## 7. 评审文档
### 7.1 API 接口评审报告模板
```markdown
# API 接口评审报告
**评审日期**: YYYY-MM-DD
**评审人员**: ...
## 评审结果
- 通过/不通过/条件通过
## 问题列表
| ID | 问题 | 严重程度 | 负责人 | 解决方案 | 状态 |
|----|------|---------|--------|---------|------|
```
### 7.2 联调测试报告模板
```markdown
# 联调测试报告
**测试日期**: YYYY-MM-DD
**测试人员**: ...
## 测试结果
- 测试用例数: X
- 通过: Y
- 失败: Z
- 通过率: N%
## 失败用例列表
| 用例ID | 问题描述 | 严重程度 | 负责人 | 状态 |
|--------|---------|---------|--------|------|
```
## 8. 问题分级
| 级别 | 描述 | 处理时限 |
|------|------|---------|
| P0 | 阻塞问题,无法联调 | 立即修复4h内 |
| P1 | 严重问题,影响核心功能 | 当天修复 |
| P2 | 一般问题,影响用户体验 | 本周修复 |
| P3 | 优化建议,不影响功能 | 下个 Sprint 处理 |
## 9. 评审准则
### 通过标准
- 所有 P0、P1 问题已解决
- 联调测试通过率 ≥ 95%
- 性能指标满足要求
- 安全测试通过
### 不通过标准
- 存在未解决的 P0 问题
- 联调测试通过率 < 80%
- 存在安全漏洞
### 条件通过标准
- P0 问题已解决,存在少量 P2 问题
- 联调测试通过率 ≥ 90%
- 性能基本达标
- 无严重安全问题
## 10. 持续改进
- 每个 Sprint 后进行评审流程复盘
- 收集团队反馈,优化评审流程
- 定期更新评审检查清单
## 11. 相关文档
- [前后端联调检查清单](../checklists/FRONTEND_BACKEND_CHECKLIST.md)
- [代码审查标准](../code-review/CODE_REVIEW_STANDARD.md)
- [生产环境检查清单](../team/PRODUCTION_CHECKLIST.md)