经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » JS/JS库/框架 » Vue.js » 查看文章
通过debug搞清楚.vue文件怎么变成.js文件
来源:cnblogs  作者:前端欧阳  时间:2024/3/7 10:14:47  对本文有异议

前言

我们每天写的vue代码都是写在vue文件中,但是浏览器却只认识htmlcssjs等文件类型。所以这个时候就需要一个工具将vue文件转换为浏览器能够认识的js文件,想必你第一时间就想到了webpack或者vite。但是webpackvite本身是没有能力处理vue文件的,其实实际背后生效的是vue-loader@vitejs/plugin-vue。本文以@vitejs/plugin-vue举例,通过debug的方式带你一步一步的搞清楚vue文件是如何编译为js文件的,看不懂你来打我

举个例子

这个是我的源代码App.vue文件:

  1. <template>
  2. <h1 class="msg">{{ msg }}</h1>
  3. </template>
  4. <script setup lang="ts">
  5. import { ref } from "vue";
  6. const msg = ref("hello word");
  7. </script>
  8. <style scoped>
  9. .msg {
  10. color: red;
  11. font-weight: bold;
  12. }
  13. </style>

这个例子很简单,在setup中定义了msg变量,然后在template中将msg渲染出来。

下面这个是我从network中找到的编译后的js文件,已经精简过了:

  1. import {
  2. createElementBlock as _createElementBlock,
  3. defineComponent as _defineComponent,
  4. openBlock as _openBlock,
  5. toDisplayString as _toDisplayString,
  6. ref,
  7. } from "/node_modules/.vite/deps/vue.js?v=23bfe016";
  8. import "/src/App.vue?vue&type=style&index=0&scoped=7a7a37b1&lang.css";
  9. const _sfc_main = _defineComponent({
  10. __name: "App",
  11. setup(__props, { expose: __expose }) {
  12. __expose();
  13. const msg = ref("hello word");
  14. const __returned__ = { msg };
  15. return __returned__;
  16. },
  17. });
  18. const _hoisted_1 = { class: "msg" };
  19. function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
  20. return (
  21. _openBlock(),
  22. _createElementBlock(
  23. "h1",
  24. _hoisted_1,
  25. _toDisplayString($setup.msg),
  26. 1
  27. /* TEXT */
  28. )
  29. );
  30. }
  31. __sfc__.render = render;
  32. export default _sfc_main;

编译后的js代码中我们可以看到主要有三部分,想必你也猜到了这三部分刚好对应vue文件的那三块。

  • _sfc_main对象的setup方法对应vue文件中的<script setup lang="ts">模块。
  • _sfc_render函数对应vue文件中的<template>模块。
  • import "/src/App.vue?vue&type=style&index=0&scoped=7a7a37b1&lang.css";对应vue文件中的<style scoped>模块。

debug搞清楚如何将vue文件编译为js文件

大家应该都知道,前端代码运行环境主要有两个,node端和浏览器端,分别对应我们熟悉的编译时和运行时。浏览器明显是不认识vue文件的,所以vue文件编译成js这一过程肯定不是在运行时的浏览器端。很明显这一过程是在编译时的node端。

要在node端打断点,我们需要启动一个debug 终端。这里以vscode举例,首先我们需要打开终端,然后点击终端中的+号旁边的下拉箭头,在下拉中点击Javascript Debug Terminal就可以启动一个debug终端。
debug-terminal

假如vue文件编译为js文件是一个毛线团,那么他的线头一定是vite.config.ts文件中使用@vitejs/plugin-vue的地方。通过这个线头开始debug我们就能够梳理清楚完整的工作流程。
vite-config

vuePlugin函数

我们给上方图片的vue函数打了一个断点,然后在debug终端上面执行yarn dev,我们看到断点已经停留在了vue函数这里。然后点击step into,断点走到了@vitejs/plugin-vue库中的一个vuePlugin函数中。我们看到vuePlugin函数中的内容代码大概是这样的:

  1. function vuePlugin(rawOptions = {}) {
  2. const options = shallowRef({
  3. compiler: null,
  4. // 省略...
  5. });
  6. return {
  7. name: "vite:vue",
  8. handleHotUpdate(ctx) {
  9. // ...
  10. },
  11. config(config) {
  12. // ..
  13. },
  14. configResolved(config) {
  15. // ..
  16. },
  17. configureServer(server) {
  18. // ..
  19. },
  20. buildStart() {
  21. // ..
  22. },
  23. async resolveId(id) {
  24. // ..
  25. },
  26. load(id, opt) {
  27. // ..
  28. },
  29. transform(code, id, opt) {
  30. // ..
  31. }
  32. };
  33. }

@vitejs/plugin-vue是作为一个plugins插件在vite中使用,vuePlugin函数返回的对象中的buildStarttransform方法就是对应的插件钩子函数。vite会在对应的时候调用这些插件的钩子函数,比如当vite服务器启动时就会调用插件里面的buildStart等函数,当vite解析每个模块时就会调用transform等函数。更多vite钩子相关内容查看官网

我们这里主要看buildStarttransform两个钩子函数,分别是服务器启动时调用和解析每个模块时调用。给这两个钩子函数打上断点。
vue

然后点击Continue(F5),vite服务启动后就会走到buildStart钩子函数中打的断点。我们可以看到buildStart钩子函数的代码是这样的:

  1. buildStart() {
  2. const compiler = options.value.compiler = options.value.compiler || resolveCompiler(options.value.root);
  3. }

将鼠标放到options.value.compiler上面我们看到此时options.value.compiler的值为null,所以代码会走到resolveCompiler函数中,点击Step Into(F11)走到resolveCompiler函数中。看到resolveCompiler函数代码如下:

  1. function resolveCompiler(root) {
  2. const compiler = tryResolveCompiler(root) || tryResolveCompiler();
  3. return compiler;
  4. }
  5. function tryResolveCompiler(root) {
  6. const vueMeta = tryRequire("vue/package.json", root);
  7. if (vueMeta && vueMeta.version.split(".")[0] >= 3) {
  8. return tryRequire("vue/compiler-sfc", root);
  9. }
  10. }

resolveCompiler函数中调用了tryResolveCompiler函数,在tryResolveCompiler函数中判断当前项目是否是vue3.x版本,然后将vue/compiler-sfc包返回。所以经过初始化后options.value.compiler的值就是vue的底层库vue/compiler-sfc,记住这个后面会用

然后点击Continue(F5)放掉断点,在浏览器中打开对应的页面,比如:http://localhost:5173/ 。此时vite将会编译这个页面要用到的所有文件,就会走到transform钩子函数断点中了。由于解析每个文件都会走到transform钩子函数中,但是我们只关注App.vue文件是如何解析的,所以为了方便我们直接在transform函数中添加了下面这段代码,并且删掉了原来在transform钩子函数中打的断点,这样就只有解析到App.vue文件的时候才会走到断点中去。
transform

经过debug我们发现解析App.vue文件时transform函数实际就是执行了transformMain函数,至于transformStyle函数后面讲解析style的时候会讲:

  1. transform(code, id, opt) {
  2. const { filename, query } = parseVueRequest(id);
  3. if (!query.vue) {
  4. return transformMain(
  5. code,
  6. filename,
  7. options.value,
  8. this,
  9. ssr,
  10. customElementFilter.value(filename)
  11. );
  12. } else {
  13. const descriptor = query.src ? getSrcDescriptor(filename, query) || getTempSrcDescriptor(filename, query) : getDescriptor(filename, options.value);
  14. if (query.type === "style") {
  15. return transformStyle(
  16. code,
  17. descriptor,
  18. Number(query.index || 0),
  19. options.value,
  20. this,
  21. filename
  22. );
  23. }
  24. }
  25. }

transformMain函数

继续debug断点走进transformMain函数,发现transformMain函数中代码逻辑很清晰。按照顺序分别是:

  • 根据源代码code字符串调用createDescriptor函数生成一个descriptor对象。
  • 调用genScriptCode函数传入第一步生成的descriptor对象将<script setup>模块编译为浏览器可执行的js代码。
  • 调用genTemplateCode函数传入第一步生成的descriptor对象将<template>模块编译为render函数。
  • 调用genStyleCode函数传入第一步生成的descriptor对象将<style scoped>模块编译为类似这样的import语句,import "/src/App.vue?vue&type=style&index=0&scoped=7a7a37b1&lang.css";

createDescriptor函数

我们先来看看createDescriptor函数,将断点走到createDescriptor(filename, code, options)这一行代码,可以看到传入的filename就是App.vue的文件路径,code就是App.vue中我们写的源代码。
createDescriptor

debug走进createDescriptor函数,看到createDescriptor函数的代码如下:

  1. function createDescriptor(filename, source, { root, isProduction, sourceMap, compiler, template }, hmr = false) {
  2. const { descriptor, errors } = compiler.parse(source, {
  3. filename,
  4. sourceMap,
  5. templateParseOptions: template?.compilerOptions
  6. });
  7. const normalizedPath = slash(path.normalize(path.relative(root, filename)));
  8. descriptor.id = getHash(normalizedPath + (isProduction ? source : ""));
  9. return { descriptor, errors };
  10. }

这个compiler是不是觉得有点熟悉?compiler是调用createDescriptor函数时传入的第三个参数解构而来,而第三个参数就是options。还记得我们之前在vite启动时调用了buildStart钩子函数,然后将vue底层包vue/compiler-sfc赋值给optionscompiler属性。那这里的compiler.parse其实就是调用的vue/compiler-sfc包暴露出来的parse函数,这是一个vue暴露出来的底层的API,这篇文章我们不会对底层API进行源码解析,通过查看parse函数的输入和输出基本就可以搞清楚parse函数的作用。下面这个是parse函数的类型定义:

  1. export function parse(
  2. source: string,
  3. options: SFCParseOptions = {},
  4. ): SFCParseResult {}

从上面我们可以看到parse函数接收两个参数,第一个参数为vue文件的源代码,在我们这里就是App.vue中的code字符串,第二个参数是一些options选项。
我们再来看看parse函数的返回值SFCParseResult,主要有类型为SFCDescriptordescriptor属性需要关注。

  1. export interface SFCParseResult {
  2. descriptor: SFCDescriptor
  3. errors: (CompilerError | SyntaxError)[]
  4. }
  5. export interface SFCDescriptor {
  6. filename: string
  7. source: string
  8. template: SFCTemplateBlock | null
  9. script: SFCScriptBlock | null
  10. scriptSetup: SFCScriptBlock | null
  11. styles: SFCStyleBlock[]
  12. customBlocks: SFCBlock[]
  13. cssVars: string[]
  14. slotted: boolean
  15. shouldForceReload: (prevImports: Record<string, ImportBinding>) => boolean
  16. }

仔细看看SFCDescriptor类型,其中的template属性就是App.vue文件对应的template标签中的内容,里面包含了由App.vue文件中的template模块编译成的AST抽象语法树和原始的template中的代码。
template

我们再来看scriptscriptSetup属性,由于vue文件中可以写多个script标签,scriptSetup对应的就是有setupscript标签,script对应的就是没有setup对应的script标签。我们这个场景中只有scriptSetup属性,里面同样包含了App.vue中的script模块中的内容。
script

我们再来看看styles属性,这里的styles属性是一个数组,是因为我们可以在vue文件中写多个style模块,里面同样包含了App.vue中的style模块中的内容。
style

所以这一步执行createDescriptor函数生成的descriptor对象中主要有三个属性,template属性包含了App.vue文件中的template模块code字符串和AST抽象语法树scriptSetup属性包含了App.vue文件中的<script setup>模块的code字符串,styles属性包含了App.vue文件中<style>模块中的code字符串。createDescriptor函数的执行流程图如下:
progress-createDescriptor

genScriptCode函数

我们再来看genScriptCode函数是如何将<script setup>模块编译成可执行的js代码,同样将断点走到调用genScriptCode函数的地方,genScriptCode函数主要接收我们上一步生成的descriptor对象,调用genScriptCode函数后会将编译后的script模块代码赋值给scriptCode变量。

  1. const { code: scriptCode, map: scriptMap } = await genScriptCode(
  2. descriptor,
  3. options,
  4. pluginContext,
  5. ssr,
  6. customElement
  7. );

将断点走到genScriptCode函数内部,在genScriptCode函数中主要就是这行代码: const script = resolveScript(descriptor, options, ssr, customElement);。将第一步生成的descriptor对象作为参数传给resolveScript函数,返回值就是编译后的js代码,genScriptCode函数的代码简化后如下:

  1. async function genScriptCode(descriptor, options, pluginContext, ssr, customElement) {
  2. let scriptCode = `const ${scriptIdentifier} = {}`;
  3. const script = resolveScript(descriptor, options, ssr, customElement);
  4. if (script) {
  5. scriptCode = script.content;
  6. map = script.map;
  7. }
  8. return {
  9. code: scriptCode,
  10. map
  11. };
  12. }

我们继续将断点走到resolveScript函数内部,发现resolveScript中的代码其实也很简单,简化后的代码如下:

  1. function resolveScript(descriptor, options, ssr, customElement) {
  2. let resolved = null;
  3. resolved = options.compiler.compileScript(descriptor, {
  4. ...options.script,
  5. id: descriptor.id,
  6. isProd: options.isProduction,
  7. inlineTemplate: isUseInlineTemplate(descriptor, !options.devServer),
  8. templateOptions: resolveTemplateCompilerOptions(descriptor, options, ssr),
  9. sourceMap: options.sourceMap,
  10. genDefaultAs: canInlineMain(descriptor, options) ? scriptIdentifier : void 0,
  11. customElement
  12. });
  13. return resolved;
  14. }

这里的options.compiler我们前面第一步的时候已经解释过了,options.compiler对象实际就是vue底层包vue/compiler-sfc暴露的对象,这里的options.compiler.compileScript()其实就是调用的vue/compiler-sfc包暴露出来的compileScript函数,同样也是一个vue暴露出来的底层的API,后面我们的分析defineOptions等文章时会去深入分析compileScript函数,这篇文章我们不会去读compileScript函数的源码。通过查看compileScript函数的输入和输出基本就可以搞清楚compileScript函数的作用。下面这个是compileScript函数的类型定义:

  1. export function compileScript(
  2. sfc: SFCDescriptor,
  3. options: SFCScriptCompileOptions,
  4. ): SFCScriptBlock{}

这个函数的入参是一个SFCDescriptor对象,就是我们第一步调用生成createDescriptor函数生成的descriptor对象,第二个参数是一些options选项。我们再来看返回值SFCScriptBlock类型:

  1. export interface SFCScriptBlock extends SFCBlock {
  2. type: 'script'
  3. setup?: string | boolean
  4. bindings?: BindingMetadata
  5. imports?: Record<string, ImportBinding>
  6. scriptAst?: import('@babel/types').Statement[]
  7. scriptSetupAst?: import('@babel/types').Statement[]
  8. warnings?: string[]
  9. /**
  10. * Fully resolved dependency file paths (unix slashes) with imported types
  11. * used in macros, used for HMR cache busting in @vitejs/plugin-vue and
  12. * vue-loader.
  13. */
  14. deps?: string[]
  15. }
  16. export interface SFCBlock {
  17. type: string
  18. content: string
  19. attrs: Record<string, string | true>
  20. loc: SourceLocation
  21. map?: RawSourceMap
  22. lang?: string
  23. src?: string
  24. }

返回值类型中主要有scriptAstscriptSetupAstcontent这三个属性,scriptAst为编译不带setup属性的script标签生成的AST抽象语法树。scriptSetupAst为编译带setup属性的script标签生成的AST抽象语法树,contentvue文件中的script模块编译后生成的浏览器可执行的js代码。下面这个是执行vue/compiler-sfccompileScript函数返回结果:
resolved

继续将断点走回genScriptCode函数,现在逻辑就很清晰了。这里的script对象就是调用vue/compiler-sfccompileScript函数返回对象,scriptCode就是script对象的content属性 ,也就是将vue文件中的script模块经过编译后生成浏览器可直接执行的js代码code字符串。

  1. async function genScriptCode(descriptor, options, pluginContext, ssr, customElement) {
  2. let scriptCode = `const ${scriptIdentifier} = {}`;
  3. const script = resolveScript(descriptor, options, ssr, customElement);
  4. if (script) {
  5. scriptCode = script.content;
  6. map = script.map;
  7. }
  8. return {
  9. code: scriptCode,
  10. map
  11. };
  12. }

genScriptCode函数的执行流程图如下:
progress-genScriptCode

genTemplateCode函数

我们再来看genTemplateCode函数是如何将template模块编译成render函数的,同样将断点走到调用genTemplateCode函数的地方,genTemplateCode函数主要接收我们上一步生成的descriptor对象,调用genTemplateCode函数后会将编译后的template模块代码赋值给templateCode变量。

  1. ({ code: templateCode, map: templateMap } = await genTemplateCode(
  2. descriptor,
  3. options,
  4. pluginContext,
  5. ssr,
  6. customElement
  7. ))

同样将断点走到genTemplateCode函数内部,在genTemplateCode函数中主要就是返回transformTemplateInMain函数的返回值,genTemplateCode函数的代码简化后如下:

  1. async function genTemplateCode(descriptor, options, pluginContext, ssr, customElement) {
  2. const template = descriptor.template;
  3. return transformTemplateInMain(
  4. template.content,
  5. descriptor,
  6. options,
  7. pluginContext,
  8. ssr,
  9. customElement
  10. );
  11. }

我们继续将断点走进transformTemplateInMain函数,发现这里也主要是调用compile函数,代码如下:

  1. function transformTemplateInMain(code, descriptor, options, pluginContext, ssr, customElement) {
  2. const result = compile(
  3. code,
  4. descriptor,
  5. options,
  6. pluginContext,
  7. ssr,
  8. customElement
  9. );
  10. return {
  11. ...result,
  12. code: result.code.replace(
  13. /\nexport (function|const) (render|ssrRender)/,
  14. "\n$1 _sfc_$2"
  15. )
  16. };
  17. }

同理将断点走进到compile函数内部,我们看到compile函数的代码是下面这样的:

  1. function compile(code, descriptor, options, pluginContext, ssr, customElement) {
  2. const result = options.compiler.compileTemplate({
  3. ...resolveTemplateCompilerOptions(descriptor, options, ssr),
  4. source: code
  5. });
  6. return result;
  7. }

同样这里也用到了options.compiler,调用options.compiler.compileTemplate()其实就是调用的vue/compiler-sfc包暴露出来的compileTemplate函数,这也是一个vue暴露出来的底层的API。不过这里和前面不同的是compileTemplate接收的不是descriptor对象,而是一个SFCTemplateCompileOptions类型的对象,所以这里需要调用resolveTemplateCompilerOptions函数将参数转换成SFCTemplateCompileOptions类型的对象。这篇文章我们不会对底层API进行解析。通过查看compileTemplate函数的输入和输出基本就可以搞清楚compileTemplate函数的作用。下面这个是compileTemplate函数的类型定义:

  1. export function compileTemplate(
  2. options: SFCTemplateCompileOptions,
  3. ): SFCTemplateCompileResults {}

入参options主要就是需要编译的template中的源代码和对应的AST抽象语法树。我们来看看返回值SFCTemplateCompileResults,这里面的code就是编译后的render函数字符串。

  1. export interface SFCTemplateCompileResults {
  2. code: string
  3. ast?: RootNode
  4. preamble?: string
  5. source: string
  6. tips: string[]
  7. errors: (string | CompilerError)[]
  8. map?: RawSourceMap
  9. }

render

genTemplateCode函数的执行流程图如下:
progress-genTemplateCode

genStyleCode函数

我们再来看最后一个genStyleCode函数,同样将断点走到调用genStyleCode的地方。一样的接收descriptor对象。代码如下:

  1. const stylesCode = await genStyleCode(
  2. descriptor,
  3. pluginContext,
  4. customElement,
  5. attachedProps
  6. );

我们将断点走进genStyleCode函数内部,发现和前面genScriptCodegenTemplateCode函数有点不一样,下面这个是我简化后的genStyleCode函数代码:

  1. async function genStyleCode(descriptor, pluginContext, customElement, attachedProps) {
  2. let stylesCode = ``;
  3. if (descriptor.styles.length) {
  4. for (let i = 0; i < descriptor.styles.length; i++) {
  5. const style = descriptor.styles[i];
  6. const src = style.src || descriptor.filename;
  7. const attrsQuery = attrsToQuery(style.attrs, "css");
  8. const srcQuery = style.src ? style.scoped ? `&src=${descriptor.id}` : "&src=true" : "";
  9. const directQuery = customElement ? `&inline` : ``;
  10. const scopedQuery = style.scoped ? `&scoped=${descriptor.id}` : ``;
  11. const query = `?vue&type=style&index=${i}${srcQuery}${directQuery}${scopedQuery}`;
  12. const styleRequest = src + query + attrsQuery;
  13. stylesCode += `
  14. import ${JSON.stringify(styleRequest)}`;
  15. }
  16. }
  17. return stylesCode;
  18. }

我们前面讲过因为vue文件中可能会有多个style标签,所以descriptor对象的styles属性是一个数组。遍历descriptor.styles数组,我们发现for循环内全部都是一堆赋值操作,没有调用vue/compiler-sfc包暴露出来的任何API。将断点走到 return stylesCode;,看看stylesCode到底是什么东西?
styleCode

通过打印我们发现stylesCode竟然变成了一条import语句,并且import的还是当前App.vue文件,只是多了几个query分别是:vuetypeindexscopedlang。再来回忆一下前面讲的@vitejs/plugin-vuetransform钩子函数,当vite解析每个模块时就会调用transform等函数。所以当代码运行到这行import语句的时候会再次走到transform钩子函数中。我们再来看看transform钩子函数的代码:

  1. transform(code, id, opt) {
  2. const { filename, query } = parseVueRequest(id);
  3. if (!query.vue) {
  4. // 省略
  5. } else {
  6. const descriptor = query.src ? getSrcDescriptor(filename, query) || getTempSrcDescriptor(filename, query) : getDescriptor(filename, options.value);
  7. if (query.type === "style") {
  8. return transformStyle(
  9. code,
  10. descriptor,
  11. Number(query.index || 0),
  12. options.value,
  13. this,
  14. filename
  15. );
  16. }
  17. }
  18. }

query中有vue字段,并且querytype字段值为style时就会执行transformStyle函数,我们给transformStyle函数打个断点。当执行上面那条import语句时就会走到断点中,我们进到transformStyle中看看。

  1. async function transformStyle(code, descriptor, index, options, pluginContext, filename) {
  2. const block = descriptor.styles[index];
  3. const result = await options.compiler.compileStyleAsync({
  4. ...options.style,
  5. filename: descriptor.filename,
  6. id: `data-v-${descriptor.id}`,
  7. isProd: options.isProduction,
  8. source: code,
  9. scoped: block.scoped,
  10. ...options.cssDevSourcemap ? {
  11. postcssOptions: {
  12. map: {
  13. from: filename,
  14. inline: false,
  15. annotation: false
  16. }
  17. }
  18. } : {}
  19. });
  20. return {
  21. code: result.code,
  22. map
  23. };
  24. }

transformStyle函数的实现我们看着就很熟悉了,和前面处理templatescript一样都是调用的vue/compiler-sfc包暴露出来的compileStyleAsync函数,这也是一个vue暴露出来的底层的API。同样我们不会对底层API进行解析。通过查看compileStyleAsync函数的输入和输出基本就可以搞清楚compileStyleAsync函数的作用。

  1. export function compileStyleAsync(
  2. options: SFCAsyncStyleCompileOptions,
  3. ): Promise<SFCStyleCompileResults> {}

我们先来看看SFCAsyncStyleCompileOptions入参:

  1. interface SFCAsyncStyleCompileOptions extends SFCStyleCompileOptions {
  2. isAsync?: boolean
  3. modules?: boolean
  4. modulesOptions?: CSSModulesOptions
  5. }
  6. interface SFCStyleCompileOptions {
  7. source: string
  8. filename: string
  9. id: string
  10. scoped?: boolean
  11. trim?: boolean
  12. isProd?: boolean
  13. inMap?: RawSourceMap
  14. preprocessLang?: PreprocessLang
  15. preprocessOptions?: any
  16. preprocessCustomRequire?: (id: string) => any
  17. postcssOptions?: any
  18. postcssPlugins?: any[]
  19. map?: RawSourceMap
  20. }

入参主要关注几个字段,source字段为style标签中的css原始代码。scoped字段为style标签中是否有scoped attribute。id字段为我们在观察 DOM 结构时看到的 data-v-xxxxx。这个是debug时入参截图:
transformStyle-arg

再来看看返回值SFCStyleCompileResults对象,主要就是code属性,这个是经过编译后的css字符串,已经加上了data-v-xxxxx

  1. interface SFCStyleCompileResults {
  2. code: string
  3. map: RawSourceMap | undefined
  4. rawResult: Result | LazyResult | undefined
  5. errors: Error[]
  6. modules?: Record<string, string>
  7. dependencies: Set<string>
  8. }

这个是debugcompileStyleAsync函数返回值的截图:
transformStyle-res

genStyleCode函数的执行流程图如下:
progress-genStyleCode

transformMain函数简化后的代码

现在我们可以来看transformMain函数简化后的代码:

  1. async function transformMain(code, filename, options, pluginContext, ssr, customElement) {
  2. const { descriptor, errors } = createDescriptor(filename, code, options);
  3. const { code: scriptCode, map: scriptMap } = await genScriptCode(
  4. descriptor,
  5. options,
  6. pluginContext,
  7. ssr,
  8. customElement
  9. );
  10. let templateCode = "";
  11. ({ code: templateCode, map: templateMap } = await genTemplateCode(
  12. descriptor,
  13. options,
  14. pluginContext,
  15. ssr,
  16. customElement
  17. ));
  18. const stylesCode = await genStyleCode(
  19. descriptor,
  20. pluginContext,
  21. customElement,
  22. attachedProps
  23. );
  24. const output = [
  25. scriptCode,
  26. templateCode,
  27. stylesCode
  28. ];
  29. let resolvedCode = output.join("\n");
  30. return {
  31. code: resolvedCode,
  32. map: resolvedMap || {
  33. mappings: ""
  34. },
  35. meta: {
  36. vite: {
  37. lang: descriptor.script?.lang || descriptor.scriptSetup?.lang || "js"
  38. }
  39. }
  40. };
  41. }

transformMain函数中的代码执行主流程,其实就是对应了一个vue文件编译成js文件的流程。

首先调用createDescriptor函数将一个vue文件解析为一个descriptor对象。

然后以descriptor对象为参数调用genScriptCode函数,将vue文件中的<script>模块代码编译成浏览器可执行的js代码code字符串,赋值给scriptCode变量。

接着以descriptor对象为参数调用genTemplateCode函数,将vue文件中的<template>模块代码编译成render函数code字符串,赋值给templateCode变量。

然后以descriptor对象为参数调用genStyleCode函数,将vue文件中的<style>模块代码编译成了import语句code字符串,比如:import "/src/App.vue?vue&type=style&index=0&scoped=7a7a37b1&lang.css";,赋值给stylesCode变量。

然后将scriptCodetemplateCodestylesCode使用换行符\n拼接起来得到resolvedCode,这个resolvedCode就是一个vue文件编译成js文件的代码code字符串。这个是debugresolvedCode变量值的截图:
resolvedCode

总结

这篇文章通过debug的方式一步一步的带你了解vue文件编译成js文件的完整流程,下面是一个完整的流程图。如果文字太小看不清,可以将图片保存下来或者放大看:
progress-full

@vitejs/plugin-vue-jsx库中有个叫transform的钩子函数,每当vite加载模块的时候就会触发这个钩子函数。所以当import一个vue文件的时候,就会走到@vitejs/plugin-vue-jsx中的transform钩子函数中,在transform钩子函数中主要调用了transformMain函数。

第一次解析这个vue文件时,在transform钩子函数中主要调用了transformMain函数。在transformMain函数中主要调用了4个函数,分别是:createDescriptorgenScriptCodegenTemplateCodegenStyleCode

createDescriptor接收的参数为当前vue文件代码code字符串,返回值为一个descriptor对象。对象中主要有四个属性templatescriptSetupscriptstyles

  • descriptor.template.ast就是由vue文件中的template模块生成的AST抽象语法树
  • descriptor.template.content就是vue文件中的template模块的代码字符串。
  • scriptSetupscript的区别是分别对应的是vue文件中有setup属性的<script>模块和无setup属性的<script>模块。descriptor.scriptSetup.content就是vue文件中的<script setup>模块的代码字符串。

genScriptCode函数为底层调用vue/compiler-sfccompileScript函数,根据第一步的descriptor对象将vue文件的<script setup>模块转换为浏览器可直接执行的js代码。

genTemplateCode函数为底层调用vue/compiler-sfccompileTemplate函数,根据第一步的descriptor对象将vue文件的<template>模块转换为render函数。

genStyleCode函数为将vue文件的style模块转换为import "/src/App.vue?vue&type=style&index=0&scoped=7a7a37b1&lang.css";样子的import语句。

然后使用换行符\ngenScriptCode函数、genTemplateCode函数、genStyleCode函数的返回值拼接起来赋值给变量resolvedCode,这个resolvedCode就是vue文件编译成js文件的code字符串。

当浏览器执行到import "/src/App.vue?vue&type=style&index=0&scoped=7a7a37b1&lang.css";语句时,触发了加载模块操作,再次触发了@vitejs/plugin-vue-jsx中的transform钩子函数。此时由于有了type=stylequery,所以在transform函数中会执行transformStyle函数,在transformStyle函数中同样也是调用vue/compiler-sfccompileStyleAsync函数,根据第一步的descriptor对象将vue文件的<style>模块转换为编译后的css代码code字符串,至此编译style部分也讲完了。

关注公众号:前端欧阳,解锁我更多vue干货文章,并且可以免费向我咨询vue相关问题。
qrcode

原文链接:https://www.cnblogs.com/heavenYJJ/p/18058142

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号