import.meta.env

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中引入,设置为全局变量

相关推荐
GIS之路12 分钟前
GeoTools 结合 OpenLayers 实现空间查询
前端
陳有味_ChenUvi13 分钟前
使用 pnpm 优雅搭建 Monorepo 仓库
前端·npm·前端工程化
旷世奇才李先生15 分钟前
XML DOM 安装使用教程
xml·前端·chrome
程序员秘密基地22 分钟前
基于html,css,vue,vscode,vs2022,asp.net,aspnet,.net,c#,mysql数据库,在线健身,俱乐部管理系统
前端·vue.js·后端·mysql·asp.net
Mintopia25 分钟前
Three.js 画布纹理:像素世界的魔法编织术
前端·javascript·three.js
天天摸鱼的java工程师25 分钟前
当我成为面试官,我才知道当年那些面试官其实并不是在难为我,而是在考察我面对问题的拆解能力
前端·后端·面试
袁煦丞28 分钟前
泰拉瑞亚远程联机魔法:cpolar内网穿透实验室第617个成功挑战
前端·程序员·远程工作
玲小珑32 分钟前
Next.js 教程系列(十二)API Routes:构建轻量级后端服务
前端·next.js
JinSo37 分钟前
EasyEditor AI 聊天助手:让低代码开发更简单
前端·javascript·github
答案answer41 分钟前
three.js 实现几个炫酷的粒子特效(火焰,烟雾,烟花)
前端·three.js