Vite: 插件流水线之核心编译能力

news2024/11/20 1:27:40

概述

  • Vite 在开发阶段实现了一个按需加载的服务器,每一个文件请求进来都会经历一系列的编译流程,然后 Vite 会将编译结果响应给浏览器。在生产环境下,Vite 同样会执行一系列编译过程,将编译结果交给 Rollup 进行模块打包
  • 这一系列的编译过程指的就是 Vite 的插件工作流水线(Pipeline),而插件功能又是 Vite 构建能力的核心,因此谈到阅读 Vite 源码,我们永远绕不开插件的作用与实现原理。接下来,我就和你一起分析 Vite 插件流水线的顶层架构,也就是各个插件如何被调度和组织起来的,详细说说 Vite 插件容器( PluginContainer )机制的实现,同时带你一起梳理开发阶段和生产环境各自会用到的插件,并分析各自的功能与实现原理,让你能够全
    面、准确地认识 Vite 的插件流水线!

插件容器

  • Vite 的插件机制是与 Rollup 兼容的,但它在开发和生产环境下的实现稍有差别,你可以回顾一下这张架构图:

  • 我们可以看到:
    • 在生产环境中 Vite 直接调用 Rollup 进行打包,所以 Rollup 可以调度各种插件;
    • 在开发环境中,Vite 模拟了 Rollup 的插件机制,设计了一个 PluginContainer 对象来调度各个插件。

PluginContainer (插件容器)对象非常重要,前两节我们也多次提到了它,接下来我们就把目光集中到这个对象身上,看看 Vite 的插件容器机制究竟是如何实现的。

PluginContainer 的 实现 基于借鉴于 WMR 中的 rollup-plugin-container.js ,主要分为 2 个部分:
* 实现 Rollup 插件钩子的调度
* 实现插件钩子内部的 Context 上下文对象

可以通过 container 的定义 来看看各个 Rollup 钩子的实现方式,代码精简后如下:

const container = {
  // 异步串行钩子
  options: await (async () => {
    let options = rollupOptions
    for (const plugin of plugins) {
      if (!plugin.options) continue
      options =
        (await plugin.options.call(minimalContext, options)) || options
    }
    return options;
  })(),
  // 异步并行钩子
  async buildStart() {
    await Promise.all(
      plugins.map((plugin) => {
        if (plugin.buildStart) {
          return plugin.buildStart.call(
            new Context(plugin) as any,
            container.options as NormalizedInputOptions
          )
        }
      })
    )
  },
  // 异步优先钩子
  async resolveId(rawId, importer) {
    // 上下文对象,后文介绍
    const ctx = new Context()

    let id: string | null = null
    const partial: Partial < PartialResolvedId > = {}
    for (const plugin of plugins) {
      const result = await plugin.resolveId.call(
        ctx as any,
        rawId,
        importer, {
          ssr
        }
      )
      if (!result) continue;
      return result;
    }
  }
  // 异步优先钩子
  async load(id, options) {
    const ctx = new Context()
    for (const plugin of plugins) {
      const result = await plugin.load.call(ctx as any, id, {
        ssr
      })
      if (result != null) {
        return result
      }
    }
    return null
  },
  // 异步串行钩子
  async transform(code, id, options) {
    const ssr = options ? .ssr
    // 每次 transform 调度过程会有专门的上下文对象,用于合并 SourceMap,后文会介绍
    const ctx = new TransformContext(id, code, inMap as SourceMap)
    ctx.ssr = !!ssr
    for (const plugin of plugins) {
      let result: TransformResult | string | undefined
      try {
        result = await plugin.transform.call(ctx as any, code, id, {
          ssr
        })
      } catch (e) {
        ctx.error(e)
      }
      if (!result) continue;
      // 省略 SourceMap 合并的逻辑
      code = result;
    }
    return {
      code,
      map: ctx._getCombinedSourcemap()
    }
  },
  // close 钩子实现省略
}

我们已经系统学习过 Rollup 中异步、串行、并行等钩子类型的执行原理了,现在再来阅读这部
分 PluginContainer 的实现代码应该并不困难。不过值得注意的是,在各种钩子被调用的时候,Vite 会强制将钩子函数的 this 绑定为一个上下文对象,如

const ctx = new Context()
const result = await plugin.load.call(ctx as any, id, { ssr })

这个对象究竟是用来干什么的呢? 我们知道,在 Rollup 钩子函数中,我们可以调用 this.emitFile 、 this.resolve 等诸多的上下文方法

因此,Vite 除了要模拟各个插件的执行流程,还需要模拟插件执行的上下文对象,代码中的 Context 对象就是用来完成这件事情的。我们来看看 Context 对象的具体实现:

import {
  RollupPluginContext
} from 'rollup';
type PluginContext = Omit <
  RollupPluginContext,
  // not documented
  |
  'cache'
  // deprecated
  |
  'emitAsset' |
  'emitChunk' |
  'getAssetFileName' |
  'getChunkFileName' |
  'isExternal' |
  'moduleIds' |
  'resolveId' |
  'load' >
  
const watchFiles = new Set < string > ()

class Context implements PluginContext {
  // 实现各种上下文方法
  // 解析模块 AST(调用 acorn)
  parse(code: string, opts: any = {}) {
    return parser.parse(code, {
      sourceType: 'module',
      ecmaVersion: 'latest',
      locations: true,
      ...opts
    })
  }
  // 解析模块路径
  async resolve(
    id: string,
    importer ? : string,
    options ? : {
      skipSelf ? : boolean
    }
  ) {
    let skip: Set < Plugin > | undefined
    if (options ? .skipSelf && this._activePlugin) {

      skip = new Set(this._resolveSkips)
      skip.add(this._activePlugin)
    }
    let out = await container.resolveId(id, importer, {
      skip,
      ssr: this.ssr
    })
    if (typeof out === 'string') out = {
      id: out
    }
    return out as ResolvedId | null
  }
  // 以下两个方法均从 Vite 的模块依赖图中获取相关的信息
  // 我们将在下一节详细介绍模块依赖图,本节不做展开
  getModuleInfo(id: string) {
    return getModuleInfo(id)
  }
  getModuleIds() {
    return moduleGraph ?
      moduleGraph.idToModuleMap.keys() :
      Array.prototype[Symbol.iterator]()
  }

  // 记录开发阶段 watch 的文件
  addWatchFile(id: string) {
    watchFiles.add(id);
    (this._addedImports || (this._addedImports = new Set()))
    .add(id)
    if (watcher) ensureWatchedFile(watcher, id, root)
  }
  getWatchFiles() {
    return [...watchFiles]
  }

  warn() {
    // 打印 warning 信息
  }

  error() {
    // 打印 error 信息
  }

  // 其它方法只是声明,并没有具体实现,这里就省略了
}

很显然,Vite 将 Rollup 的 PluginContext 对象重新实现了一遍,因为只是开发阶段用到,所以去除了一些打包相关的方法实现。同时,上下文对象与 Vite 开发阶段的ModuleGraph 即模块依赖图相结合,是为了实现开发时的 HMR。 HMR 实现的细节,我们将在下一节展开介绍。另外,transform 钩子也会绑定一个插件上下文对象,不过这个对象和其它钩子不同,实现代码精简如下:

class TransformContext extends Context {
  constructor(filename: string, code: string, inMap ? : SourceMap | string) {

    super()
    this.filename = filename
    this.originalCode = code
    if (inMap) {
      this.sourcemapChain.push(inMap)
    }
  }
  _getCombinedSourcemap(createIfNull = false) {
    return this.combinedMap
  }
  getCombinedSourcemap() {
    return this._getCombinedSourcemap(true) as SourceMap
  }
}

可以看到, TransformContext 继承自之前所说的 Context 对象,也就是说 transform 钩子的上下文对象相比其它钩子只是做了一些扩展,增加了 sourcemap 合并的功能,将不同插件的 transform 钩子执行后返回的 sourcemap 进行合并,以保证sourcemap 的准确性和完整性。

插件工作流概览

  • 在分析配置解析服务的小节中,我们提到过生成插件流水线即 resolvePlugins 的逻辑,
    但没有具体展开,这里我们就来详细拆解一下 Vite 在这一步究竟做了啥。

让我们把目光集中在 resolvePlugins 的实现上,Vite 所有的插件就是在这里被收集起来
的。具体实现如下

export async function resolvePlugins(
  config: ResolvedConfig,
  prePlugins: Plugin[],
  normalPlugins: Plugin[],
  postPlugins: Plugin[]
): Promise < Plugin[] > {
  const isBuild = config.command === 'build'
  // 收集生产环境构建的插件,后文会介绍
  const buildPlugins = isBuild ?
    (await import('../build'))
    .resolveBuildPlugins(config) :
    {
      pre: [],
      post: []
    }
  return [
    // 1. 别名插件
    isBuild ? null : preAliasPlugin(),
    aliasPlugin({
      entries: config.resolve.alias
    }),
    // 2. 用户自定义 pre 插件(带有`enforce: "pre"`属性)
    ...prePlugins,

    // 3. Vite 核心构建插件
    // 数量比较多,暂时省略代码
    // 4. 用户插件(不带有 `enforce` 属性)
    ...normalPlugins,
    // 5. Vite 生产环境插件 & 用户插件(带有 `enforce: "post"`属性)
    definePlugin(config),
    cssPostPlugin(config),
    ...buildPlugins.pre,
    ...postPlugins,
    ...buildPlugins.post,
    // 6. 一些开发阶段特有的插件
    ...(isBuild ?
      [] :
      [clientInjectionsPlugin(config), importAnalysisPlugin(config)])
  ].filter(Boolean) as Plugin[]
}
  • 从上述代码中我们可以总结出 Vite 插件的具体执行顺序。

    • 别名插件包括 vite:pre-alias 和 @rollup/plugin-alias ,用于路径别名替换。
    • 用户自定义 pre 插件,也就是带有 enforce: “pre” 属性的自定义插件。
    • Vite 核心构建插件,这部分插件为 Vite 的核心编译插件,数量比较多,我们在下部分一一拆解。
    • 用户自定义的普通插件,即不带有 enforce 属性的自定义插件。
    • Vite 生产环境插件 和用户插件中带有 enforce: “post” 属性的插件。
    • 一些开发阶段特有的插件,包括环境变量注入插件 clientInjectionsPlugin 和 import 语句分析及重写插件 importAnalysisPlugin
  • 在执行过程中 Vite 到底应用了哪些插件,以及这些插件内部究竟做了什么?我们来一一梳理一下。

插件功能梳理

除用户自定义插件之外,我们需要梳理的 Vite 内置插件有下面这几类:

  • 别名插件
  • 核心构建插件
  • 生产环境特有插件
  • 开发环境特有插件

1 )别名插件

  • 别名插件有两个,分别是 vite:pre-alias 和 @rollup/plugin-alias。 前者主要是为了将 bare import 路径重定向到预构建依赖的路径,如:
    // 假设 React 已经过 Vite 预构建
    import React from 'react';
    // 会被重定向到预构建产物的路径
    import React from '/node_modules/.vite/react.js'
    

后者则是实现了比较通用的路径别名(即 resolve.alias 配置)的功能,使用的是 Rollup
官方 Alias 插件

2 ) 核心构建插件

2.1 module preload 特性的 Polyfill

当你在 Vite 配置文件中开启下面这个配置时:

{
 build: {
 	polyfillModulePreload: true
 }
}
  • Vite 会自动应用 modulePreloadPolyfillPlugin 插件,在产物中注入 module preload 的 Polyfill 代码,具体实现 摘自之前我们提到过的 es-module-shims 这个库,实现原理如下:
    • 扫描出当前所有的 modulepreload 标签,拿到 link 标签对应的地址,通过执行
      fetch 实现预加载;
    • 同时通过 MutationObserver 监听 DOM 的变化,一旦发现包含 modulepreload
      属性的 link 标签,则同样通过 fetch 请求实现预加载。

由于部分支持原生 ESM 的浏览器并不支持 module preload,因此某些情况下
需要注入相应的 polyfill 进行降级。

2.2 ) 路径解析插件

路径解析插件(即 vite:resolve )是 Vite 中比较核心的插件,几乎所有重要的 Vite 特性
都离不开这个插件的实现,诸如依赖预构建、HMR、SSR 等等。同时它也是实现相当复
杂的插件,一方面实现了 Node.js 官方的 resolve 算法,另一方面需要支持前面所说的
各项特性,可以说是专门给 Vite 实现了一套路径解析算法。

这个插件的实现细节足以再开一个小节专门分析了,所以本节我们就不展开了,你初步了解就可以了。

2.3 ) 内联脚本加载插件

对于 HTML 中的内联脚本,Vite 会通过 vite:html-inline-script-proxy 插件来进行加载。比如下面这个 script 标签:

<script type="module">
import React from 'react';
console.log(React)
</script>

这些内容会在后续的 build-html 插件从 HTML 代码中剔除,并且变成下面的这一行代码插入到项目入口模块的代码中: import '/User/xxx/vite-app/index.html?http-proxy&index=0.js'

而 vite:html-inline-script-proxy 就是用来加载这样的模块,实现如下:

const htmlProxyRE = /\?html-proxy&index=(\d+)\.js$/
export function htmlInlineScriptProxyPlugin(config: ResolvedConfig): Plugin {
  return {
    name: 'vite:html-inline-script-proxy',
    load(id) {
      const proxyMatch = id.match(htmlProxyRE)
      if (proxyMatch) {
        const index = Number(proxyMatch[1])
        const file = cleanUrl(id)
        const url = file.replace(normalizePath(config.root), '')
        // 内联脚本的内容会被记录在 htmlProxyMap 这个表中
        const result = htmlProxyMap.get(config) !.get(url) ![index]
        if (typeof result === 'string') {
          // 加载脚本的具体内容
          return result
        } else {
          throw new Error(`No matching HTML proxy module found from ${id}`)
        }
      }
    }
  }
}

2.4 ) CSS 编译插件

  • 即名为 vite:css 的插件,主要实现下面这些功能:

    • CSS 预处理器的编译
    • CSS Modules
    • Postcss 编译
    • 通过 @import 记录依赖 ,便于 HMR
  • 这个插件的核心在于 compileCSS 函数的实现,感兴趣, 可以阅读一下这部分的源码

2.5 ) Esbuild 转译插件

即名为 vite:esbuild 的插件,用来进行 .js 、 .ts 、 .jsx 和 tsx ,代替了传统的 Babel 或者 TSC 的功能,这也是 Vite 开发阶段性能强悍的一个原因。插件中主要的逻辑是 transformWithEsbuild 函数,顾名思义,你可以通过这个函数进行代码转译。当然,Vite 本身也导出了这个函数,作为一种通用的 transform 能力,你可以这样来使用

import { transformWithEsbuild } from 'vite';
// 传入两个参数: code, filename
transformWithEsbuild('<h1>hello</h1>', './index.tsx').then(res => {
 // {
 // warnings: [],
 // code: '/* @__PURE__ */ React.createElement("h1", null, "hello");\n',
 // map: {/* sourcemap 信息 */}
 // }
 console.log(res);
})

2.6 ) 静态资源加载插件

  • 静态资源加载插件包括如下几个:
    • vite:json 用来加载 JSON 文件,通过 @rollup/pluginutils 的 dataToEsm 方法可实
      现 JSON 的按名导入,具体实现见链接;
    • vite:wasm 用来加载 .wasm 格式的文件,具体实现见链接;
    • vite:worker 用来 Web Worker 脚本,插件内部会使用 Rollup 对 Worker 脚本进
      行打包,具体实现见链接;
    • vite:asset,开发阶段实现了其他格式静态资源的加载,而生产环境会通过 renderChunk 钩子将静态资源地址重写为产物的文件地址,如 ./img.png 重写为 https://cdn.xxx.com/assets/img.91ee297e.png

值得注意的是,Rollup 本身存在 asset cascade 问题,即静态资源哈希更新,引用它的
JS 的哈希并没有更新(issue 链接)。因此 Vite 在静态资源处理的时候,并没有交给
Rollup 生成资源哈希,而是自己根据资源内容生成哈希(源码实现),并手动进行路径重
写,以此避免 asset-cascade 问题。

3 ) 生产环境特有插件

3.1 )全局变量替换插件

提供全局变量替换功能,如下面的这个配置:

// vite.config.ts
const version = '2.0.0';
export default {
 define: {
 __APP_VERSION__: `JSON.stringify(${version})`
 }
}

全局变量替换的功能和我们之前在 Rollup 插件小节中提到的@rollup/pluginreplace 差不多,当然在实现上 Vite 会有所区别:

  • 开发环境下,Vite 会通过将所有的全局变量挂载到 window 对象,而不用经过
    define 插件的处理,节省编译开销;

  • 生产环境下,Vite 会使用 define 插件,进行字符串替换以及 sourcemap 生成。

  • 特殊情况: SSR 构建会在开发环境经过这个插件,仅替换字符串。

3.2 ) CSS 后处理插件

CSS 后处理插件即 name 为 vite:css-post 的插件,它的功能包括 开发阶段 CSS 响应结果处理 和 生产环境 CSS 文件生成

首先,在开发阶段,这个插件会将之前的 CSS 编译插件处理后的结果,包装成一个ESM 模块,返回给浏览器,点击查看实现代码

其次,生产环境中,Vite 默认会通过这个插件进行 CSS 的 code splitting,即对于每个异步 chunk,Vite 会将其依赖的 CSS 代码单独打包成一个文件,关键代码如下(源码链接):

const fileHandle = this.emitFile({
 name: chunk.name + '.css',
 type: 'asset',
 source: chunkCSS
});

如果 CSS 的 code splitting 功能被关闭(通过 build.cssCodeSplit 配置),那么 Vite 会将所有的 CSS 代码打包到同一个 CSS 文件中,点击查看实现

最后,插件会调用 Esbuild 对 CSS 进行压缩,实现在 minifyCSS 函数中,点击查看实现

3.3 ) HTML 构建插件

HTML 构建插件 即 build-html 插件。之前我们在 内联脚本加载插件 中提到过,项目根目录下的 html 会转换为一段 JavaScript 代码,如下面的这个例子:

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8">
 <meta http-equiv="X-UA-Compatible" content="IE=edge">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>Document</title>
</head>
<body>
 // 普通方式引入
 <script src="./index.ts"></script>
 // 内联脚本
 <script type="module">
	 import React from 'react';
	 console.log(React)
 </script>
</body>
</html>

首先,当 Vite 在生产环境 transform 这段入口 HTML 时,会做 3 件事情: 对 HTML 执行各个插件中带有 enforce: “pre” 属性的 transformIndexHtml 钩子;我们知道插件本身可以带有 enforce: “pre”|“post” 属性,而
transformIndexHtml 本身也可以带有这个属性,用于在不同的阶段进行 HTML转换。后面会讨论 transformIndexHtml 钩子带有 enforce: “post” 时的执行时机。

将其中的 script 标签内容删除,并将其转换为 import 语句 如 import ‘./index.ts’ ,并记录下来;
在 transform 钩子中返回记录下来的 import 内容,将 import 语句作为模块内容
进行加载。也就是说,虽然 Vite 处理的是一个 HTML 文件,但最后进行打包的内
容却是一段 JS 的内容,点击查看具体实现。代码简化后如下所示:

export function buildHtmlPlugin() {
  name: 'vite:build',
  transform(html, id) {
    if (id.endsWith('.html')) {
      let js = '';
      // 省略 HTML AST 遍历过程(通过 @vue/compiler-dom 实现)
      // 收集 script 标签,转换成 import 语句,拼接到 js 字符串中
      return js;
    }
  }
}

其次,在生成产物的最后一步即 generateBundle 钩子中,拿到入口 Chunk,分析入口
Chunk 的内容, 分情况进行处理。如果只有 import 语句,先通过 Rollup 提供的 chunk 和 bundle 对象获取入口 chunk所有的依赖 chunk,并将这些 chunk 进行后序排列,如 a 依赖 b,b 依赖 c ,最后的依赖数组就是 [c, b, a] 。然后依次将 c,b, a 生成三个 script 标签,插入 HTML 中。最后,Vite 会将入口 chunk 的内容从 bundle 产物中移除,因此它的内容只要 import 语句,而它 import 的 chunk 已经作为 script 标签插入到了 HTML 中,那入口 Chunk的存在也就没有意义了。如果除了 import 语句,还有其它内容, Vite 就会将入口 Chunk 单独生成一个 script 标签 ,分析出依赖的后序排列(和上一种情况分析手段一样),然后通过注入 标签 对入口文件的依赖 chunk 进行预加载。

最后,插件会调用用户插件中带有 enforce: “post” 属性的 transformIndexHtml 钩子,对 HTML 进行进一步的处理。点击查看具体实现。

3.4 ) Commonjs 转换插件

我们知道,在开发环境中,Vite 使用 Esbuild 将 Commonjs 转换为 ESM,而生产环境
中,Vite 会直接使用 Rollup 的官方插件 @rollup/plugin-commonjs。

3.5 ) date-uri 插件

date-uri 插件用来支持 import 模块中含有 Base64 编码的情况,如: import batman from 'data:application/json;base64, eyAiYmF0bWFuIjogInRydWUiIH0=';

点击查看实现

3.6 ) dynamic-import-vars 插件

用于支持在动态 import 中使用变量的功能,如下示例代码:

function importLocale(locale) {
 return import(`./locales/${locale}.js`);
}

内部使用的是 Rollup 的官方插件 @rollup/plugin-dynamic-import-vars

3.7 ) import-meta-url 支持插件

用来转换如下格式的资源 URL: new URL('./foo.png', import.meta.url)
将其转换为生产环境的 URL 格式,如:

// 使用 self.location 来保证低版本浏览器和 Web Worker 环境的兼容性
new URL('./assets.a4b3d56d.png, self.location)

将其转换为生产环境的 URL 格式,如:

// 使用 self.location 来保证低版本浏览器和 Web Worker 环境的兼容性
new URL('./assets.a4b3d56d.png, self.location)

同时,对于动态 import 的情况也能进行支持,如下面的这种写法:

function getImageUrl(name) {
 return new URL(`./dir/${name}.png`, import.meta.url).href
}

Vite 识别到 ./dir/${name}.png 这样的模板字符串,会将整行代码转换成下面这样:

function getImageUrl(name) {
 return import.meta.globEager('./dir/**.png')[`./dir/${name}.png`].default;
}

点击查看具体实现

3.8 ) 生产环境 import 分析插件

vite:build-import-analysis 插件会在生产环境打包时用作 import 语句分析和重写,主要目的是对动态 import 的模块进行预加载处理。对含有动态 import 的 chunk 而言,会在插件的 tranform 钩子中被添加这样一段工具代码用来进行模块预加载,逻辑并不复杂,你可以参考源码实现。关键代码简化后如下:

function preload(importModule, deps) {
  return Promise.all(
      deps.map(dep => {
        // 如果异步模块的依赖还没有加载
        if (!alreadyLoaded(dep)) {
          // 创建 link 标签加载,包括 JS 或者 CSS
          document.head.appendChild(createLink(dep))
          // 如果是 CSS,进行特殊处理,后文会介绍
          if (isCss(dep)) {
            return new Promise((resolve, reject) => {
              link.addEventListener('load', resolve)
              link.addEventListener('error', reject)
            })
          }
        }
      })
    )
    .then(() => importModule())
}

我们知道,Vite 内置了 CSS 代码分割的能力,当一个模块通过动态 import 引入的时
候,这个模块会被单独打包成一个 chunk,与此同时这个模块中的样式代码也会打包成
单独的 CSS 文件。如果异步模块的 CSS 和 JS 同时进行预加载,那么在某些浏览器下
(如 IE)就会出现 FOUC 问题,页面样式会闪烁,影响用户体验。但 Vite 通过监听 link
标签 load 事件的方式来保证 CSS 在 JS 之前加载完成,从而解决了 FOUC 问题。你可
以注意下面这段关键代码

if (isCss) {
 return new Promise((res, rej) => {
	 link.addEventListener('load', res)
	 link.addEventListener('error', rej)
 })
}

现在,我们已经知道了预加载的实现方法,那么 Vite 是如何将动态 import 编译成预加载的代码的呢?从源码的 transform 钩子实现中,不难发现 Vite 会将动态 import 的代码进行转换,如下代码所示:

// 转换前
import('a')
// 转换后
__vitePreload(() => 'a', __VITE_IS_MODERN__ ?"__VITE_PRELOAD__":void)

其中, __vitePreload 会被加载为前文中的 preload 工具函数,
VITE_IS_MODERN 会在 renderChunk 中被替换成 true 或者 false,表示是否为
Modern 模式打包,而对于 “VITE_PRELOAD” ,Vite 会在 generateBundle 阶段,
分析出 a 模块所有依赖文件(包括 CSS),将依赖文件名的数组作为 preload 工具函数的
第二个参数。

同时,对于 Vite 独有的 import.meta.glob 语法,也会在这个插件中进行编译,如:

const modules = import.meta.glob('./dir/*.js')

会通过插件转换成下面这段代码:

const modules = {
 './dir/foo.js': () => import('./dir/foo.js'),
 './dir/bar.js': () => import('./dir/bar.js')
}

具体的实现在 transformImportGlob 函数中,除了被该插件使用外,这个函数被还依赖预构建、开发环境 import 分析等核心流程使用,属于一类比较底层的逻辑,感兴趣的同学可以精读一下这部分的实现源码。

3.9 ) JS 压缩插件

  • Vite 中提供了两种 JS 代码压缩的工具,即 Esbuild 和 Terser,分别由两个插件插件实
    现:
    • vite:esbuild-transpile (点击查看实现)。在 renderChunk 阶段,调用 Esbuild 的
      transform API,并指定 minify 参数,从而实现 JS 的压缩。
    • vite:terser(点击查看实现)。同样也在 renderChunk 阶段,Vite 会单独的 Worker
      进程中调用 Terser 进行 JS 代码压缩。

3.10 ) 构建报告插件

主要由三个插件输出构建报告:

  • vite:manifest(点击查看实现)。提供打包后的各种资源文件及其关联信息,如下内容所示:

    // manifest.json
    {
      "index.html": {
        "file": "assets/index.8edffa56.js",
        "src": "index.html",
        "isEntry": true,
        "imports": [
          // JS 引用
          "_vendor.71e8fac3.js"
        ],
        "css": [
          // 样式文件应用
          "assets/index.458f9883.css"
        ],
        "assets": [
          // 静态资源引用
          "assets/img.9f0de7da.png"
        ]
      },
      "_vendor.71e8fac3.js": {
        "file": "assets/vendor.71e8fac3.js"
      }
    }
    
  • vite:ssr-manifest(点击查看实现)。提供每个模块与 chunk 之间的映射关系,方便SSR 时期通过渲染的组件来确定哪些 chunk 会被使用,从而按需进行预加载。最后插件输出的内容如下:

    // ssr-manifest.json
    {
     "node_modules/object-assign/index.js": [
     "/assets/vendor.71e8fac3.js"
     ],
     "node_modules/object-assign/index.js?commonjs-proxy": [
     "/assets/vendor.71e8fac3.js"
     ],
     // 省略其它模块信息
    }
    
  • vite:reporter(点击查看实现)。主要提供打包时的命令行构建日志:

在这里插入图片描述

4 )开发环境特有插件

4.1 )客户端环境变量注入插件

在开发环境中,Vite 会自动往 HTML 中注入一段 client 的脚本(点击查看实现)

<script type="module" src="/@vite/client"></script>

这段脚本主要提供 注入环境变量 、 处理 HMR 更新逻辑 、 构建出现错误时提供报错界面 等功能,而我们这里要介绍的 vite:client-inject 就是来完成时环境变量的注入,将 client 脚本中的 MODEBASEDEFINE 等等字符串替换为运行时的变量,实现环境变量以及 HMR 相关上下文信息的注入,点击查看插件实现。

4.2 )开发阶段 import 分析插件

最后,Vite 会在开发阶段加入 import 分析插件,即 vite:import-analysis 。与之前所介绍的 vite:build-import-analysis 相对应,主要处理 import 语句相关的解析和重写,但 vite:import-analysis 插件的关注点会不太一样,主要围绕 Vite 开发阶段的各项特性来实现,我们可以来梳理一下这个插件需要做哪些事情:

对 bare import,将路径名转换为真实的文件路径,如:

// 转换前
import 'foo'
// 转换后
// tip: 如果是预构建的依赖,则会转换为预构建产物的路径
import '/@fs/project/node_modules/foo/dist/foo.js'

主要调用 PluginContainer 的上下文对象方法即 this.resolve 实现,这个方法会调用所有插件的 resolveId 方法,包括之前介绍的 vite:pre-alias 和 vite:resolve ,完成路径解析的核心逻辑

  • 对于 HMR 的客户端 API,即 import.meta.hot ,Vite 在识别到这样的 import 语句后,一方面会注入 import.meta.hot 的实现,因为浏览器原生并不具备这样的API,点击查看注入代码;另一方面会识别 accept 方法,并判断 accept 是否为 接受自身更新 的类型, 如果是,则标记为上 isSelfAccepting 的 flag,便于 HMR 在服务端进行更新时进行 HMR Boundary 的查找。对于具体的查找过程,暂时不做赘述

  • 对于全局环境变量读取语句,即 import.meta.env ,Vite 会注入 import.meta.env 的实现,也就是如下的 env 字符串:

    // config 即解析完的配置
    let env = `import.meta.env = ${JSON.stringify({
     ...config.env,
     SSR: !!ssr
    })};`
    // 对用户配置的 define 对象中,将带有 import.meta.env 前缀的全局变量挂到 import.meta.env 对象上
    for (const key in config.define) {
      if (key.startsWith(`import.meta.env.`)) {
        const val = config.define[key]
        env += `${key} = ${
     typeof val === 'string' ? val : JSON.stringify(val)
     };`
      }
    }
    
  • 对于 import.meta.glob 语法,Vite 同样会调用之前提到的 transformImportGlob 函
    数来进行语法转换,但与生产环境的处理不同,在转换之后,Vite 会将该模块通过
    glob 导入的依赖模块记录在 server 实例上,以便于 HMR 更新的时候能得到更准
    确的模块依赖信息,点击查看实现。

总结

  • Vite 的插件机制实现以及各个编译插件的作用和实现,信息密度比较大,需要你对照着官方的代码好好梳理一遍。其中,你需要重点掌握PluginContainer的实现机制和 Vite 内置插件各自的作用。首先,PluginContainer 主要由两部分实现,包括 Rollup 插件钩子的调度和插件钩子内部的 Context 上下文对象实现,总体上模拟了 Rollup 的插件机制。
  • 其次,Vite 内置的插件包括四大类: 别名插件、核心构建插件、生产环境特有插件和开发环境特有插件。这些插件包含了 Vite 核心的编译逻辑,可以说是 Vite 作为构建工具的命脉所在,希望你能对照本小节的内容及其对应的源码链接,了解各个插件的作用。
  • 此外,在学习这些插件的过程中,我们切忌扎到众多繁琐的实现细节中,要尽可能抓关键的实现思路,来高效理解插件背后的原理,这样学习效率会更高。进一步来讲,在你理解了各个插件的实现原理之后,如果遇到某些场景下需要调试某些插件的代码,可以做到有的放矢。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1890349.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

【Docker安装】OpenEuler系统下部署Docker环境

【Docker安装】OpenEuler系统下部署Docker环境 前言一、本次实践介绍1.1 本次实践规划1.2 本次实践简介二、检查本地环境2.1 检查操作系统版本2.2 检查内核版本2.3 检查yum仓库三、卸载Docker四、部署Docker环境4.1 配置yum仓库4.2 检查可用yum仓库4.3 安装Docker4.4 检查Docke…

Pointnet++改进即插即用系列:全网首发GLSA聚合和表示全局和局部空间特征|即插即用,提升特征提取模块性能

简介:1.该教程提供大量的首发改进的方式,降低上手难度,多种结构改进,助力寻找创新点!2.本篇文章对Pointnet++特征提取模块进行改进,加入GLSA,提升性能。3.专栏持续更新,紧随最新的研究内容。 目录 1.理论介绍 2.修改步骤 2.1 步骤一 2.2 步骤二 2.3 步骤三 1.理论介…

运维锅总浅析云原生DevOps工具

本文从Tekton与Kubevela、Jenkins、GitLab CI的区别与联系对常见的云原生DevOps工具进行对比分析&#xff0c;最后给出DevOps工具选型思路。希望对您有所帮助&#xff01; 一、DevOps简介 DevOps是一种结合了软件开发&#xff08;Development&#xff09;和IT运维&#xff08…

CesiumJS【Basic】- #057 绘制纹理填充多边形(Primitive方式)

文章目录 绘制纹理填充多边形(Primitive方式)1 目标2 代码2.1 main.ts绘制纹理填充多边形(Primitive方式) 1 目标 使用Primitive方式绘制绘制纹理填充多边形 2 代码 2.1 main.ts import * as Cesium from cesium;const viewer = new Cesium.Viewer

普元EOS学习笔记-低开实现图书的增删改查

前言 在前一篇《普元EOS学习笔记-创建精简应用》中&#xff0c;我已经创建了EOS精简应用。 我之前说过&#xff0c;EOS精简应用就是自己创建的EOS精简版&#xff0c;该项目中&#xff0c;开发者可以进行低代码开发&#xff0c;也可以进行高代码开发。 本文我就记录一下自己在…

Halcon支持向量机

一 支持向量机 1 支持向量机介绍&#xff1a; 支持向量机(Support Vector Machine&#xff0c;SVM)是Corinna Cortes和Vapnik于1995年首先提出的&#xff0c;它在解决小样本、非线性及高维模式识别表现出许多特有的优势。 2 支持向量机原理: 在n维空间中找到一个分类超平面…

配置Uptime Kuma固定前缀

在做ICT集成项目时&#xff0c;遇到需要对现网接口进行拨测的需求。搜索后尝试使用开源的Uptime Kuma组件完成现网接口拨测。 但该项目有个问题就是默认不支持配置固定前缀&#xff0c;这对现网进行请求转发会造成较大的影响。通过查看该项目的github后找到了问题的解决方案。S…

【C语言】指针经典例题

题1&#xff1a; #include <stdio.h>int main() {int a[5] { 1, 2, 3, 4, 5 };int* ptr (int*)(&a 1);printf("%d,%d", *(a 1), *(ptr - 1));return 0; } //程序的结果是什么&#xff1f; 解答如下&#xff1a; 题2&#xff1a; #include <std…

echarts-wordcloud:打造个性化词云库

前言 在当今信息爆炸的时代&#xff0c;如何从海量的文本数据中提取有用的信息成为了一项重要的任务。词云作为一种直观、易于理解的数据可视化方式&#xff0c;被广泛应用于文本分析和可视化领域。本文将介绍一种基于 echarts-wordcloud 实现的词云库&#xff0c;通过其丰富的…

嵌入式C语言中指针与链表的关系详解

假定给你一块非常小的内存,这块内存只有8字节,这里也没有高级语言,没有操作系统,你操作的数据单位是单个字节,你该怎样读写这块内存呢? 注意这里的限定,再读一遍,没有高级语言,没有操作系统,在这样的限制之下,你必须直面内存读写的本质。 这个本质是什么呢? 本质…

Java同步包装器

通过 Collections.synchronizedList() 方法将一个普通的 ArrayList 包装成了线程安全的 List&#xff1a; import java.util.*;public class SynchronizedWrapperExample {public static void main(String[] args) {// 创建一个非线程安全的 ArrayListList<String> list…

Redis理解【精细】【快速上手】

目录 1. 了解3V和3高 2.什么是redis 3. redis可以做什么 4. Windows安装 5. 使用redis客户端操作redis 5.1 redis基本命令 5.1.1 切换数据库 5.1.2 查看当前数据库的大小 5.1.3 查看当前数据库所有的key ​​​​​​​ 5.1.4 清空当前数据库所有key 5.1.5 清空所…

在Linux操作环境下搭建内网源

在修改配置文件之前都应该有备份。 比如在/目录下专门创建一个目录用来储存文件的备份。 1.安装vsftpd软件 首先使用命令yum search ftpd 来查看当前Linux操作系统下是否有ftpd软件。 随后使用yum install vsftpd&#xff0c;来安装vsftpd软件 2.修改vsftpd的配置文件&…

免费最好用的证件照制作软件,一键换底+老照片修复+图片动漫化,吊打付费!

这款软件真的是阿星用过的&#xff0c;最好用的证件照制作软件&#xff0c;没有之一&#xff01; 我是阿星&#xff0c;今天要给大家安利一款超实用的证件照工具&#xff0c;一键换底&#xff0c;自动排版&#xff0c;免费无广告&#xff0c;让你在家就能轻松搞定证件照&#…

CXL-GPU: 全球首款实现百ns以内的低延迟CXL解决方案

数据中心在追求更高性能和更低总拥有成本&#xff08;TCO&#xff09;的过程中面临三大主要内存挑战。首先&#xff0c;当前服务器内存层次结构存在局限性。直接连接的DRAM与固态硬盘&#xff08;SSD&#xff09;存储之间存在三个数量级的延迟差异。当处理器直接连接的内存容量…

HbuilderX:安卓打包证书.keystore生成与使用

前置条件 已安装jdk或配置好jre环境。 .keystore生成 打开cmd,切换到目标路径,输入以下命令, keytool -genkey -alias testalias -keyalg RSA -keysize 2048 -validity 36500 -keystore test.keystore 输入密钥库口令(要记住), 然后输入一系列信息, …

七大排序算法的深入浅出(java篇)

&#x1f341; 个人主页&#xff1a;爱编程的Tom&#x1f4ab; 本篇博文收录专栏&#xff1a;Java专栏&#x1f449; 目前其它专栏&#xff1a;c系列小游戏 c语言系列--万物的开始_ 等等 &#x1f389; 欢迎 &#x1f44d;点赞✍评论⭐收藏&#x1f496;三连支…

面试题 4:阐述以下方法 @classmethod, @staticmethod, @property?

欢迎莅临我的博客 &#x1f49d;&#x1f49d;&#x1f49d;&#xff0c;很高兴能够在这里和您见面&#xff01;希望您在这里可以感受到一份轻松愉快的氛围&#xff0c;不仅可以获得有趣的内容和知识&#xff0c;也可以畅所欲言、分享您的想法和见解。 推荐:「stormsha的主页」…

CesiumJS【Basic】- #058 绘制网格填充多边形(Entity方式)-使用shader

文章目录 绘制网格填充多边形(Entity方式)-使用shader1 目标2 代码2.1 main.ts绘制网格填充多边形(Entity方式)-使用shader 1 目标 使用Entity方式绘制绘制网格填充多边形 - 使用shader 2 代码 2.1 main.ts import * as Cesium from cesium;// 创建 Cesium Viewer 实例…

MyBatis踩坑记录-多表关联字段相同,字段数据覆盖问题

MyBatis踩坑记录-多表关联字段相同&#xff0c;字段数据覆盖问题 1. 背景描述2. 实体记录3. 错误映射3.1 造成的影响 4. 解决办法4.1 修改映射文件 5. 修复后的效果5.1 返回的数据5.2 正确展示 7. end ~ 1. 背景描述 现有一下业务&#xff0c;单个任务下可能会有多个子任务&am…