Lzh on GitHub

.env

.env 文件指定你的构建/开发时环境变量。

此文件应添加到你的 .gitignore 文件中,以避免将密钥推送到你的存储库。

开发、构建和生成时

Nuxt CLI 在开发模式以及运行 nuxi buildnuxi generate 时内置了 dotenv 支持。

除了任何进程环境变量之外,如果你的项目根目录中有一个 .env 文件,它将 在开发、构建和生成时自动加载。在那里设置的任何环境变量都可以在你的 nuxt.config 文件和模块中访问。

.env
MY_ENV_VARIABLE=hello
请注意,从 .env 中删除变量或完全删除 .env 文件不会取消已设置的值。

自定义文件

如果你想使用不同的文件(例如,使用 .env.local.env.production),你可以在使用 nuxi 时传递 --dotenv 标志来做到这一点。

Terminal
npx nuxi dev --dotenv .env.local

在开发模式下更新 .env 时,Nuxt 实例会自动重启以将新值应用于 process.env

在你的应用程序代码中,你应该使用 运行时配置 而不是普通的 env 变量。

生产环境

在你的服务器构建完成后,你需要负责在运行服务器时设置环境变量。

此时不会读取你的 .env 文件。具体的操作方式因环境而异。

做出此设计决策是为了确保跨各种部署环境的兼容性,其中一些环境可能没有可用的传统文件系统,例如无服务器平台或 Cloudflare Workers 等边缘网络。

由于 .env 文件在生产环境中不使用,你必须使用托管环境提供的工具和方法显式设置环境变量。以下是一些常见方法:

  • 你可以使用终端将环境变量作为参数传递:
    $ DATABASE_HOST=mydatabaseconnectionstring node .output/server/index.mjs
  • 你可以在 shell 配置文件(如 .bashrc.profile)中设置环境变量。
  • 许多云服务提供商(如 Vercel、Netlify 和 AWS)都提供了通过其仪表板、CLI 工具或配置文件设置环境变量的界面。

生产环境预览

为了进行本地生产环境预览,我们建议使用 nuxi preview,因为使用此命令时,为了方便起见,.env 文件将被加载到 process.env 中。请注意,此命令需要在包目录中安装依赖项。

或者,你可以使用终端将环境变量作为参数传递。例如,在 Linux 或 macOS 上:

Terminal
DATABASE_HOST=mydatabaseconnectionstring node .output/server/index.mjs

请注意,对于纯静态站点,在你的项目预渲染后无法设置运行时配置。

Read more in Docs > Guide > Going Further > Runtime Config.
如果你想使用在构建时设置的环境变量,但不关心后续更新这些变量(或者只需要在你的应用程序内部被动地更新它们),那么 appConfig 可能是更好的选择。你可以在 nuxt.config 中(使用环境变量)以及项目中的 ~/app.config.ts 文件中定义 appConfig
Read more in Docs > Guide > Directory Structure > App Config.