.vue 怎么变成 .js，我们来试一试！看完会更懂 Vue 吗？

2023-11-22 22:20
文章标签 javascript 怎么 vue js frontend 变成 试一试 完会

本文主要是介绍.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属性的 scriptSetup，script 和 scriptSetup 的 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。

相关文章

Vue中组件之间传值的六种方式（完整版）

Vue中组件之间传值的六种方式（完整版）

《Vue中组件之间传值的六种方式（完整版）》组件是vue.js最强大的功能之一,而组件实例的作用域是相互独立的,这就意味着不同组件之间的数据无法相互引用,针对不同的使用场景,如何选择行之有效的通信方式... 目录前言方法一、props/$emit1.父组件向子组件传值2.子组件向父组件传值（通过事件形式）方
阅读更多...
css中的 vertical-align与line-height作用详解

css中的 vertical-align与line-height作用详解

《css中的vertical-align与line-height作用详解》：本文主要介绍了CSS中的`vertical-align`和`line-height`属性，包括它们的作用、适用元素、属性值、常见使用场景、常见问题及解决方案，详细内容请阅读本文，希望能对你有所帮助... 目录vertical-ali
阅读更多...
浅析CSS 中z - index属性的作用及在什么情况下会失效

浅析CSS 中z - index属性的作用及在什么情况下会失效

《浅析CSS中z-index属性的作用及在什么情况下会失效》z-index属性用于控制元素的堆叠顺序,值越大,元素越显示在上层,它需要元素具有定位属性（如relative、absolute、fi... 目录1. z-index 属性的作用2. z-index 失效的情况2.1 元素没有定位属性2.2 元素处
阅读更多...
Python实现html转png的完美方案介绍

Python实现html转png的完美方案介绍

《Python实现html转png的完美方案介绍》这篇文章主要为大家详细介绍了如何使用Python实现html转png功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 1.增强稳定性与错误处理建议使用三层异常捕获结构：try: with sync_playwright(
阅读更多...
Vue 调用摄像头扫描条码功能实现代码

Vue 调用摄像头扫描条码功能实现代码

《Vue调用摄像头扫描条码功能实现代码》本文介绍了如何使用Vue.js和jsQR库来实现调用摄像头并扫描条码的功能,通过安装依赖、获取摄像头视频流、解析条码等步骤,实现了从开始扫描到停止扫描的完整流... 目录实现步骤：代码实现1. 安装依赖2. vue 页面代码功能说明注意事项以下是一个基于 Vue.js
阅读更多...
CSS @media print 使用详解

CSS @media print 使用详解

《CSS@mediaprint使用详解》：本文主要介绍了CSS中的打印媒体查询@mediaprint包括基本语法、常见使用场景和代码示例，如隐藏非必要元素、调整字体和颜色、处理链接的URL显示、分页控制、调整边距和背景等，还提供了测试方法和关键注意事项，并分享了进阶技巧，详细内容请阅读本文，希望能对你有所帮助...
阅读更多...
电脑开机提示krpt.dll丢失怎么解决? krpt.dll文件缺失的多种解决办法

电脑开机提示krpt.dll丢失怎么解决? krpt.dll文件缺失的多种解决办法

《电脑开机提示krpt.dll丢失怎么解决?krpt.dll文件缺失的多种解决办法》krpt.dll是Windows操作系统中的一个动态链接库文件，它对于系统的正常运行起着重要的作用，本文将详细介绍... 在使用 Windows 操作系统的过程中，用户有时会遇到各种错误提示，其中“找不到 krpt.dll”
阅读更多...
Nginx实现前端灰度发布

Nginx实现前端灰度发布

《Nginx实现前端灰度发布》灰度发布是一种重要的策略,它允许我们在不影响所有用户的情况下,逐步推出新功能或更新,通过灰度发布,我们可以测试新版本的稳定性和性能,下面就来介绍一下前端灰度发布的使用,感... 目录前言一、基于权重的流量分配二、基于 Cookie 的分流三、基于请求头的分流四、基于请求参数的分
阅读更多...
基于Canvas的Html5多时区动态时钟实战代码

基于Canvas的Html5多时区动态时钟实战代码

《基于Canvas的Html5多时区动态时钟实战代码》：本文主要介绍了如何使用Canvas在HTML5上实现一个多时区动态时钟的web展示，通过Canvas的API，可以绘制出6个不同城市的时钟，并且这些时钟可以动态转动，每个时钟上都会标注出对应的24小时制时间，详细内容请阅读本文，希望能对你有所帮助...
阅读更多...
HTML5 data-*自定义数据属性的示例代码

HTML5 data-*自定义数据属性的示例代码

《HTML5data-*自定义数据属性的示例代码》HTML5的自定义数据属性（data-*）提供了一种标准化的方法在HTML元素上存储额外信息,可以通过JavaScript访问、修改和在CSS中使用... 目录引言基本概念使用自定义数据属性1. 在 html 中定义2. 通过 JavaScript 访问3.
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2