环境变量和模式

Vite 在特殊的 import.meta.env 对象上暴露环境变量。这些变量在开发环境中定义为全局变量，并在构建时进行静态替换，以实现有效的摇树优化（tree-shaking）。

示例

if (import.meta.env.DEV) {
  // code inside here will be tree-shaken in production builds
  console.log('Dev mode')
}

观看 Scrimba 互动教程

内置常量

在任何情况下都可使用以下内置常量：

• import.meta.env.MODE: {string} 应用运行的模式。

• import.meta.env.BASE_URL: {string} 部署应用时的基本 URL。它由 base 配置项决定。

• import.meta.env.PROD: {boolean} 应用是否运行在生产环境（通过 NODE_ENV='production' 启动开发服务器，或运行由 NODE_ENV='production' 构建的应用）。

• import.meta.env.DEV: {boolean} 应用是否运行在开发环境（始终与 import.meta.env.PROD 相反）。

• import.meta.env.SSR: {boolean} 应用是否运行在 服务端。

环境变量

Vite 会自动将环境变量暴露在 import.meta.env 对象中（均为字符串）。

以 VITE_ 为前缀的变量才会在 Vite 打包后的客户端源代码中暴露。为了防止意外泄露环境变量，请避免使用此以外的前缀。例如，考虑以下情况：

.env

VITE_SOME_KEY=123
DB_PASSWORD=foobar

解析后的 VITE_SOME_KEY 的值 —— "123" —— 将被暴露给客户端，但 DB_PASSWORD 不会被暴露。您可以通过在代码中添加以下内容来测试：

console.log(import.meta.env.VITE_SOME_KEY) // "123"
console.log(import.meta.env.DB_PASSWORD) // undefined

如果您想自定义环境变量的前缀，请参考 envPrefix 选项。

环境变量解析

如上所示，VITE_SOME_KEY 本应为数字，但解析后返回的是字符串。布尔值环境变量同样会发生这种情况。在代码中使用时，请务必将其转换为所需的类型。

保护敏感信息

VITE_* 变量不应包含 API 密钥等敏感信息。这些变量的值在构建时会被打包进源代码中。对于生产环境部署，请考虑使用后端服务器或无服务器/边缘函数来妥善保护机密。

.env 文件

Vite 使用 dotenv 从环境变量目录下的以下文件中加载额外的环境变量：

.env                # loaded in all cases
.env.local          # loaded in all cases, ignored by git
.env.[mode]         # only loaded in specified mode
.env.[mode].local   # only loaded in specified mode, ignored by git

环境变量加载优先级

特定模式的环境变量文件（例如 .env.production）的优先级高于通用文件（例如 .env）。

除了特定模式的 .env.[mode] 文件外，Vite 总是会加载 .env 和 .env.local。在特定模式文件中声明的变量优先级最高；如果变量仅定义在 .env 或 .env.local 中，它们在环境中依然可用。

此外，在 Vite 执行时已存在的环境变量拥有最高优先级，不会被 .env 文件覆盖。例如，当运行 VITE_SOME_KEY=123 vite build 时。

.env 文件在 Vite 启动时加载。更改后请重启服务器。

Bun 用户

使用 Bun 时请注意，Bun 会在脚本运行前自动加载 .env 文件。这种内置行为会将环境变量直接加载到 process.env 中，可能会干扰 Vite 的功能（因为 Vite 遵循现有的 process.env 值）。请参阅 oven-sh/bun#5515 获取解决方案。

此外，Vite 开箱即用地使用 dotenv-expand 来展开环境变量。要了解更多语法信息，请查看其文档。

注意，如果您想在环境变量值中使用 $，必须使用 \ 对其进行转义。

.env

KEY=123
NEW_KEY1=test$foo   # test
NEW_KEY2=test\$foo  # test$foo
NEW_KEY3=test$KEY   # test123

反向顺序展开变量

Vite 支持反向顺序展开变量。例如，下方的 .env 将被解析为 VITE_FOO=foobar 和 VITE_BAR=bar。

.env

VITE_FOO=foo${VITE_BAR}
VITE_BAR=bar

这种行为在 shell 脚本或其他工具（如 docker compose）中并不适用。但由于 dotenv-expand 长期支持此行为，且 JavaScript 生态系统中的其他工具通常使用支持此行为的旧版本，因此 Vite 也予以支持。

为避免互操作性问题，建议不要依赖此行为。Vite 未来可能会针对此行为发出警告。

忽略本地 .env 文件

.env.*.local 文件仅供本地使用，可能包含敏感变量。你应该在 .gitignore 中添加 *.local，以避免将其提交到 git 中。

TypeScript 的智能感知（IntelliSense）

默认情况下，Vite 在 vite/client.d.ts 中为 import.meta.env 提供了类型定义。虽然您可以在 .env.[mode] 文件中定义更多自定义环境变量，但您可能希望为以 VITE_ 开头的自定义环境变量获得 TypeScript 的智能感知。

为此，您可以在 src 目录下创建一个 vite-env.d.ts 文件，并按如下方式扩充 ImportMetaEnv：

vite-env.d.ts

interface ViteTypeOptions {
  // By adding this line, you can make the type of ImportMetaEnv strict
  // to disallow unknown keys.
  // strictImportMetaEnv: unknown
}

interface ImportMetaEnv {
  readonly VITE_APP_TITLE: string
  // more env variables...
}

interface ImportMeta {
  readonly env: ImportMetaEnv
}

如果您的代码依赖于浏览器环境的类型（如 DOM 和 WebWorker），您可以更新 tsconfig.json 中的 lib 字段。

tsconfig.json

{
  "lib": ["WebWorker"]
}

导入会破坏类型扩充

如果 ImportMetaEnv 的类型扩充无效，请确保 vite-env.d.ts 中没有任何 import 语句。有关详细信息，请参阅 TypeScript 文档。

HTML 常量替换

Vite 还支持在 HTML 文件中替换常量。import.meta.env 中的任何属性都可以使用 %CONST_NAME% 语法在 HTML 文件中使用：

<h1>Vite is running in %MODE%</h1>
<p>Using data from %VITE_API_URL%</p>

如果环境变量在 import.meta.env 中不存在（例如 %NON_EXISTENT%），它将被忽略且不会被替换，这与 JS 中 import.meta.env.NON_EXISTENT 被替换为 undefined 的行为不同。

鉴于 Vite 被许多框架使用，它特意不对复杂的替换（如条件判断）进行预设。Vite 可以通过现有的用户插件或实现 transformIndexHtml 钩子的自定义插件进行扩展。

模式

默认情况下，开发服务器（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（预发布）模式构建应用：

vite build --mode staging

并创建一个 .env.staging 文件：

.env.staging

VITE_APP_TITLE=My App (staging)

由于 vite build 默认运行生产构建，您也可以通过更改模式和 .env 文件配置来运行开发构建：

.env.testing

NODE_ENV=development

NODE_ENV 和模式

需要注意的是，NODE_ENV (process.env.NODE_ENV) 和模式是两个不同的概念。以下是不同命令如何影响 NODE_ENV 和模式：

命令	NODE_ENV	模式
vite build	"production"	"production"
vite build --mode development	"production"	"development"
NODE_ENV=development vite build	"development"	"production"
NODE_ENV=development vite build --mode development	"development"	"development"

NODE_ENV 和模式的不同值也反映在相应的 import.meta.env 属性上：

命令	import.meta.env.PROD	import.meta.env.DEV
NODE_ENV=production	true	false
NODE_ENV=development	false	true
NODE_ENV=other	false	true

命令	import.meta.env.MODE
--mode production	"production"
--mode development	"development"
--mode staging	"staging"

.env 文件中的 NODE_ENV

NODE_ENV=... 可以在命令中设置，也可以在 .env 文件中设置。如果 NODE_ENV 在 .env.[mode] 文件中指定，则可以使用模式来控制其值。然而，NODE_ENV 和模式仍然是两个不同的概念。

在命令中使用 NODE_ENV=... 的主要好处是让 Vite 可以提前检测到该值。它还允许您在 Vite 配置中读取 process.env.NODE_ENV，因为 Vite 只能在配置求值后才能加载环境变量文件。