环境变量和模式

环境变量

Vite 在特殊的 **import.meta.env** 对象上公开环境变量，这些变量在构建时会静态替换。某些内置变量在所有情况下都可用

• **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} 应用是否在 服务器 上运行。

.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 启动时加载。更改后重新启动服务器。

加载的环境变量也作为字符串通过 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

环境解析

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

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

请注意，如果要在环境值内部使用 $，则必须使用 \ 对其进行转义。

.env

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

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

安全注意事项

• .env.*.local 文件仅限本地使用，可以包含敏感变量。您应该将 *.local 添加到您的 .gitignore 中，以避免将其检入 git。

• 由于公开到 Vite 源代码的任何变量最终都会出现在您的客户端捆绑包中，因此 VITE_* 变量**不应**包含任何敏感信息。

TypeScript 的 IntelliSense

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

为此，您可以在 src 目录中创建一个 vite-env.d.ts，然后像这样增强 ImportMetaEnv

vite-env.d.ts

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

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 文件中使用特殊的 %ENV_NAME% 语法

<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 被许多框架使用，因此它有意不对诸如条件语句之类的复杂替换发表意见。可以使用 现有的用户端插件 或实现 transformIndexHtml 钩子 的自定义插件来扩展 Vite。

模式

默认情况下，开发服务器（dev 命令）在 development 模式下运行，而 build 命令在 production 模式下运行。

这意味着当运行 vite build 时，如果存在 .env.production，它将加载其中的环境变量。

# .env.production
VITE_APP_TITLE=My App

在您的应用中，您可以使用 import.meta.env.VITE_APP_TITLE 渲染标题。

在某些情况下，您可能希望使用不同的模式运行 vite build 以渲染不同的标题。可以通过传递 --mode 选项标志来覆盖命令使用的默认模式。例如，如果要为暂存模式构建应用

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

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

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