"我想读源码,但打开 GitHub 就懵了——从哪开始看?"
这是我收到最多的提问之一。很多人知道读源码重要,但一打开项目就被几万行代码劝退。
我也是。第一次尝试读 Vue3 源码,打开 packages 目录一看——reactivity、runtime-core、runtime-dom、compiler-core、compiler-dom、compiler-sfc……十几个包,每个几千行。
看了半小时,关了。
直到后来我换了一套方法,花3周读完了 Vue3 响应式系统的核心逻辑,还写了 5 篇源码分析文章。不是因为我变聪明了,而是方法对了。
今天把这套方法分享出来,适用于任何开源项目 👇
一、先选对项目
不是所有项目都适合读源码。选错项目 = 浪费时间 = 自信心暴击。
选项目的3个标准
推荐的源码阅读路径
入门级(500-2000行): mitt、nanoid、dayjs、flatted进阶级(2000-10000行): pinia、vue-router、zustand、p-limit挑战级(10000-50000行): vue3 (reactivity部分)、vite (核心插件)、react (reconciler)地狱级(50000+行): webpack、typescript compiler、babel我的建议:从 pinia 开始。 它只有 ~3000 行,架构清晰,而且你一定用过。
二、读源码的正确顺序
90%的人读源码失败,是因为从第一行看到最后一行。这就像读一本小说从字典开始看——每个字都认识,连起来不知道在讲什么。
✅ 我的方法:4层递进
第1层:跑起来 → 知道项目做什么第2层:看文档 → 知道项目怎么用第3层:看入口 → 知道代码从哪开始第4层:跟调用链 → 知道核心逻辑怎么走第1层:跑起来
git clone 项目cd 项目pnpm installpnpm dev / pnpm test目标:让项目在你的机器上跑起来。 不是看代码,是跑起来。
跑起来之后,改几个参数,看看输出变化。这时候你对项目有了"体感"——知道输入什么、输出什么。
第2层:看文档
不是看源码,是看 README 和官方文档。重点关注:
• 项目解决了什么问题 • 核心 API 有哪些 • 架构设计文档(如果有的话)
目标:建立项目的"心智模型"。 你不需要知道代码怎么写,但需要知道它应该做什么。
第3层:找入口
每个项目都有一个入口文件,通常是:
// package.json{"main":"dist/index.js",// CJS 入口"module":"dist/index.mjs",// ESM 入口"types":"dist/index.d.ts"// 类型入口}但源码入口不一定在这里。看 tsconfig.json 或 build 配置找到源码入口:
Vue3 的源码入口: packages/vue/index.ts → 运行时入口 packages/reactivity/src/index.ts → 响应式入口 packages/compiler-core/src/index.ts → 编译器入口目标:知道代码的第一行在哪里。
第4层:跟调用链
这是最关键的一步。从一个 API 调用出发,跟踪整个执行路径。
以 Vue3 的 reactive() 为例:
import { reactive } from'vue'const state = reactive({ count: 0 })跟踪路径:
reactive({ count: 0 }) → packages/reactivity/src/reactive.ts → createReactiveObject(target, false, mutableHandlers, ...) → new Proxy(target, mutableHandlers) → mutableHandlers.get → track(target, TrackOpTypes.GET, key) → mutableHandlers.set → trigger(target, TriggerOpTypes.SET, key)你不需要看完所有代码,只需要看完这一条链路。
三、5个必备工具
1. GitHub 1s
把 GitHub URL 中的 github.com 改成 github1s.com,直接在 VS Code 中打开项目:
github.com/vuejs/core → github1s.com/vuejs/core比在网页上看代码舒服100倍。
2. Source Map 调试
在测试用例中打断点,通过 Source Map 直接跳到源码:
// 在 test 文件中import { reactive } from'../src/reactive'// 打断点,step into 就能进入源码const state = reactive({ count: 0 })3. 依赖关系图
用 madge 生成模块依赖图:
npx madge --image graph.png packages/reactivity/src/一眼看清模块之间的依赖关系,比一个个文件翻高效10倍。
4. Git Blame
看到一段代码不理解,用 Git Blame 看它是什么时候加的、谁加的、对应的 commit message 是什么:
git blame -L 100,120 packages/reactivity/src/reactive.ts很多代码的 commit message 会解释"为什么要这么写"。
5. Search Across Files
VS Code 全局搜索(Ctrl+Shift+F)是你的好朋友:
• 搜函数定义: function reactive• 搜类型定义: interface ReactiveEffect• 搜导出: export.*reactive
四、画架构图——最重要的习惯
读源码不画图 = 白读。 人的短期记忆只能保持 4-7 个信息块,一个模块的调用关系可能涉及 20+ 个函数,不画图根本记不住。
我画图的方法
1. 先画"大图"——模块关系 reactivity ← runtime-core ← runtime-dom compiler-core ← compiler-dom2. 再画"中图"——函数关系 reactive() → createReactiveObject() → new Proxy() effect() → createReactiveEffect() → run()3. 最后画"小图"——数据流 target → proxy → handler.get → track() target → proxy → handler.set → trigger() → effect.run()工具随意:纸笔、Excalidraw、Draw.io 都行。关键是画,不是画得好看。
五、写笔记——费曼学习法的实践
读完一个模块,用自己的话写下来。写不出来 = 没读懂。
我的笔记模板
## 模块:reactivity/reactive### 一句话总结reactive() 创建 Proxy 代理对象,拦截 get/set 操作,实现依赖收集(track)和派发更新(trigger)。### 核心流程1. 入口:reactive(target)2. 判断:target 是否已经是 reactive?是则直接返回3. 创建:new Proxy(target, handlers)4. 缓存:proxyMap.set(target, proxy)### 关键设计决策- 为什么用 Proxy 不用 Object.defineProperty? → 可以拦截新增属性、数组变化、delete 操作- 为什么需要 proxyMap 缓存? → 避免对同一个对象重复创建 Proxy### 疑问- shallowReactive 和 reactive 的 handlers 有什么区别? → TODO: 下次跟进不要抄代码,要用自己的话复述。 能用一句话说清楚的,说明你真懂了。
六、实战案例:3周读完 Vue3 响应式系统
Week 1:reactive + ref
Day 1-2:跑项目 + 读文档 + 找入口Day 3-4:跟踪 reactive() 调用链Day 5-6:跟踪 ref() 调用链Day 7:画架构图 + 写笔记Week 2:effect + computed
Day 1-2:跟踪 effect() 调用链Day 3-4:理解 track() 和 trigger() 机制Day 5-6:跟踪 computed() 调用链Day 7:画数据流图 + 写笔记Week 3:watch + 整合理解
Day 1-2:跟踪 watch() 调用链Day 3-4:梳理 reactive → effect → computed 整体流程Day 5-6:写一篇完整的源码分析文章Day 7:回顾 + 查缺补漏3周之后,你对响应式原理的理解会超过 90% 的前端开发者。 面试被问到响应式原理,你能从 Proxy 讲到 effect 链讲到调度器,而不是只说"用了 Proxy"。
常见误区
写在最后
读源码这件事,最大的敌人不是代码难,而是方法错。
用对方法,3周读完 Vue3 响应式;方法错了,3个月还在看 README。
记住核心原则:从用例出发,跟调用链,画架构图,写笔记。
6个字:用、跟、画、写、问、恒。
下次面试被问"读过什么源码",你可以自信地说出你的理解——不是背的,是真的读懂了的。
你读过什么开源项目的源码?有什么心得?评论区聊聊 👇
觉得有用就转发,帮更多人掌握读源码的方法 💡
夜雨聆风