import.meta.env
是vite项目中对外暴露一个环境变量, 可以在项目中任意一处进行访问。
内建变量
内建变量是指import.meta.env
自身固有的属性,可以直接访问,常见的内建变量有:
- import.meta.env.MODE : 当前运行模式(production | development)
- import.meta.env.BASE_URL : 部署应用时的基本 URL
- import.meta.env.PROD: 是否处在生产环境下
- import.meta.env.DEV : 是否处在开发环境下
- import.meta.env.SSR : 是否运行在server中
非内建变量
import.meta.env
除了有内建变量外,还可以通过dotenv
从环境目录中读取对应的配置文件中的变量,并将这些变量添加到自身身上。
常见的配置文件有:
bash
.env # 所有情况下都会加载
.env.local # 所有情况下都会加载,但会被 git 忽略
.env.[mode] # 只在指定模式下加载
.env.[mode].local # 只在指定模式下加载,但会被 git 忽略
例如,在项目中有.env文件,且处在开发环境下,那么:
ini
# .env文件
VITE_NAME='这是开发环境'
arduino
# main.js
console.log(import.meta.env)
----
{
"VITE_NAME": "这是开发环境",
"BASE_URL": "/",
"MODE": "development",
"DEV": true,
"PROD": false,
"SSR": false
}
除了.env
配置文件外,vite 还支持以下配置文件:
bash
.env # 所有情况下都会加载
.env.local # 所有情况下都会加载,但会被 git 忽略
.env.[mode] # 只在指定模式下加载
.env.[mode].local # 只在指定模式下加载,但会被 git 忽略
同时存在多个.env.*
文件,加载也会有不同的优先级
bash
指定模式的文件(`.env.production`)会比通用形式的优先级更高( `.env`)
另外,Vite 执行时已经存在的环境变量有最高的优先级,不会被 `.env` 类文件覆盖。
.env 类文件会在 Vite 启动一开始时被加载,而改动会在重启服务器后生效。
生产环境替换
vite会根据不同的生产环境加载对应的配置文件。
import.meta.env.MODE = production, 会加载.env.production
import.meta.env.MODE = development, 会加载.env.development
另外,在生产环境中,这些环境变量会在构建时被静态替换
,因此,在引用它们时请使用完全静态的字符串。动态的 key 将无法生效。例如,动态 key 取值 import.meta.env[key]
是无效中
环境变量格式
为了防止意外地将一些环境变量泄漏到客户端,只有以 VITE_
为前缀的变量才会暴露给经过 vite 处理的代码。例如
arduino
VITE_SOME_KEY=123
DB_PASSWORD=foobar
--------------------
console.log(import.meta.env.VITE_SOME_KEY) // 123
console.log(import.meta.env.DB_PASSWORD) // undefined
总结
在项目开发过程中,可以通过import.meta.env
获取当时所处的环境,并加载对应的配置信息。特别适用于开发接口
和生产接口
不一致的时候。
题外话
import.meta.env
可以针对不同的环境使用不同的配置,适用于配置信息明确的项目。但是打包过后配置文件就没有了,没办法动态去修改配置信息。
工作中会遇到一种情况:获取到项目的编译包,A项目使用A接口,B项目使用B接口。这时候最好的做法应该是在public文件夹中添加配置文件config.js
, 在mian.js
中引入,设置为全局变量