Big-React
从零实现 React v18 的核心功能,特点如下:
- 👬 与 React 源码最接近的实现
- 💪 功能完备,当前可跑通官方测试用例数量:34
- 🚶 按
Git Tag
划分迭代步骤,记录从 0 实现的每个功能
如果想跟着我学习「如何从 0 到 1 实现 React18」,可以点击这里
TODO List
工程类需求
类型 | 内容 | 完成情况 | 在哪个版本实现的 |
---|---|---|---|
架构 | monorepo(pnpm 实现) | ✅ | v1 |
规范 | eslint | ✅ | v1 |
规范 | prettier | ✅ | v1 |
规范 | commitlint + husky | ✅ | v1 |
规范 | lint-staged | ✅ | v1 |
规范 | tsc | ✅ | v1 |
测试 | jest 环境搭建 | ✅ | v4 |
规范 | tsc | ✅ | v1 |
构建 | babel 配置 | ✅ | v4 |
构建 | Dev 环境包的构建 | ✅ | v1 |
构建 | Prod 环境包的构建 | ⬜️ | |
部署 | Github Action 执行 lint 与 test | ⬜️ | |
部署 | Github Action 根据 tag 发布 npm 包 | ⬜️ |
框架需求
类型 | 内容 | 完成情况 | 在哪个版本实现的 |
---|---|---|---|
React | JSX 转换 | ✅ | v1 |
React | React.isValidElement | ✅ | v4 |
ReactDOM | 浏览器环境 DOM 的插入 | ✅ | v2 |
ReactDOM | 浏览器环境 DOM 的移动 | ✅ | v7 |
ReactDOM | 浏览器环境 DOM 的属性变化 | ⬜️ | |
ReactDOM | 浏览器环境 DOM 的删除 | ✅ | v5 |
ReactDOM | ReactTestUtils | ✅ | v4 |
ReactNoop | ReactNoop Renderer | ✅ | v10 |
Reconciler | Fiber 架构 | ✅ | v1 |
Reconciler | 事件模型 | ✅ | v6 |
Reconciler | onClick 事件支持 | ✅ | v6 |
Reconciler | input 元素 onChange 事件支持 | ⬜️ | |
Reconciler | Lane 模型 | ✅ | v8 |
Reconciler | 基础 Update 机制 | ✅ | v1 |
Reconciler | 带优先级的 Update 机制 | ✅ | v8 |
Reconciler | 插入单节点的 mount 流程 | ✅ | v1 |
Reconciler | 插入多节点的 mount 流程 | ✅ | v7 |
Reconciler | 插入单节点的 reconcile 流程 | ✅ | v5 |
Reconciler | 插入多节点的 reconcile 流程 | ✅ | v7 |
Reconciler | 删除节点的 reconcile 流程 | ✅ | v5 |
Reconciler | HostText 类型支持 | ✅ | v2 |
Reconciler | HostComponent 类型支持 | ✅ | v1 |
Reconciler | HostRoot 类型支持 | ✅ | v1 |
Reconciler | FunctionComponent 类型支持 | ✅ | v3 |
React | Hooks 架构 mount 时实现 | ✅ | v3 |
React | Hooks 架构 update 时实现 | ✅ | v5 |
Reconciler | useState 实现 | ✅ | v3 |
Reconciler | useEffect 实现 | ✅ | v9 |
Reconciler | useRef 实现 | ✅ | ref |
Reconciler | Legacy 调度流程(包含 batchedUpdates) | ✅ | v8 |
Reconciler | Concurrent 调度流程 | ✅ | v11 |
Reconciler | useTransition 实现 | ✅ | useTransition |
Reconciler | useContext 及 context 流程实现 | ✅ | context 实现 |
Reconciler | unwind 流程 | ✅ | unwind 流程 |
Reconciler | Suspense 组件实现 | ✅ | Suspense |
Reconciler | Offscreen 组件实现 | ✅ | Offscreen |
Reconciler | use hook 实现 | ✅ | use hook |
React | React.lazy 实现 | ✅ | Lazy 实现 由L-Qun完成 |
React | React.memo 实现 | ✅ | React.memo 实现 |
Reconciler | bailout性能优化策略 | ✅ | bailout 实现 |
Reconciler | eagerState性能优化策略 | ✅ | eagerState 实现 |
Reconciler | useMemo 实现 | ✅ | useMemo 实现 |
Reconciler | useCallback 实现 | ✅ | useCallback 实现 |
Reconciler | context兼容bailout策略 | ✅ | context兼容 |
调试
提供 3 种调试方式:
- 实时调试
执行pnpm demo
会运行项目demos
目录下的示例项目(默认项目是针对v9的调试项目)
这种方式的好处是:
-
控制台会打印各个主要步骤的执行信息,可以直观看到执行流程
-
热更新(包括示例代码和源码代码)
- pnpm link
通过CRA
或Vite
起一个React
测试项目后,在本项目执行pnpm run build:dev
打包react
与react-dom
,在测试项目中通过pnpm link
将项目依赖的react
与react-dom
替换为我们打包的react
与react-dom
这种方式的好处是:最贴合项目中实际使用React
的情况
- 跑
React
官方的测试用例
执行pnpm test
跑官方的测试用例,用例中引用的是执行pnpm run build:dev
打包的react
与react-dom
这种方式的好处是:可以从官方用例的角度观察框架实现的细节、各种边界情况
更新日志
v11
实现了并发更新,通过修改 packages/react-dom/src/SyntheticEvent.ts 中的 eventTypeToEventPriority 方法下的 click 对应优先级, 可以观察同步更新(SyncLane)与其他优先级下的点击事件中触发更新的区别(是否会开启时间切片)。包括如下功能:
- Concurrent 调度流程
v10
这一版的改动比较大,为了实现 React-Noop-Renderer,对 React-Reconciler 与 rollup 配置做了一些调整,使 React-Reconciler 更通用(可以对接不同宿主环境)。包括如下功能:
-
实现 React-Noop-Renderer,可以脱离 ReactDOM 更好的测试 Recocniler 逻辑
-
对 rollup 配置做了改动,以配合 React-Reconciler 更好对接不同宿主环境
-
引入 React 的内部包 jest-react、react-test-renderer,配合自制的 React-Noop-Renderer 测试并发情况下的 React case
-
跑通 useEffect 调用顺序的 case
-
修复了过程中发现的 Diff 算法的小 bug
-
Scheduler、jest-react、react-test-renderer 均采用 NPM 包形式引入
v9
实现了 useEffect,为了实现 useEffect 回调的异步调度,引入了官方的 scheduler 模块。当前 scheduler 模块的生产环境版本放在 packages 目录下,方便对他进行修改。如果后期证实没有需要特别修改的地方,会考虑以 NPM 包的形式引入 scheduler。包括如下功能:
- useEffect 实现
v8
实现了基础功能的 Lane 模型,可以调度同步更新,并基于此实现了 batchedUpdates(批处理),包括如下功能:
-
Lane 模型
-
带优先级的 Update 机制
-
Legacy 调度流程(包含 batchedUpdates)
-
修复了多个子节点中 number 类型节点不支持的 bug
v7
实现了多节点 reconcile 流程(俗称的 Diff 算法),包括如下功能:
-
修复了 update 时 onClick 回调不更新的 bug
-
插入多节点的 mount 流程
-
插入多节点的 reconcile 流程
-
浏览器环境 DOM 的移动
Diff 算法的测试用例还依赖 useEffect、useRef 的实现,放在后面再实现
v6
实现事件系统,包括如下功能:
- 事件模型
- onClick 事件支持(以及 onClickCapture 事件)
v5
实现单节点 update,包括如下功能:
- 浏览器环境 DOM 的删除(比如 h3 变为 p,那么就要经历删除 h3、插入 p)
- 插入单节点的 reconcile 流程(包括 HostComponent、HostText)
- 删除节点的 reconcile 流程(为后续 ref、useEffect 特性做准备,实现的比较完备)
- Hooks 架构 update 时实现
v4
初始化测试相关架构,包括如下功能:
- 实现 React.isValidElement
- jest 环境搭建
- babel 配置
- ReactTestUtils
- 跑通关于 jsx 的 17 个官方用例
v3
实现 useState 的 mount 时流程,包括如下功能:
- FunctionComponent 类型支持
- Hooks 架构 mount 时实现
- useState 实现
v2
插入单节点的 mount 流程(可以在浏览器环境渲染 DOM),包括如下功能:
- 浏览器环境 DOM 的插入
- HostText 类型支持
v1
插入单节点的 render 阶段 mount 流程,包括如下功能:
- JSX 转换
- Fiber 架构
- 插入单节点的 reconcile 流程
- HostComponent 类型支持
- HostRoot 类型支持
注:还未实现浏览器环境下的渲染