十分钟了解Vite如何支持React

系统 浏览器
vite 是基于浏览器支持 ESM 模块,用以解决大型应用本地开发环境打包、热更新时间久的一套解决方案,目前已支持vue、react、Svelte、Solid等主流框架,相信不少同学已经开始使用 vite,并体验到“飞一般”的体验啦,下面我们来看看vite是如何支持react的吧!

[[413981]]

本文转载自微信公众号「微医大前端技术」,作者丁楠 。转载本文请联系微医大前端技术公众号。

前言

vite 是基于浏览器支持 ESM 模块,用以解决大型应用本地开发环境打包、热更新时间久的一套解决方案,目前已支持vue、react、Svelte、Solid等主流框架,相信不少同学已经开始使用 vite,并体验到“飞一般”的体验啦,下面我们来看看vite是如何支持react的吧

一、启动

首先从 github 上拉下 vite 的源码,做好准备工作

  1. git clone https://github.com/vitejs/vite.git 
  2. cd vite 
  3. yarn 
  4. cd packages/vite 
  5. yarn build 
  6. yarn link 

用脚手架搭建好 vite-react 项目

  1. yarn create @vitejs/app my-react-app --template react 
  2. yarn link vite 
  3. yarn dev 

加上 node 浏览器端调试 script

  1. "debug""node --inspect-brk node_modules/vite/dist/node/cli.js" 

启动服务,可以看到

index.html 里比源码多了一块vite/clinet、@react/refresh的代码,另外 script 的 type 都是module类型,我们来根据源码分析下 vite 是如何做了这一层转化。

二、中间件(middleware)

vite 2.x 之后放弃了原先 1.x 的 koa 模型,采用 node 原生 http 模块+connect 的中间件模型,在请求 localhost 过程中首先会被connect-history-api-fallback重定向到 index.html,随后会进入到下一个中间件indexHtmlMiddleware,这里实际是会执行createDevHtmlTransformFn函数

  1. // packages\vite\src\node\server\middlewares\indexHtml.ts 
  2. export function createDevHtmlTransformFn( 
  3.   server: ViteDevServer 
  4. ): (url: string, html: string, originalUrl: string) => Promise<string> { 
  5.   const [preHooks, postHooks] = resolveHtmlTransforms(server.config.plugins) 
  6.  
  7.   return (url: string, html: string, originalUrl: string): Promise<string> => { 
  8.     return applyHtmlTransforms(html, [...preHooks, devHtmlHook, ...postHooks], { 
  9.       path: url, 
  10.       filename: getHtmlFilename(url, server), 
  11.       server, 
  12.       originalUrl 
  13.     }) 
  14.   } 

这里会导出两个 hook,作用分别是

  • devHtmlHook, 将@/vite/client.js 插入头部
  • react-refresh, 将一堆 react-refresh 的代码插入头部

这里就解释了截图中的两端 script 从哪里来的,@/vite/client.js 简单来讲就是支持vite-hmr热更新的一些代码,而@react-refresh是 vite 支持 react 的热更新插件代码

三、转换(transform)

从入口文件(index.html)发起的资源请求都会进入transformMiddleware

  1. // packages\vite\src\node\server\index.ts  文件转换的核心 
  2.   middlewares.use(transformMiddleware(server)) 
  1. // packages\vite\src\node\server\transformRequest.ts  
  2. export async function transformRequest( 
  3.   url 
  4.   { config, pluginContainer, moduleGraph, watcher } 
  5.   options 
  6. ) { 
  7.  
  8.   ... 
  9.   const loadResult = await pluginContainer.load(id, ssr) 
  10.    
  11.   code = loadResult.code 
  12.   map = loadResult.map 
  13.  
  14.   // 代码转换,调用一系列 plugin 做代码转换 
  15.   const transformStart = isDebug ? Date.now() : 0 
  16.   const transformResult = await pluginContainer.transform(code, id, map, ssr) 
  17.    
  18.   code = transformResult.code! 
  19.   map = transformResult.map 
  20.  
  21.   return (mod.transformResult = { 
  22.     code, 
  23.     map, 
  24.     etag: getEtag(code, { weak: true }) 
  25.   } as TransformResult) 
  26.    

而 pluginContainer 的 transform 函数是会调用初始化时 vite 内置的一系列 plugin 对源码进行转换,以src/main.jsx文件为例,首先源码

  1. import React from 'react' 
  2. import ReactDOM from 'react-dom' 
  3. import './index.css' 
  4. import App from './App' 
  5.  
  6. ReactDOM.render( 
  7.   <React.StrictMode> 
  8.     <App /> 
  9.   </React.StrictMode>, 
  10.   document.getElementById('root'

会被标识名为 vite:esbuild 的 plugin 利用 esbuild 的内置 apitransform,将jsx语法转译成React.createElement,算是替代了babel的一部分作用

  1. import React from "react"
  2. import ReactDOM from "react-dom"
  3. import "./index.css"
  4. import App from "./App"
  5. ReactDOM.render(/* @__PURE__ */ React.createElement(React.StrictMode, null, /* @__PURE__ */ React.createElement(App, null)), document.getElementById("root")); 

接着会进入标识名为 vite:import-analysis 的 plugin

原生 ES 引入不支持裸模块导入,Vite 将在服务的所有源文件中检测此类裸模块导入,预构建和重写导入合法 url

  1. import { someMethod } from 'my-dep' 

由于浏览器不支持直接的裸模块导入,所以需要将模块地址改写成真实的资源文件地址,import-analysis使用了es-module-lexer这个包,去动态的分析当前代码中的import语法涉及的依赖,比如上面的react、react-dom,解析成依赖文件所在的本地地址(/node_modules/.vite 文件夹),然后再调用内置的transformCjsImport函数,转换 Commonjs 类型包的 import 语句,比如

  1. import React from "react" 

将会被转译成

  1. 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 中也有类似的实现,感兴趣的朋友也可以找找看,同时多啰嗦几句,vue3 也是一样的转换逻辑,只是针对单文件需要@vitejs/plugin-vue 的支持

后续的加载逻辑形式也是类似的,就不赘述了。

四、@vitejs/plugin-react-refresh

最后再讲下这个包,其实 vite 对 react 的支持主要还是用 esbuild 一部分来替代了原来@babel/preset-react的作用,另外一块就是封装了官方的 react-refresh,来支持 react 的热更新,下面,我们来看下它做了什么。

转码

实际上所有的文件资源都会被@react-refresh 处理一遍,所有 jsx 文件会被@react-refresh通过@babel/core转译一遍,不过只有真正需要热更新的 react 组件才会被输出

  1. const result = transformSync(code, { 
  2.     babelrc: false
  3.     configFile: false
  4.     filename: id, 
  5.     parserOpts: { 
  6.       sourceType: 'module'
  7.       allowAwaitOutsideFunction: true
  8.       plugins: parserPlugins 
  9.     }, 
  10.     generatorOpts: { 
  11.       decoratorsBeforeExport: true 
  12.     }, 
  13.     plugins: [ 
  14.       require('@babel/plugin-transform-react-jsx-self'), 
  15.       require('@babel/plugin-transform-react-jsx-source'), 
  16.       [require('react-refresh/babel'), { skipEnvCheck: true }] 
  17.     ], 
  18.     ast: !isReasonReact, 
  19.     sourceMaps: true
  20.     sourceFileName: id 
  21.   }) 
  22.  
  23.   if (!/\$RefreshReg\$\(/.test(result.code)) { 
  24.     // 这里会用正则去分析,代码块是否是个需要热更新支持的 react component,否则就返回源码 
  25.     return code 
  26.   } 

提供额外的运行时代码

  1. // index.html 被插入这一串初始化代码 
  2. import RefreshRuntime from "/@react-refresh" 
  3. RefreshRuntime.injectIntoGlobalHook(window) 
  4. window.$RefreshReg$ = () => {} 
  5. window.$RefreshSig$ = () => (type) => type 
  6. window.__vite_plugin_react_preamble_installed__ = true 
  7. import { createHotContext as __vite__createHotContext } from "/@vite/client"
  8. import.meta.hot = __vite__createHotContext("/src/App.jsx"); 
  9. import RefreshRuntime from "/@react-refresh"
  10. if (import.meta.hot) { 
  11.   window.$RefreshReg$ = (type, id) => { 
  12.     RefreshRuntime.register(type, "D:/xxx/vite-react/src/App.jsx " + id); 
  13.   }; 
  14.   window.$RefreshSig$ = RefreshRuntime.createSignatureFunctionForTransform; 
  15.  
  16. // 这里插入组件转换后的代码 
  17. if (import.meta.hot) { 
  18.   import.meta.hot.accept(); 
  19.   if (!window.__vite_plugin_react_timeout) { 
  20.     window.__vite_plugin_react_timeout = setTimeout(() => { 
  21.       window.__vite_plugin_react_timeout = 0; 
  22.       RefreshRuntime.performReactRefresh(); 
  23.     }, 30); 
  24.   } 

importAnalysis会在 jsx 文件上动态插入createHotContext的代码,createHotContext是vite提供的机制,用于缓存 context。

RefreshRuntime.register是react-refresh提供的 api,用于注册组件,第二个参数是组件的文件路径加上 id,用于识别哪个组件需要被热替换。

RefreshRuntime.performReactRefresh触发 react 渲染。

五、总结

 

我们来个图归纳下 vite 在支持 react 上做了哪些事吧

其实在启动服务时,vite 会从入口文件起扫描一遍所有的依赖并进行预构建,并生成模块依赖 moduleGraph,类似于树状的形式,方便管理缓存,由于本文主要是对 react 方面的解读,就不一一深入了,后续也会有其他同学更深入的解读,感兴趣的同学欢迎继续跟踪,顺便路过的大哥、小姐姐们来个三连!

 

责任编辑:武晓燕 来源: 微医大前端技术
相关推荐

2023-03-13 07:52:13

2023-07-15 18:26:51

LinuxABI

2015-11-06 11:03:36

2020-12-17 06:48:21

SQLkafkaMySQL

2009-10-09 14:45:29

VB程序

2009-11-03 11:01:45

VB.NET远程事件

2019-04-01 14:59:56

负载均衡服务器网络

2021-09-07 09:40:20

Spark大数据引擎

2022-06-16 07:31:41

Web组件封装HTML 标签

2023-04-12 11:18:51

甘特图前端

2020-12-09 16:41:22

LinuxIT开发

2023-08-15 15:50:42

2012-07-10 01:22:32

PythonPython教程

2015-09-06 09:22:24

框架搭建快速高效app

2023-11-30 10:21:48

虚拟列表虚拟列表工具库

2019-09-16 09:14:51

2022-08-26 09:01:07

CSSFlex 布局

2023-10-11 08:18:55

DjangoPython

2022-04-13 22:01:44

错误监控系统

2023-11-09 14:44:27

Docker镜像容器
点赞
收藏

51CTO技术栈公众号