Vue3 源码系列:项目调试和项目架构分析(一)

为什么阅读源码

在公司大多数开发人员是在开发和维护一个相对稳定成熟的系统,每天搬砖写业务代码,很少有机会在项目里捣鼓应用一些新的技术。那么,怎么提升自己的技术能力呢?阅读优秀的开源项目是值得推荐的学习方式,特别是在项目里经常使用的框架源码,这样既加深自己对框架的理解,知其然而知其所以然,也能学习它优秀的代码设计,规范等,学习开源大牛们的思想结晶,吸收他们优秀的经验。

vue3 在 vue2 基础上做了很大的改进,重写了响应式系统、编译原理,设计 composition 组合式api,使用 TypeScript 等等,之前阅读过 vue2 核心源码,受益良多,也让我更加有动力去阅读研究 vue3 底层设计带来了哪些变化,从中学习新的技术和思想。

源码学习方法

阅读源码,并不是一上来就啃源码,那样会被绕晕,在庞大的代码量面前被劝退。按照以往的经验。首先是搭建好开发调试环境,让项目跑起来,这时候心里就有底了。接着了解项目的架构和技术栈,知道大体的目录结构功能,做的是什么事;最后带着目的和问题去阅读源码:例如

  • 项目初始化和挂载流程是什么?
  • 响应式系统是怎么实现的?
  • nextTick 异步更新策略是怎么实现的?
  • ……

带着这些问题一步一步的去看,一步一步的调试,单点突破,沿着这条主线,耐心寻找到想要的答案。

搭建源码调试环境

  1. 克隆源码,下载到本地
git clone [email protected]:vuejs/core.git
  1. 安装依赖,使用的是 pnpm
cd core && pnpm install
  1. 打包 vue 文件
pnpm run dev

运行 pnpm run dev 创建 packages/vue/dist 目录,生成两个文件 vue.global.jsvue.global.js.map,是打包后的 vue 文件

  1. 启动本地服务

ctrl + c 结束进程,执行 pnpm run serve

pnpm run serve

上面命令启动一个服务,默认启动一个端口,打开 localhost,显示项目的目录结构界面

Vue3 源码系列:项目调试和项目架构分析(一)_第1张图片

进入界面事例,点击 packages =》 vue =》 examples,选择一个 classic/todomvc,进入 todomvc.html界面

Vue3 源码系列:项目调试和项目架构分析(一)_第2张图片

也可以在 packages/vue/example 目录下新建一个 html 文件,引入 dist/vue.global.js 文件,安装 http 服务插件 VSCode Live Server,在本地启动服务打开 html 文件

  1. 打开浏览器开发者工具

source 面板,快捷键 cmd + p,输入 todomvc,进入 todomvc 文件源码

Vue3 源码系列:项目调试和项目架构分析(一)_第3张图片

cmd + f 搜索 Vue.createApp,大概在 85 行的位置打上断点单步调试,进入 createApp 函数;

查看源码文件的路径结构,右键鼠标,选择 Reveal in sidebar 在左侧边栏打开

Vue3 源码系列:项目调试和项目架构分析(一)_第4张图片

这时可以看到 createApp 函数的真面目,在 /packages/runtime-dom/src/index.ts

Vue3 源码系列:项目调试和项目架构分析(一)_第5张图片

  1. 开启源码调试模式

如果想在源码中打上 debuggerconsole 调试,可以在 dev 命令后添加调试参数 --sourcemap

"scripts": {
"dev": "node scripts/dev.js --sourcemap",
}

rollup 在打包 vue 的时候,根据环境参数配置打包

Vue3 源码系列:项目调试和项目架构分析(一)_第6张图片

项目架构

开始阅读源码前,先从全局的角度对框架的设计有整体的认知,否则在阅读过程中,容易被细节困住,迷失方向。

项目结构

先从目录结构开始分析,了解每个模块做哪些功能,模块与模块之间是如何划分和关联的。

Vue 3 从代码结构上进行了梳理,采用 monorepo 单体仓库模式管理项目代码,使用 pnpm workspace 方式实现。它将内部实现的部分抽象成了一个个模块放在 packages 下,每个 packages 子目录都有自己的类型声明、单元测试。 package 可以独立发布,这样设计便于维护、发版和阅读。例如我们可以单独引用 reactivity 这个模块,在导入这些软件包时,需要 @vue/前缀。

// 目录结构分析
├── .github              // github 工作流,issue 模版,代码贡献指南
├── .vscode              // vscode 编辑器的配置
├── packages             // vue 源码核心包,使用 pnpm workspace 工作区管理
│   ├── compiler-core    // 编译器(平台无关),例如基础的 baseCompile 编译模版文件, baseParse生成AST
│   ├── compiler-dom     // 基于compiler-core,专为浏览器的编译模块,可以看到它基于baseCompile,baseParse,重写了complie、parse
│   ├── compiler-sfc     // 编译vue单文件组件
│   ├── compiler-ssr     // 服务端渲染编译
│   ├── reactivity       // vue独立的响应式模块,可以与任何框架配合,使用proxy
│   ├── reactivity-transform  // 响应式实验功能,目前仅用于测试
│   ├── runtime-core     // 与平台无关的运行时。有虚拟DOM渲染器,vue组件和各种API。可针对某个具体平台实现高阶runtime,比如自定义渲染器
│   ├── runtime-dom      // 针对浏览器的runtime。包含处理原生DOM API 
│   ├── runtime-test     // 一个专门为了测试而写的轻量级 runtime。由于这个 rumtime 「渲染」出的 DOM 树其实是一个 JS 对象,所以这个 runtime 可以用在所有 JS 环境里。你可以用它来测试渲染是否正确。
│   ├── server-renderer     // 服务端渲染
│   ├── sfc-playground
│   ├── shared             // 内部工具库,不暴露API
│   ├── size-check          // 简单应用,用来测试代码体积
│   ├── template-explorer  // 用于调试编译器输出的开发工具
│   └── vue                 // 面向公众的完整版本, 包含运行时和编译器
│   └── vue-compat          // 用于兼容 vue2
│   ├── global.d.ts      // 声明文件
├── scripts              // vue3脚本文件,包含配置文件,进行编译和打包等
│   ├── bootstrap.js
│   ├── build.js
│   ├── checkYarn.js
│   ├── dev.js
│   ├── release.js
│   ├── setupJestEnv.ts
│   ├── utils.js
│   └── verifyCommit.js
├── test-dts             // 测试文件
│   ├── README.md
│   ├── component.test-d.ts
│   ├── componentTypeExtensions.test-d.tsx
│   ├── defineComponent.test-d.tsx
│   ├── functionalComponent.test-d.tsx
│   ├── h.test-d.ts
│   ├── index.d.ts
│   ├── inject.test-d.ts
│   ├── reactivity.test-d.ts
│   ├── ref.test-d.ts
│   ├── setupHelpers.test-d.ts
│   ├── tsconfig.build.json
│   ├── tsconfig.json
│   ├── tsx.test-d.tsx
│   └── watch.test-d.ts
├── CHANGELOG.md    // 多个版本提交记录、时间和内容
├── LICENSE         // MIT协议是所有开源许可中最宽松的一个,除了必须包含许可声明外,再无任何限制。
├── README.md       // 项目说明
├── api-extractor.json   // 这是所有包的共享基本配置文件
├── jest.config.js       // 测试配置文件
├── package.json         // 项目依赖
├── rollup.config.js     // rollup打包配置文件
├── tsconfig.json        // 定了用来编译这个项目的根文件和编译选项
├── pnpm-lock.yaml       // 锁定依赖版本
└── pnpm-workspace.yaml  // pnpm 工作区
  • compiler-core: 编译器(平台无关),例如基础的 baseCompile 编译模版文件, baseParse 生成AST
  • compiler-dom: 基于 compiler-core,专为浏览器的编译模块,可以看到它基于 baseCompilebaseParse,重写了complie、parse
  • compiler-sfc: 编译vue单文件组件
  • compiler-ssr: 服务端渲染相关的
  • reactivity: vue独立的响应式模块
  • runtime-core: 也是与平台无关的基础模块,有vue的各类API,虚拟dom的渲染器
  • runtime-dom: 针对浏览器的runtime。包含处理原生DOM API
  • runtime-test:一个专门为了测试而写的轻量级 runtime。由于这个 rumtime 「渲染」出的 DOM 树其实是一个 JS 对象,所以这个 runtime 可以用在所有 JS 环境里。你可以用它来测试渲染是否正确。
  • shared:内部工具库,不暴露API
  • size-check:简单应用,用来测试代码体积
  • template-explorer:用于调试编译器输出的开发工具
  • vue :面向公众的完整版本, 包含运行时和编译器
  • api-extractor.json —— 所有包共享的配置文件。当我们 src 下有多个文件时,打包后会生成多个声明文件。使用 @microsoft/api-extractor 这个库是为了把所有的 .d.ts 合成一个,并且,还是可以根据写的注释自动生成文档。
  • template-explorer: 用于调试编译器输出的开发工具。您可以运行npm run dev dev template-explorer并打开它 index.html 以获取基于当前源代码的模板编译的副本。在线编译网址:vue-next-template-explorer.netlify.app/#

Vue 源码入口

首先阅读 官网 了解功能使用,Vue3 实例化应用不在采用 new 方式,而是使用 createApp

import { createApp } from 'vue'

createApp({
  data() {
    return {
      count: 0
    }
  }
}).mount('#app')

从上面调试在 createApp 打上 debug,进入这个函数,函数位置在文件 packages/runtime-dom/src/index.ts

export const createApp = ((...args) => {
  const app = ensureRenderer().createApp(...args)

  if (__DEV__) {
    injectNativeTagCheck(app)
    injectCompilerOptionsCheck(app)
  }

  const { mount } = app
  app.mount = (containerOrSelector: Element | ShadowRoot | string): any => {
    const container = normalizeContainer(containerOrSelector)
    if (!container) return

    const component = app._component
    if (!isFunction(component) && !component.render && !component.template) {
      if (__COMPAT__ && __DEV__) {
        for (let i = 0; i < container.attributes.length; i++) {
          const attr = container.attributes[i]
          if (attr.name !== 'v-cloak' && /^(v-|:|@)/.test(attr.name)) {
            compatUtils.warnDeprecation(
              DeprecationTypes.GLOBAL_MOUNT_CONTAINER,
              null
            )
            break
          }
        }
      }
    }

    // clear content before mounting
    container.innerHTML = ''
    const proxy = mount(container, false, container instanceof SVGElement)
    if (container instanceof Element) {
      container.removeAttribute('v-cloak')
      container.setAttribute('data-v-app', '')
    }
    return proxy
  }

  return app
}) as CreateAppFunction

上面代码 createApp 创建应用时调用的方法实现流程

  • ensureRenderer 是一个单例模式的函数,会返回一个 renderer,如果无 renderer 则会调用createRenderer 进行获取 renderer ,获得了一个 app 实例;
  • dev环境下注册一个方法:isNativeTag,挂载到 app.config 下面;
  • 获取到实例的 mount 方法,并保存下来;
  • 重写实例的 mount 方法;

    • 调用 normalizeContainer 获取根元素容器;
    • 判断 template,获取需要渲染的模板;
    • 把容器的 innerHTML 置空;
    • 调用上面实例的 mount 方法;
    • 删除 v-cloak 属性,添加 data-v-app 属性;
  • 返回mount后的代理;

从上面来看,createApp 主要做的事是调用 `ensureRenderer().createApp(...args)
创建一个 app 实例,然后重写 mount` 方法挂载,返回这个实例,整个实例化和挂载的流程很清晰,细节在后面深入研究分析。

其次,当代码逻辑比较复杂难读懂的时候,可以从测试用例入手。比如某个方法使用在官网上描述不是很清晰,想知道的更多些,比起直接深入到源码中,测试用例是一个相对快捷省时的方式。

测试文件后缀是 spec,例如 createApp 测试文件createApp.spec.ts ,有两条测试用例

  • 可以挂载到 svg 元素上
  • 不应该改变原来的根组件选项对象

而且也给出对应修复的 issue,还可以去到issue上了解这个功能的背景

describe('createApp for dom', () => {
  // #2926
  test('mount to SVG container', () => {
    const root = document.createElementNS('http://www.w3.org/2000/svg', 'svg')
    createApp({
      render() {
        return h('g')
      }
    }).mount(root)
    expect(root.children.length).toBe(1)
    expect(root.children[0] instanceof SVGElement).toBe(true)
  })

  // #4398
  test('should not mutate original root component options object', () => {
    const originalObj = {
      data() {
        return {
          counter: 0
        }
      }
    }

    const handler = jest.fn(msg => {
      expect(msg).toMatch(`Component is missing template or render function`)
    })

    const Root = { ...originalObj }

    const app = createApp(Root)
    app.config.warnHandler = handler
    app.mount(document.createElement('div'))

    // ensure mount is based on a copy of Root object rather than Root object itself
    expect(app._component).not.toBe(Root)

    // ensure no mutation happened to Root object
    expect(originalObj).toMatchObject(Root)
  })
})

总结思考

阅读源码,选择一个合适的工具让代码先跑起来,能够在源码上调试,然后理清楚代码组织关系及用途,单点突破,带着问题和目的去阅读,利用好单元测试。同时也要权衡利弊,该跳就跳,长期处于蒙的状态很容易走进死胡同,可以标记回头再看;利用搜索引擎,结合网上的源码分析资料理解。

你可能感兴趣的