环境变量与模式

vite-main使用指南

环境变量与模式

Vite 在特殊的 import.meta.env 对象下暴露某些常量。这些常量在开发时被定义为全局变量，并在构建时进行静态替换，以便有效地进行 tree-shaking。

::: details 示例

js 复制代码

if (import.meta.env.DEV) {
  // 此处代码将在生产构建中被 tree-shaken
  console.log('开发模式')
}

在 Scrimba 上观看交互式课程

内置常量

以下内置常量在所有情况下均可用：

import.meta.env.MODE：{string} 应用运行的模式（mode）。

import.meta.env.BASE_URL：{string} 应用所服务的 base 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 不会。你可以通过将以下内容添加到代码中来测试：
js 复制代码
console.log(import.meta.env.VITE_SOME_KEY) // "123"
console.log(import.meta.env.DB_PASSWORD) // undefined
如果你想自定义环境变量前缀，请参阅 envPrefix 选项。 tip 环境变量解析
如上所示，VITE_SOME_KEY 是一个数字，但解析后返回字符串。布尔类型的环境变量也会发生同样的情况。请确保在代码中使用时转换为所需的类型。
::: warning 保护密钥

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

`.env` 文件

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

复制代码

.env                # 所有情况下都会加载
.env.local          # 所有情况下都会加载，被 git 忽略
.env.[mode]         # 仅在指定模式下加载
.env.[mode].local   # 仅在指定模式下加载，被 git 忽略

::: tip 环境变量加载优先级

特定模式的环境文件（例如 .env.production）将比通用环境文件（例如 .env）具有更高的优先级。

除了特定于模式的 .env.[mode] 文件外，Vite 始终会加载 .env 和 .env.local。在模式特定文件中声明的变量将优先于通用文件中的变量，但仅在 .env 或 .env.local 中定义的变量仍然会在环境中可用。

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

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

::: warning Bun 用户

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

此外，Vite 默认使用 dotenv-expand 来展开 env 文件中写入的变量。要了解更多语法，请查看他们的文档。

请注意，如果你想在环境值中使用 $，则必须使用 \ 进行转义。

[.env] 复制代码

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

::: details 反向展开变量

Vite 支持反向展开变量。例如，下面的 .env 将被求值为 VITE_FOO=foobar、VITE_BAR=bar。

[.env] 复制代码

VITE_FOO=foo${VITE_BAR}
VITE_BAR=bar

这在 shell 脚本和 docker compose 等其他工具中不适用。话虽如此，Vite 支持这种行为，因为 dotenv-expand 长期以来一直支持这种行为，而且 JavaScript 生态系统中的其他工具使用旧版本也支持这种行为。

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

::: warning 忽略本地 .env 文件

.env.*.local 文件仅限本地，可能包含敏感变量。你应该将 *.local 添加到 .gitignore 中，以避免它们被提交到 git。

TypeScript 的 IntelliSense

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

要实现这一点，你可以在 src 目录中创建一个 vite-env.d.ts 文件，然后像这样扩充 ImportMetaEnv：

typescript [vite-env.d.ts] 复制代码

interface ViteTypeOptions {
  // 通过添加这一行，你可以使 ImportMetaEnv 的类型严格化
  // 以不允许未知键。
  // strictImportMetaEnv: unknown
}

interface ImportMetaEnv {
  readonly VITE_APP_TITLE: string
  // 更多环境变量...
}

interface ImportMeta {
  readonly env: ImportMetaEnv
}

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

json [tsconfig.json] 复制代码

{
  "lib": ["WebWorker"]
}

::: warning 导入会破坏类型扩充

如果 ImportMetaEnv 扩充不起作用，请确保你的 vite-env.d.ts 中没有任何 import 语句。有关更多信息，请参阅 TypeScript 文档。

HTML 常量替换

Vite 还支持在 HTML 文件中替换常量。import.meta.env 中的任何属性都可以使用特殊的 %CONST_NAME% 语法在 HTML 文件中使用：
html 复制代码
<h1>Vite is running in %MODE%</h1>
<p>Using data from %VITE_API_URL%</p>
如果 env 不存在于 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 选项标志来覆盖命令使用的默认模式。例如，如果你希望为预发布模式构建应用：
bash 复制代码
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"

命令	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"`

命令	`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"`

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

在命令中设置 NODE_ENV=... 的主要好处是它允许 Vite 尽早检测该值。它还允许你在 Vite 配置中读取 process.env.NODE_ENV，因为 Vite 只有在配置评估后才能加载 env 文件。

:::

帮助我们改进文档

发现翻译问题或内容错误？请告诉我们。