三、核心内容撰写要点(附避坑指南)
需求分析:从模糊描述到可执行规格
常见误区:直接复制课程任务书原文,未做用户角色拆解。正确做法应包含:
- 角色建模:如“学生用户”需区分管理员、教师、学生三类,明确权限边界;
- 功能优先级排序:使用MoSCoW法则(Must-have/Should-have/Could-have/Won’t-have);
- 非功能性需求:响应时间≤2s、并发用户≥100、数据加密存储等硬性指标。
💡 范例:某团队在“在线考试系统”中,将“防作弊”需求细化为:
① 切屏检测(触发后自动提交试卷);
② 题目乱序;
③ 禁止复制粘贴;
④ 摄像头实时抓拍(可选)。
系统设计:架构图与技术选型的逻辑闭环
技术选型需说明“为什么用A不用B”,例如:
▶️ 选择Spring Boot而非原生Servlet:自动配置、内嵌Tomcat、生态完善;
▶️ 采用MySQL 8.0而非Redis:需持久化存储用户成绩、考试记录等事务性数据;
▶️ 前端用Vue3而非jQuery:组件化开发提升可维护性,符合现代工程标准。
架构图建议包含三层:
1. 部署拓扑图:用户→CDN→Nginx→Spring Boot集群→MySQL主从→Redis缓存
2. 模块依赖图:使用UML类图标注Controller/Service/DAO分层
3. 数据流图:订单创建流程(用户下单→库存预扣→支付回调→订单状态更新)
编码实现:突出关键决策点
禁止粘贴完整代码!应聚焦:
▶️ 核心算法:如“基于LRU的缓存淘汰策略实现”;
▶️ 异常处理:分布式事务中Seata的AT模式回滚逻辑;
▶️ 安全防护:JWT令牌生成与刷新机制、SQL注入过滤器。
代码示例(带注释说明设计意图):
@Service
public class OrderTimeoutService {
@Autowired
private RabbitTemplate rabbitTemplate;
public void cancelOrder(String orderId) {
// 发送延迟消息(30分钟)
rabbitTemplate.convertAndSend(
"order.exchange",
"order.timeout",
orderId,
message -> {
message.getMessageProperties().setDelay(30 * 60 * 1000);
return message;
}
);
}
@RabbitListener(queues = "order.cancel.queue")
public void handleCancel(String orderId) {
// 执行取消逻辑:更新状态 + 释放库存
orderService.updateStatus(orderId, "CANCELLED");
inventoryService.releaseStock(orderId);
}
}