环境变量和模式

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

内置常量

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

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 会被暴露为 import.meta.env.VITE_SOME_KEY 提供给客户端源码，而 DB_PASSWORD 则不会。

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

环境变量解析

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

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

环境加载优先级

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

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

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

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

此外，Vite 使用 dotenv-expand 来扩展在 env 文件中编写的变量。想要了解更多相关语法，请查看它们的文档。

请注意，如果想要在环境变量中使用 $ 符号，则必须使用 \ 对其进行转义。

.env

安全注意事项

.env.*.local 文件应是本地的，可以包含敏感变量。你应该将 *.local 添加到你的 .gitignore 中，以避免它们被 git 检入。
由于任何暴露给 Vite 源码的变量最终都将出现在客户端包中， VITE_* 变量应该不包含任何敏感信息。

反向扩展变量

Vite 支持以相反的顺序扩展变量。例如，下面的 .env 将被评估为 VITE_FOO=foobar , VITE_BAR=bar 。

.env

这在 shell 脚本和其他工具（如 docker-compose ）中不起作用。不过，Vite 支持这种行为，因为 dotenv-expand 已经支持这种行为很长时间了，JavaScript 生态系统中的其他工具也使用支持这种行为的旧版本。

为避免出现互操作问题，建议避免依赖这种行为。今后，Vite 可能会对这种行为发出警告。

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

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

vite-env.d.ts

如果你的代码依赖于浏览器环境的类型，比如 DOM 和 WebWorker ，你可以在 tsconfig.json 中修改 lib 字段来获取类型支持。

tsconfig.json