vite项目为什么可以直接使用NODE_ENV?
背景
我们知道,在process.env
中并没有NODE_ENV
这个变量,但是我们却可以在项目的代码中使用process.env.NODE_ENV这个值来判断当前是development环境还是production环境,然后进行后续的逻辑操作。
这说明,在vite内部,对process.env.NODE_ENV有赋值的操作,但是在公司项目中,启动的时候不管是serve还是build,在在tailwind.config.js
中打印process.env.NODE_ENV变量,NODE_ENV
均为development
,这就让人感觉很困惑。
当时为了简单处理,使用了行内npm scrips配置,即在启动服务的时候,设置process.env.NODE_ENV的值,如下所示:
"scripts": {
"serve": "cross-env NODE_ENV=development vite",
"build": "cross-env NODE_ENV=prod vite build --mode prod",
"build-v1": "cross-env NODE_ENV=v1 vite build --mode v1",
},
复制代码
后来一直觉得不妥,应该有更为简单合理的方式去判断当前项目所处的环境,毕竟vite中会有.env
文件来让我们配置环境变量,应该跟process.env.NODE_ENV有些许关系。
于是,决定深入vite源码去剖析process.env.NODE_ENV赋值的逻辑,最后找到了更好的替代cross-env的方式去判断当前项目所处的环境。也是这篇文章的动机所在。
分析执行过程
首先,在一些需要的地方打上断点:
vite启动位置defineConfig tailwind.config.js 文件开始位置 vite源码中,对process.env.NODE_ENV进行赋值的位置
然后在VSCode中,配置好launch.json后,启动调试。
由于我们执行的是npm run serve,所以首先会断在cli.js中,创建服务的位置,可以看到调用createServer
创建本地服务。
继续F5,进入createServer
,会执行resolveConfig
,其中参数inlineConfig.mode
就是我们npm scrips中指定的mode,这里没有指定(执行的只是npm run serve: vite)mode,所以这里为undefined。
经过一次判断 mode === production
,不成立,此时process.env.NODE_ENV还是undefined。
(在build 时候,由于我是手动指定mode为prod,导致
prod ≠= production
,所以process.env.NODE_ENV
还是undefined。)
进入loadEnv
方法,这里vite会读取.env
文件,然后,如果是“VITE_”开头,会存入env变量中,如果是“NODE_ENV”变量,会设置process.env.VITE_USER_NODE_ENV = value;
即设置的NODE_ENV的值。(这个process.env.VITE_USER_NODE_ENV
就可以为我们所用)
继续往下F5,loadEnv
完后,继续一个判断:因为我们在.env
文件中没有定义NODE_ENV变量,所以isProduction
是false,所以这片代码过后,process.env.NODE_ENV
还是undefined。
继续F5,然后会走到一个createContext
函数,这个就是关键所在。由于我们的process.env.NODE_ENV
在之前一直为undefined,所以ctx.env就是undefined,于是process.env.NODE_ENV
被赋值为development。
我们继续,经过多次createContext
函数的进进出出,最后终于到了tailwind文件中,可以看到NODE_ENV 的值为development。
这也是为什么不管是serve还是build,我们一直在tailwind.config.js
中打印的NODE_ENV都是development的原因。
我之前还一直以为,是由于tailwind.config.js
会在vite.config.js
之前执行。
解决方案
之前也想在tailwind文件中使用import.meta.env
来获取VITE_
开头的环境变量,因为加载的.env中的环境变量也会通过 import.meta.env
以字符串形式暴露给客户端源码。
但是只要在tailwind中一引用就会报错。
最后通过查询才知道,import.meta
是一个内置在 ES 模块内部的对象(之前一直以为是vite暴露出来的)。而我们的tailwind文件是CommonJS模块,自然没有import.meta
对象。
所以此路不通,得想其他的办法。
之前提到,在.env
文件中定义的NODE_ENV
,会在vite中被赋值给process.env.VITE_USER_NODE_ENV
,我们可以用VITE_USER_NODE_ENV
来作为我们项目环境的判断。
只需在.env
文件中加上NODE_ENV
变量:
NODE_ENV=prod
复制代码
然后在代码中使用VITE_USER_NODE_ENV
来进行判断即可:
purge: {
// 仅生产环境启用优化
enabled: process.env.VITE_USER_NODE_ENV == 'prod',
// 删除未使用的CSS tree-shake,减少打包后的体积
content: ['./src/**/*.html', './src/**/*.vue', './src/**/*.jsx'],
},
复制代码
(完)
关于本文
来自:前端队长小冯
https://juejin.cn/post/7167933987925524516