.vue 怎么变成 .js,我们来试一试!看完会更懂 Vue 吗?

2023-11-22 22:20

本文主要是介绍.vue 怎么变成 .js,我们来试一试!看完会更懂 Vue 吗?,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

本文是基于Vite+AntDesignVue打造业务组件库[1]专栏第 12 篇,坚持就是胜利!

接着上篇说,交付一个 vue 组件不仅需要解析 DSL,还要处理 JS/TS,样式,类型声明等内容。我们先研究一下将 .vue 转换成 .js 的问题,这个是关键。

谁能处理 .vue 文件?

要想把 .vue 变成 .js,首先要知道什么工具能处理 .vue 文件,是不是很容易想到我们熟悉的 Webpack 和 Vite?

但是 Webpack 它本身也不能处理 .vue 文件,背后起作用的是 vue-loader[2]

同样地,Vite 也不是天生支持 vue,它能处理 .vue 文件是因为有了 @vitejs/plugin-vue[3] 和 @vitejs/plugin-vue2[4] 这两个插件,前者提供 Vue3 支持,后者提供 Vue2 支持。

vue-loader, @vitejs/plugin-vue, @vitejs/plugin-vue2 三者都依赖了一个核心模块 vue/compiler-sfc[5]

这里要注意 vue/compiler-sfc 和 @vue/compiler-sfc,前者相当于是一个调用入口和版本锁的作用,保证 vue 和 compiler-sfc 的版本一致性;后者是真正的代码实现。

a9a3ed9232f28bcc69dd63dc3ebd3649.png

@vue/compiler-sfc 才是真正具备处理 .vue 文件能力的源头,毕竟这种底层能力还是得看官方。@vue/compiler-sfc 具备两大能力,一个是 parse,一个是 compile。

.vue 被 parse 成了什么?

由于本文的焦点不是源码分析,所以也没必要逐行去分析 @vue/compiler-sfc 的源码,只要把握好 parse 的主干流程即可。

我们把 Vue 的源码下载下来。

git clone https://github.com/vuejs/core.git

然后运行 pnpm install 把依赖装好,保证一些依赖代码,TS 类型能看得更清楚。

我们打开 compiler-sfc 的 parse.ts 源码瞧一瞧,这里有一个很显眼的parse方法。

d10f2335fa73018bae75c51d9ee7573e.png

了解一个函数的作用,最直接的就是看它的输入和输出,我们可以直接观察入参类型和返回值类型,做到窥一斑而知全豹。

parse的入参有两个,一个是 string 类型的source,它代表 .vue 文件的源码字符串;第二个参数类型是SFCParseOptions,是一些条件参数,先不用关注。

parse函数的返回值类型是SFCParseResult,它下面有一个属性descriptor

b9b6ecac94bb9198f6de53ba6ebc95dc.png

descriptor 描述了 parse 的结果,比如 .vue 的 template 部分(也就是模板部分)被 parse 成SFCTemplateBlock了。

0198766a8952f6cf955934c5ae18f524.png

SFCTemplateBlock继承了SFCBlock,并且有ast属性,ast就是抽象语法树,可以用结构化的数据描述模板的结构。

b88d33e7c4db0168d2c6f353c5d3124b.png

.vue 的 script 部分分为两块来看,一个是不带setup属性的常规script,一个是带setup属性的 scriptSetupscriptscriptSetup 的 AST 结构是不一样的。

bb9f63463809dacbc7e23c36a4472fee.png

.vue 的 style 部分则是被 parse 成一个数组styles,它的类型是SFCStyleBlock[]。为什么 style 的 parse 结果会是一个数组呢?这是因为我们可以在 .vue 文件中写多个 style 块。

df7b08b7b10e206e63e3155b3482cff7.png

SFCStyleBlock包含了两个标记类的属性scoped, module,分别代表有没有启用 scoped 和 css module 特性。

7f3eacf1ff4e98a4f7e06affbec9e6ee.png

parse 过程还会得到cssVars,它通过分析样式中的v-bind()得到。

slotted代表你有没有使用 scoped 样式块,并且在这个 scoped 样式块中用了 slot 样式穿透语法:slotted()

了解了大致结构后,我们可以动手测试一下,加深印象。

我们准备一个简单的 test.vue 作为测试的源文件。

970a7b71f18d8097765867af7d6e70a3.png

然后新建一个 test-compiler-sfc.js 用于编写测试逻辑,主要就是读取 test.vue 文件内容,然后调用parse函数得到解析结果。可以断点调试,浏览一下parseResult到底是什么样的数据,包含了哪些内容。

5d07de13b8e326d531bf5b467e88bc7f.png

compiler 主要做了什么?

@vue/compiler-sfc 中有几个以 compile 开头的函数,分别是compileScirpt, compileTemplate, compileStyle,我们挑一些重点看一看。

compileScript

compileScript负责编译脚本,它的第一个参数是descriptor,这是因为 Vue3 支持同时写 script 块和 setupScript 块,编译时需要把两个 block 整合,而 parse 得到的descriptor中可以拿到这些信息。

4d9e805af986b67c74c8d63abcdc813d.png

由于 script 不仅支持langt="js",还支持 ts, jsx, tsx,所以compileScript还会根据情况引入相关 babel 插件。

考虑到 Vue3 支持 v-bind in CSS 特性,编译脚本时还要考虑注入useCssVars

81ef8ac77329575915e2b1ba2f801bfa.png

如果用到了 setup 语法糖,则会有更复杂的分析过程,因为 setup 语法糖带来了一些编译时特性(比如编译宏 defineProps 等),这里不再深入研究。

compileTemplate

compileTemplate负责编译模板,先看看它的参数类型和返回值类型。

88d6196cc41b1a06ab0c1104c138cbff.png

scoped是依据 styles 中有没有 scoped 属性来决定的,用于给标签加data-v-xxx属性。

slotted来源于parse过程中得到的slotted,这个是跟插槽有关的。

compileTemplate通过preprocessLang支持模板预处理,基于此可以支持类似 pug 之类的模板语法。

compileTemplate.ts 代码量不多,其编译的核心工作是交给了 @vue/compiler-dom 和 @vue/compiler-core 处理(这里暂时不讨论 ssr)。

沿着调用链路找,可以观察到整体过程是一个比较标准的 parse -> transform -> generate 三部曲。

02418ff2227c58fb1feb480c5ccc996f.png

template 最终是被编译为渲染函数了,所以其实也是 js,应该不会感到意外吧?

60b32dbd725903401f74f4fbaec7e60c.png

compileStyle

compileStyle是编译样式的,同样地,我们先看看它的参数类型和返回值类型。

7d5bc4a8edb44fec8a2eb6fd220024f3.png

我们注意到SFCStyleCompileOptions中有一个 id,它是组件的一个 uuid,可以用hash-sum[6]生成,具体生成时与一些路径和文件名信息有关。这个 id 也是我们在观察 DOM 结构时看到的 data-v-xxxxx 的源头。

3904e478b648c65fa12b1a6fd91384a8.png

了解了以上关键信息后,我们可以在 test-compiler-sfc.js 中补充一些简单的调用。

export async function test() {const fileName = "test.vue"const filePath = resolve(__dirname, fileName)const fileContent = await readFileSync(filePath)const { descriptor } = parse(fileContent.toString(), { filename: fileName })const rawShortFilePath = relative(process.cwd(), filePath).replace(/^(\.\.[\/\\])+/, '')const shortFilePath = rawShortFilePath.replace(/\\/g, '/')const id = hash(shortFilePath)descriptor.id = id;const styles = descriptor.styles.map(block => compileStyleBlock(block, descriptor))console.log(styles)const script = compileScript(descriptor, { id })console.log(script)const hasScoped = descriptor.styles.some((s) => s.scoped);const template = compileTemplate({ source: descriptor.template.content, filename: descriptor.filename, id, scoped: hasScoped, slotted: descriptor.slotted })console.log(template)
}

也可以打断点调试一下过程。

97e6384ab2ed983e8744138542b5e81c.png

有了以上信息,相信你大概知道 .vue 源码是怎么变成 .js 文件了,只要合理地将一些编译结果组合起来,缝缝补补,最后加一个fs.writeFile写入文件的操作,这应该难不倒你吧?

涉及的源码可在vue-pro-components c10 分支[7]找到,欢迎 star 支持!

小结

我们大致了解了 @vue/compiler-sfc 做的事情,知道了是 @vue/compiler-sfc 提供了核心的 API,但是把这些 API 真正用到生产实践中还要考虑很多细节,需要合理地串起流程,同时考虑一些特殊场景。这些在 vue-loader 和 Vite 的插件 @vitejs/plugin-vue, @vitejs/plugin-vue2 中也有体现,感兴趣的朋友可以再去研究相关代码,这里不再展开。

我们做组件库,不到万不得已肯定是不会去开发底层工具链的,所以只要知道怎么用这些工具即可。

参考资料

[1]

基于Vite+AntDesignVue打造业务组件库: https://juejin.cn/column/7140103979697963045

[2]

vue-loader: https://vue-loader.vuejs.org/

[3]

@vitejs/plugin-vue: https://github.com/vitejs/vite-plugin-vue/tree/main/packages/plugin-vue

[4]

@vitejs/plugin-vue2: https://github.com/vitejs/vite-plugin-vue2

[5]

vue/compiler-sfc: https://github.com/vuejs/core/tree/main/packages/compiler-sfc

[6]

hash-sum: https://www.npmjs.com/package/hash-sum

[7]

vue-pro-components c10 分支: https://github.com/cumt-robin/vue-pro-components/tree/c10

END

47a710b2869435ffa39af6154a799cec.png

如果觉得这篇文章还不错

点击下面卡片关注我

来个【分享、点赞、在看】三连支持一下吧3a7cf70a4dca4db931c7f6ba23ea299e.png

   “分享、点赞、在看” 支持一波 94414e39002799a707350ff0ac6e268b.png 

这篇关于.vue 怎么变成 .js,我们来试一试!看完会更懂 Vue 吗?的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/413304

相关文章

HTML5中的Microdata与历史记录管理详解

《HTML5中的Microdata与历史记录管理详解》Microdata作为HTML5新增的一个特性,它允许开发者在HTML文档中添加更多的语义信息,以便于搜索引擎和浏览器更好地理解页面内容,本文将探... 目录html5中的Mijscrodata与历史记录管理背景简介html5中的Microdata使用M

html5的响应式布局的方法示例详解

《html5的响应式布局的方法示例详解》:本文主要介绍了HTML5中使用媒体查询和Flexbox进行响应式布局的方法,简要介绍了CSSGrid布局的基础知识和如何实现自动换行的网格布局,详细内容请阅读本文,希望能对你有所帮助... 一 使用媒体查询响应式布局        使用的参数@media这是常用的

HTML5表格语法格式详解

《HTML5表格语法格式详解》在HTML语法中,表格主要通过table、tr和td3个标签构成,本文通过实例代码讲解HTML5表格语法格式,感兴趣的朋友一起看看吧... 目录一、表格1.表格语法格式2.表格属性 3.例子二、不规则表格1.跨行2.跨列3.例子一、表格在html语法中,表格主要通过< tab

Vue3组件中getCurrentInstance()获取App实例,但是返回null的解决方案

《Vue3组件中getCurrentInstance()获取App实例,但是返回null的解决方案》:本文主要介绍Vue3组件中getCurrentInstance()获取App实例,但是返回nu... 目录vue3组件中getCurrentInstajavascriptnce()获取App实例,但是返回n

JS+HTML实现在线图片水印添加工具

《JS+HTML实现在线图片水印添加工具》在社交媒体和内容创作日益频繁的今天,如何保护原创内容、展示品牌身份成了一个不得不面对的问题,本文将实现一个完全基于HTML+CSS构建的现代化图片水印在线工具... 目录概述功能亮点使用方法技术解析延伸思考运行效果项目源码下载总结概述在社交媒体和内容创作日益频繁的

前端CSS Grid 布局示例详解

《前端CSSGrid布局示例详解》CSSGrid是一种二维布局系统,可以同时控制行和列,相比Flex(一维布局),更适合用在整体页面布局或复杂模块结构中,:本文主要介绍前端CSSGri... 目录css Grid 布局详解(通俗易懂版)一、概述二、基础概念三、创建 Grid 容器四、定义网格行和列五、设置行

Node.js 数据库 CRUD 项目示例详解(完美解决方案)

《Node.js数据库CRUD项目示例详解(完美解决方案)》:本文主要介绍Node.js数据库CRUD项目示例详解(完美解决方案),本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考... 目录项目结构1. 初始化项目2. 配置数据库连接 (config/db.js)3. 创建模型 (models/

电脑死机无反应怎么强制重启? 一文读懂方法及注意事项

《电脑死机无反应怎么强制重启?一文读懂方法及注意事项》在日常使用电脑的过程中,我们难免会遇到电脑无法正常启动的情况,本文将详细介绍几种常见的电脑强制开机方法,并探讨在强制开机后应注意的事项,以及如何... 在日常生活和工作中,我们经常会遇到电脑突然无反应的情况,这时候强制重启就成了解决问题的“救命稻草”。那

前端下载文件时如何后端返回的文件流一些常见方法

《前端下载文件时如何后端返回的文件流一些常见方法》:本文主要介绍前端下载文件时如何后端返回的文件流一些常见方法,包括使用Blob和URL.createObjectURL创建下载链接,以及处理带有C... 目录1. 使用 Blob 和 URL.createObjectURL 创建下载链接例子:使用 Blob

使用Node.js制作图片上传服务的详细教程

《使用Node.js制作图片上传服务的详细教程》在现代Web应用开发中,图片上传是一项常见且重要的功能,借助Node.js强大的生态系统,我们可以轻松搭建高效的图片上传服务,本文将深入探讨如何使用No... 目录准备工作搭建 Express 服务器配置 multer 进行图片上传处理图片上传请求完整代码示例