阅读本篇可以了解到vue-next项目结构和调试方法,有助于我们更高效的阅读源码。
目录:
- 项目结构
- Vue3的导出对象
- 开发调试
项目结构
vue-next项目开发采用的是monorepo模式,在packages目录下托管许多相互关联的应用程序包。参考:yarn workspaces
为什么选择Monorepo?
- 单一存储库方法减少了为在不同存储库中创建多个包/应用程序而必须编写的重复样板代码的数量。
- Monorepo方法创造了one source of truth。
- 共享代码和代码可重用性更加容易,因为每个包都属于同一存储库,并且遵循相同的结构和开发过程。
- 大规模重构变得非常容易。某些影响代码库多个部分的API更改可以在一次提交或请求中完成。
packages目录一览
reactivity
:响应式系统。它可以独立于框架使用。runtime-core
:与平台无关的运行时核心。包括虚拟dom渲染器,组件实现和JavaScript API的代码。可以使用此程序包创建针对特定平台的高阶运行时(即自定义渲染器)。runtime-dom
:针对浏览器的运行时。包括对原生DOM API,attributes, properties, event事件相关的处理。runtime-test
:用于测试的轻量级运行时。它可以在任何JavaScript环境中“渲染”出一个纯JavaScript对象树。该树可用于声明正确的渲染输出。同时提供了一些工具:序列化树,触发事件,记录更新期间执行的实际节点操作。server-renderer
:服务端渲染相关的软件包。compiler-core
:与平台无关的编译器核心。包括编译器和所有与平台无关的插件的可扩展基础。compile-dom
:带有专门针对浏览器相关插件的编译器。compiler-ssr
:针对服务端渲染生成优化过的渲染函数的编译器。template-explorer
:用于调试编译器输出的开发工具。您可以运行yarn dev template-explorer
并打开其index.html以获得基于当前源代码的模板编译副本。
还提供了模板浏览器的实时版本,可用于提供编译器错误的再现。您还可以从发布日志中选择特定版本。shared
:在多个软件包之间共享的内部实用程序(尤其是运行时和编译器软件包使用的与环境无关的utils)。vue
:“全面构建”,包括运行时和编译器。
Vue3的导出对象
vue2
暴露出来的是一个构造函数,其原型链上注入了许多方法和属性
vue3
暴露出的是一个json对象
后面会和大家一起来感受二者源码设计思路上的改变。
vue3开发调试
Development Setup
:开发调试的准备工作。
环境要求:需要安装nodejs v10+
和yarn 1.x
安装依赖
yarn
构建命令介绍:
yarn build
命令会构建packages
目录下所有程序包,但不包含package.json
中特殊声明private: true
的程序包
同时还支持模糊匹配(fuzzy matching
)构建模式,例如:
# build runtime-core only
yarn build runtime-core
# build all packages matching "runtime"
yarn build runtime --all
构建格式
在packages
目录下的每个目录中的package.json
文件里存在声明字段buildOptions.formats
,支持使用-f
命令进行覆盖。
支持的格式有:
- global
- esm-bundler
- esm-browser
- cjs
以下模式仅在packages/vue
包构建中支持:
- global-runtime
- esm-bundler-runtime
- esm-browser-runtime
yarn dev
命令会以global
模式构建packages/vue
程序包,并且会监听代码的改动。
$ yarn dev
> rollup v1.19.4
> bundles packages/vue/src/index.ts → packages/vue/dist/vue.global.js...
dev脚本还支持目标程序包的模糊匹配,但只会匹配第一个匹配的程序包。
开发脚本支持通过
-f
标志指定构建格式,就像构建脚本一样。dev脚本还支持
-s
标志用于生成sourcemap
,但是它将使重建速度变慢。
packages之间的依赖引入
包可以使用包名直接相互导入。 请注意,在导入软件包时,应使用其package.json中列出的名称。 大多数情况下,需要@vue/
前缀:
import { h } from '@vue/runtime-core'
该@vue/
前缀配置在tsconfig.json
中的compilerOptions.path
packages之间的依赖关系
总结
现在大家已经初步了解到:
- vue-next的目录结构
- 构建命令与构建模式
- 开发调试方法以及packages之间的依赖关系
了解更多
https://github.com/vuejs/vue-next/blob/master/.github/contributing.md