vite项目import.meta.env能获取非VITE开发的环境变量
在Vite项目中,import.meta.env
是一个全局对象,用于访问环境变量。
默认情况下,import.meta.env
只能获取到Vite的开发环境变量,而不能获取非Vite开发的环境变量。
这是因为Vite使用特定的方式来处理环境变量,并提供了一个插件来注入这些环境变量。
如果你想在Vite项目中获取非Vite开发的环境变量,可以通过以下步骤:
安装dotenv
包:在Vite项目中,首先需要安装dotenv
包,用于加载.env
文件中的环境变量。
可以使用以下命令进行安装:
npm install dotenv --save-dev
创建.env
文件:在项目根目录下创建一个名为.env
的文件,并在文件中定义你需要的环境变量。
例如,.env
文件内容如下:
API_URL=https://example.com/api
在vite.config.js
中配置dotenv
插件:打开vite.config.js
文件,添加以下配置来启用dotenv
插件:
import { defineConfig } from 'vite' import dotenv from 'dotenv' export default defineConfig({ plugins: [dotenv()], })
在你的代码中引入环境变量:现在你可以在你的代码中使用process.env
来访问环境变量。
例如,可以通过process.env.API_URL
来访问之前在.env
文件中定义的API_URL
环境变量。
注意事项:
- 在Vite项目中,
dotenv
插件将会自动读取.env
文件,并将其中的环境变量注入到process.env
中。 .env
文件应当被添加到你的代码版本控制系统的.gitignore
文件中,以避免将敏感信息提交到源代码库中。
通过上述步骤,你可以在Vite项目中使用import.meta.env
来获取非Vite开发的环境变量。
Vite的环境变量
环境变量和模式
环境变量
Vite 在一个特殊的 import.meta.env 对象上暴露环境变量。
这里有一些在所有情况下都可以使用的内建变量:
- import.meta.env.MODE: {string} 应用运行的模式。
- import.meta.env.BASE_URL: {string} 部署应用时的基本 URL。他由base 配置项决定。
- import.meta.env.PROD: {boolean} 应用是否运行在生产环境。
- import.meta.env.DEV: {boolean} 应用是否运行在开发环境 (永远与 import.meta.env.PROD相反)。
- import.meta.env.SSR: {boolean} 应用是否运行在 server 上。
生产环境替换
在生产环境中,这些环境变量会在构建时被静态替换,因此,在引用它们时请使用完全静态的字符串。
动态的 key 将无法生效。
例如,动态 key 取值 import.meta.env[key] 是无效的。
它还将替换出现在 JavaScript 和 Vue 模板中的字符串。这本应是非常少见的,但也可能是不小心为之的。
在这种情况下你可能会看到类似 Missing Semicolon 或 Unexpected token 等错误,
例如当"process.env.NODE_ENV"
被替换为 "“development”: "。
有一些方法可以避免这个问题:
对于 JavaScript 字符串,你可以使用 unicode 零宽度空格来分割这个字符串,
例如: 'import.meta\u200b.env.MODE'
。
对于 Vue 模板或其他编译到 JavaScript 字符串的 HTML,你可以使用 标签,
例如:import.meta.env.MODE。
.env 文件
Vite 使用 dotenv 从你的 环境目录 中的下列文件加载额外的环境变量:
.env # 所有情况下都会加载 .env.local # 所有情况下都会加载,但会被 git 忽略 .env.[mode] # 只在指定模式下加载 .env.[mode].local # 只在指定模式下加载,但会被 git 忽略\
环境加载优先级
一份用于指定模式的文件(例如 .env.production)会比通用形式的优先级更高(例如 .env)。
另外,Vite 执行时已经存在的环境变量有最高的优先级,不会被 .env 类文件覆盖。
例如当运行 VITE_SOME_KEY=123 vite build 的时候。
.env 类文件会在 Vite 启动一开始时被加载,而改动会在重启服务器后生效。
加载的环境变量也会通过 import.meta.env 以字符串形式暴露给客户端源码。
为了防止意外地将一些环境变量泄漏到客户端,只有以 VITE_ 为前缀的变量才会暴露给经过 vite 处理的代码。
例如下面这些环境变量:
VITE_SOME_KEY=123 DB_PASSWORD=foobar
只有 VITE_SOME_KEY 会被暴露为 import.meta.env.VITE_SOME_KEY 提供给客户端源码,而 DB_PASSWORD 则不会。
console.log(import.meta.env.VITE_SOME_KEY) // 123 console.log(import.meta.env.DB_PASSWORD) // undefined
此外,Vite 使用 dotenv-expand 来直接拓展变量。想要了解更多相关语法,请查看 它们的文档。
请注意,如果想要在环境变量中使用 $ 符号,则必须使用 \ 对其进行转义。
KEY=123 NEW_KEY1=test$foo # test NEW_KEY2=test\$foo # test$foo NEW_KEY3=test$KEY # test123
如果你想自定义 env 变量的前缀,请参阅 envPrefix。
安全注意事项
.env.*.local 文件应是本地的,可以包含敏感变量。
你应该将 .local 添加到你的 .gitignore 中,以避免它们被 git 检入。
由于任何暴露给 Vite 源码的变量最终都将出现在客户端包中,VITE_* 变量应该不包含任何敏感信息。
TypeScript 的智能提示
默认情况下,Vite 在 vite/client.d.ts 中为 import.meta.env 提供了类型定义。
随着在 .env[mode] 文件中自定义了越来越多的环境变量,你可能想要在代码中获取这些以 VITE_ 为前缀的用户自定义环境变量的 TypeScript 智能提示。
要想做到这一点,你可以在 src 目录下创建一个 env.d.ts 文件,接着按下面这样增加 ImportMetaEnv 的定义:
/// <reference types="vite/client" /> interface ImportMetaEnv { readonly VITE_APP_TITLE: string // 更多环境变量... } interface ImportMeta { readonly env: ImportMetaEnv }
如果你的代码依赖于浏览器环境的类型,比如 DOM 和 WebWorker,你可以在 tsconfig.json 中修改 lib 字段来获取类型支持。
{ "lib": ["WebWorker"] }
模式
默认情况下,开发服务器 (dev 命令) 运行在 development (开发) 模式,而 build 命令则运行在 production (生产) 模式。
这意味着当执行 vite build 时,它会自动加载 .env.production 中可能存在的环境变量:
.env.production
VITE_APP_TITLE=My App
在你的应用中,你可以使用 import.meta.env.VITE_APP_TITLE 渲染标题。
在某些情况下,若想在 vite build 时运行不同的模式来渲染不同的标题,你可以通过传递 --mode 选项标志来覆盖命令使用的默认模式。
例如,如果你想在 staging (预发布)模式下构建应用:
bash vite build --mode staging
还需要新建一个 .env.staging 文件:
.env.staging
VITE_APP_TITLE=My App (staging)
由于 vite build 默认运行生产模式构建,你也可以通过使用不同的模式和对应的 .env 文件配置来改变它,用以运行开发模式的构建:
.env.testing
NODE_ENV=development
总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持。