环境变量和模式

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

内置常量

在所有情况下都可以使用一些内置常量

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

• 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 会作为 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

如果你想自定义环境变量前缀，请参阅 envPrefix 选项。

环境变量解析

如上所示，VITE_SOME_KEY 是一个数字，但在解析时返回一个字符串。布尔环境变量也会发生同样的情况。确保在使用时转换为所需的类型。

.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 文件（例如 .env.production）将比通用文件（例如 .env）具有更高的优先级。

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

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

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

此外，Vite 使用 dotenv-expand 开箱即用地扩展 env 文件中编写的变量。要了解有关语法的更多信息，请查看他们的文档。

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

.env

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

安全注意事项

• .env.*.local 文件是本地专用的，可能包含敏感变量。你应该将 *.local 添加到你的 .gitignore 以避免将它们检入 git。

• 由于暴露给你的 Vite 源代码的任何变量最终都会出现在你的客户端包中，因此 VITE_* 变量不应包含任何敏感信息。

反向顺序展开变量

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 将来可能会开始为此行为发出警告。

TypeScript 的智能提示

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

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

vite-env.d.ts

/// <reference types="vite/client" />

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 中的任何属性都可以在 HTML 文件中使用特殊的 %CONST_NAME% 语法

<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 可以使用 现有的 userland 插件或实现 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 文件中设置。如果在 .env.[mode] 文件中指定了 NODE_ENV，则可以使用模式来控制其值。但是，NODE_ENV 和模式仍然是两个不同的概念。

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