环境变量和模式

Vite 在特殊的 import.meta.env 对象下暴露了一些常量。这些常量在开发阶段被定义为全局变量，并在构建阶段被静态替换，以使树摇（tree-shaking）更有效。

示例

if (import.meta.env.DEV) {
  // 这里的代码在生产构建中会被 tree-shaking 优化掉
  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} 应用是否运行在 server 上。

环境变量

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                # 所有情况下都会加载
.env.local          # 所有情况下都会加载，但会被 git 忽略
.env.[mode]         # 只在指定模式下加载
.env.[mode].local   # 只在指定模式下加载，但会被 git 忽略

环境加载优先级

一份用于指定模式的文件（例如 .env.production）会比通用文件的优先级更高（例如 .env）。

Vite 总是会加载 .env 和 .env.local 文件，除此之外还会加载模式特定的 .env.[mode] 文件。在模式特定文件中声明的变量优先级高于通用文件中的变量，但仅在 .env 或 .env.local 中定义的变量仍然可以在环境中使用。

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

.env 类文件会在 Vite 启动一开始时被加载，而改动会在重启服务器后生效。

Bun 用户

使用 Bun 时，请注意 Bun 会在脚本运行前自动加载 .env 文件。此内置行为会将环境变量直接加载到 process.env 中，并且可能会干扰 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

反向扩展变量

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 可能会对这种行为发出警告。

忽略本地 .env 文件

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

TypeScript 的智能提示

默认情况下，Vite 在 vite/client.d.ts 中为 import.meta.env 提供了类型定义。随着在 .env[mode] 文件中自定义了越来越多的环境变量，你可能想要在代码中获取这些以 VITE_ 为前缀的用户自定义环境变量的 TypeScript 智能提示。

要想做到这一点，你可以在 src 目录下创建一个 vite-env.d.ts 文件，接着按下面这样增加 ImportMetaEnv 的定义：

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 字段来获取类型支持。

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 不同，JS 中会被替换为 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 和模式：

Command	NODE_ENV	Mode
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 属性上：

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

Command	import.meta.env.MODE
--mode production	"production"
--mode development	"development"
--mode staging	"staging"

.env 文件中的 NODE_ENV

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

命令中使用 NODE_ENV=... 的主要好处是，它允许 Vite 提前检测到该值。这也使你能够在 Vite 配置中读取 process.env.NODE_ENV，因为 Vite 只有在解析配置之后才能加载环境变量文件。