← Writing
如何快速了解一个新代码库
May 2022 · 2 min read
策略：high level 理解每个项目及其关系。第一天不要 dive deep。
先定位这些
- Git 仓库
- 部署环境（dev、test、prod）
- Wiki、CI（Jenkins）、页面 URL、数据库地址
第一阶段：画数据路径
页面 URL → 前端 → 后台服务 → 数据库。
轻点浏览。分清用户看到什么、API 提供什么。标注各服务跑在哪。
第二阶段：数据模型
项目本质是对数据的 CRUD。找核心表、表间关系、各项目归属。
第三阶段：代码模式
业务逻辑通常三类：
- 交互式 CRUD
- 定时任务 / 脚本
- 调用或通知其他服务
第四阶段：API 工作流
- Postman 保存成功/失败样例
- 批量测接口
- 给前端生成 API 文档
- Mock 未完成的接口，避免阻塞前端
画状态流转图。映射接口对表的影响。
第五阶段：架构边界
- MQ 生产者与消费者
- 从 API 名推断跨服务调用图
- 从站会和 lead 处了解当前痛点
然后再深入分配的业务代码——但记得经常 zoom out 看全局。