docs/00-overview.md
This commit is contained in:
@@ -0,0 +1,84 @@
|
||||
# 15 开发工作方式
|
||||
|
||||
## 分阶段开发
|
||||
|
||||
**不要一次生成整个项目。** 必须分阶段开发。
|
||||
|
||||
每完成一个阶段:
|
||||
|
||||
1. 检查代码
|
||||
2. 检查数据库
|
||||
3. 运行测试
|
||||
4. 检查 API
|
||||
5. 检查前端
|
||||
6. 修复问题
|
||||
7. 再进入下一阶段
|
||||
|
||||
不要为了"快速完成"一次生成几百个文件。
|
||||
|
||||
## 修改代码前
|
||||
|
||||
1. 先理解现有目录
|
||||
2. 搜索已有实现
|
||||
3. 不要重复创建已有功能
|
||||
4. 检查数据库结构
|
||||
5. 检查相关 API
|
||||
6. 检查前端调用
|
||||
7. 再修改代码
|
||||
|
||||
## 修改代码后
|
||||
|
||||
1. 检查类型
|
||||
2. 检查语法
|
||||
3. 检查引用
|
||||
4. 检查数据库迁移
|
||||
5. 检查 API
|
||||
6. 检查权限
|
||||
7. 检查租户隔离
|
||||
8. 运行相关测试
|
||||
|
||||
## 代码质量
|
||||
|
||||
代码必须:
|
||||
|
||||
- 清晰
|
||||
- 可维护
|
||||
- 类型明确
|
||||
- 避免重复
|
||||
- 避免超大 Controller
|
||||
- 避免超大 Service
|
||||
- 避免魔法字符串
|
||||
- 避免硬编码
|
||||
- 避免重复 SQL
|
||||
- 避免跨模块强耦合
|
||||
|
||||
优先可读性,而不是为了"高级架构"而复杂化。
|
||||
|
||||
## 需求存在架构问题时
|
||||
|
||||
不要直接照做,请指出:
|
||||
|
||||
1. 问题是什么
|
||||
2. 为什么有问题
|
||||
3. 推荐方案
|
||||
4. 替代方案
|
||||
5. 最终建议
|
||||
|
||||
如果有多个合理方案,不要擅自选择影响整个项目架构的方案,先说明区别。
|
||||
|
||||
## 禁止事项
|
||||
|
||||
- 为了快速开发跳过架构设计
|
||||
- Controller 堆业务逻辑
|
||||
- 一个 Model 承担所有业务
|
||||
- Python 直接修改核心 WMS 数据
|
||||
- 忽略 tenant_code
|
||||
- 忽略库存流水
|
||||
- 直接修改库存而没有业务记录
|
||||
- 不考虑并发库存
|
||||
- 把 Amazon 等平台逻辑写死到核心订单模型
|
||||
- 为了所谓高性能过早微服务化
|
||||
- 没有测试就继续堆功能
|
||||
- 随意增加第三方依赖
|
||||
- 重复实现 Element Plus 已经提供的组件
|
||||
- 修改已有代码前不检查上下文
|
||||
Reference in New Issue
Block a user