十分鐘了解Vite如何支持React
本文轉(zhuǎn)載自微信公眾號「微醫(yī)大前端技術(shù)」，作者丁楠 。轉(zhuǎn)載本文請聯(lián)系微醫(yī)大前端技術(shù)公眾號。
前言
vite 是基于瀏覽器支持 ESM 模塊，用以解決大型應(yīng)用本地開發(fā)環(huán)境打包、熱更新時間久的一套解決方案，目前已支持vue、react、Svelte、Solid等主流框架，相信不少同學已經(jīng)開始使用 vite，并體驗到“飛一般”的體驗啦，下面我們來看看vite是如何支持react的吧
一、啟動
首先從 github 上拉下 vite 的源碼，做好準備工作
- git clone https://github.com/vitejs/vite.git
- cd vite
- yarn
- cd packages/vite
- yarn build
- yarn link
用腳手架搭建好 vite-react 項目
- yarn create @vitejs/app my-react-app --template react
- yarn link vite
- yarn dev
加上 node 瀏覽器端調(diào)試 script
- "debug": "node --inspect-brk node_modules/vite/dist/node/cli.js"
啟動服務(wù)，可以看到
index.html 里比源碼多了一塊vite/clinet、@react/refresh的代碼，另外 script 的 type 都是module類型，我們來根據(jù)源碼分析下 vite 是如何做了這一層轉(zhuǎn)化。
二、中間件(middleware)
vite 2.x 之后放棄了原先 1.x 的 koa 模型，采用 node 原生 http 模塊+connect 的中間件模型，在請求 localhost 過程中首先會被connect-history-api-fallback重定向到 index.html，隨后會進入到下一個中間件indexHtmlMiddleware，這里實際是會執(zhí)行createDevHtmlTransformFn函數(shù)
- // packages\vite\src\node\server\middlewares\indexHtml.ts
- export function createDevHtmlTransformFn(
- server: ViteDevServer
- ): (url: string, html: string, originalUrl: string) => Promise<string> {
- const [preHooks, postHooks] = resolveHtmlTransforms(server.config.plugins)
- return (url: string, html: string, originalUrl: string): Promise<string> => {
- return applyHtmlTransforms(html, [...preHooks, devHtmlHook, ...postHooks], {
- path: url,
- filename: getHtmlFilename(url, server),
- server,
- originalUrl
- })
- }
- }
這里會導出兩個 hook，作用分別是
- devHtmlHook， 將@/vite/client.js 插入頭部
- react-refresh， 將一堆 react-refresh 的代碼插入頭部
這里就解釋了截圖中的兩端 script 從哪里來的，@/vite/client.js 簡單來講就是支持vite-hmr熱更新的一些代碼，而@react-refresh是 vite 支持 react 的熱更新插件代碼
三、轉(zhuǎn)換(transform)
從入口文件(index.html)發(fā)起的資源請求都會進入transformMiddleware
- // packages\vite\src\node\server\index.ts 文件轉(zhuǎn)換的核心
- middlewares.use(transformMiddleware(server))
- // packages\vite\src\node\server\transformRequest.ts
- export async function transformRequest(
- url
- { config, pluginContainer, moduleGraph, watcher }
- options
- ) {
- ...
- const loadResult = await pluginContainer.load(id, ssr)
- code = loadResult.code
- map = loadResult.map
- // 代碼轉(zhuǎn)換，調(diào)用一系列 plugin 做代碼轉(zhuǎn)換
- const transformStart = isDebug ? Date.now() : 0
- const transformResult = await pluginContainer.transform(code, id, map, ssr)
- code = transformResult.code!
- map = transformResult.map
- return (mod.transformResult = {
- code,
- map,
- etag: getEtag(code, { weak: true })
- } as TransformResult)
- }
而 pluginContainer 的 transform 函數(shù)是會調(diào)用初始化時 vite 內(nèi)置的一系列 plugin 對源碼進行轉(zhuǎn)換，以src/main.jsx文件為例，首先源碼
- import React from 'react'
- import ReactDOM from 'react-dom'
- import './index.css'
- import App from './App'
- ReactDOM.render(
- <React.StrictMode>
- <App />
- </React.StrictMode>,
- document.getElementById('root')
- )
會被標識名為 vite:esbuild 的 plugin 利用 esbuild 的內(nèi)置 apitransform，將jsx語法轉(zhuǎn)譯成React.createElement，算是替代了babel的一部分作用
- import React from "react";
- import ReactDOM from "react-dom";
- import "./index.css";
- import App from "./App";
- ReactDOM.render(/* @__PURE__ */ React.createElement(React.StrictMode, null, /* @__PURE__ */ React.createElement(App, null)), document.getElementById("root"));
接著會進入標識名為 vite:import-analysis 的 plugin
原生 ES 引入不支持裸模塊導入，Vite 將在服務(wù)的所有源文件中檢測此類裸模塊導入，預構(gòu)建和重寫導入合法 url
- import { someMethod } from 'my-dep'
由于瀏覽器不支持直接的裸模塊導入，所以需要將模塊地址改寫成真實的資源文件地址，import-analysis使用了es-module-lexer這個包，去動態(tài)的分析當前代碼中的import語法涉及的依賴，比如上面的react、react-dom，解析成依賴文件所在的本地地址(/node_modules/.vite 文件夾)，然后再調(diào)用內(nèi)置的transformCjsImport函數(shù)，轉(zhuǎn)換 Commonjs 類型包的 import 語句，比如
- import React from "react"
將會被轉(zhuǎn)譯成
- import __vite__cjsImport0_react from "/node_modules/.vite/react.js?v=21227a2f"; const React = __vite__cjsImport0_react.__esModule ? __vite__cjsImport0_react.default : __vite__cjsImport0_react
總感覺這部分在 webpack 中也有類似的實現(xiàn)，感興趣的朋友也可以找找看，同時多啰嗦幾句，vue3 也是一樣的轉(zhuǎn)換邏輯，只是針對單文件需要@vitejs/plugin-vue 的支持
后續(xù)的加載邏輯形式也是類似的，就不贅述了。
四、@vitejs/plugin-react-refresh
最后再講下這個包，其實 vite 對 react 的支持主要還是用 esbuild 一部分來替代了原來@babel/preset-react的作用，另外一塊就是封裝了官方的 react-refresh，來支持 react 的熱更新，下面，我們來看下它做了什么。
轉(zhuǎn)碼
實際上所有的文件資源都會被@react-refresh 處理一遍，所有 jsx 文件會被@react-refresh通過@babel/core轉(zhuǎn)譯一遍，不過只有真正需要熱更新的 react 組件才會被輸出
- const result = transformSync(code, {
- babelrc: false,
- configFile: false,
- filename: id,
- parserOpts: {
- sourceType: 'module',
- allowAwaitOutsideFunction: true,
- plugins: parserPlugins
- },
- generatorOpts: {
- decoratorsBeforeExport: true
- },
- plugins: [
- require('@babel/plugin-transform-react-jsx-self'),
- require('@babel/plugin-transform-react-jsx-source'),
- [require('react-refresh/babel'), { skipEnvCheck: true }]
- ],
- ast: !isReasonReact,
- sourceMaps: true,
- sourceFileName: id
- })
- if (!/\$RefreshReg\$\(/.test(result.code)) {
- // 這里會用正則去分析，代碼塊是否是個需要熱更新支持的 react component，否則就返回源碼
- return code
- }
提供額外的運行時代碼
- // index.html 被插入這一串初始化代碼
- import RefreshRuntime from "/@react-refresh"
- RefreshRuntime.injectIntoGlobalHook(window)
- window.$RefreshReg$ = () => {}
- window.$RefreshSig$ = () => (type) => type
- window.__vite_plugin_react_preamble_installed__ = true
- import { createHotContext as __vite__createHotContext } from "/@vite/client";
- import.meta.hot = __vite__createHotContext("/src/App.jsx");
- import RefreshRuntime from "/@react-refresh";
- if (import.meta.hot) {
- window.$RefreshReg$ = (type, id) => {
- RefreshRuntime.register(type, "D:/xxx/vite-react/src/App.jsx " + id);
- };
- window.$RefreshSig$ = RefreshRuntime.createSignatureFunctionForTransform;
- }
- // 這里插入組件轉(zhuǎn)換后的代碼
- if (import.meta.hot) {
- import.meta.hot.accept();
- if (!window.__vite_plugin_react_timeout) {
- window.__vite_plugin_react_timeout = setTimeout(() => {
- window.__vite_plugin_react_timeout = 0;
- RefreshRuntime.performReactRefresh();
- }, 30);
- }
- }
importAnalysis會在 jsx 文件上動態(tài)插入createHotContext的代碼，createHotContext是vite提供的機制，用于緩存 context。
RefreshRuntime.register是react-refresh提供的 api，用于注冊組件，第二個參數(shù)是組件的文件路徑加上 id，用于識別哪個組件需要被熱替換。
RefreshRuntime.performReactRefresh觸發(fā) react 渲染。
五、總結(jié)
我們來個圖歸納下 vite 在支持 react 上做了哪些事吧
其實在啟動服務(wù)時，vite 會從入口文件起掃描一遍所有的依賴并進行預構(gòu)建，并生成模塊依賴 moduleGraph，類似于樹狀的形式，方便管理緩存，由于本文主要是對 react 方面的解讀，就不一一深入了，后續(xù)也會有其他同學更深入的解讀，感興趣的同學歡迎繼續(xù)跟蹤，順便路過的大哥、小姐姐們來個三連!
