How to use environment variables in Next.js

Next.js 内置了对环境变量的支持，允许你执行以下操作：

• 使用 .env 加载环境变量
• 通过添加 NEXT_PUBLIC_ 前缀为浏览器打包环境变量

警告： 默认的 create-next-app 模板确保所有 .env 文件都添加到你的 .gitignore 中。你几乎永远不会想把这些文件提交到你的代码库中。

Loading Environment Variables

Next.js 内置了支持从 .env* 文件加载环境变量到 process.env 的功能。

DB_HOST=localhost
DB_USER=myuser
DB_PASS=mypassword

这会自动将 process.env.DB_HOST、process.env.DB_USER 和 process.env.DB_PASS 加载到 Node.js 环境中，使你可以在 Next.js 数据获取方法 和 API 路由 中使用它们。

例如，使用 getStaticProps：

export async function getStaticProps() {
  const db = await myDB.connect({
    host: process.env.DB_HOST,
    username: process.env.DB_USER,
    password: process.env.DB_PASS,
  })
  // ...
}

Loading Environment Variables with @next/env

如果你需要在 Next.js 运行时之外加载环境变量，例如在 ORM 或测试运行器的根配置文件中，你可以使用 @next/env 包。

这个包被 Next.js 内部用来从 .env* 文件加载环境变量。

要使用它，安装该包并使用 loadEnvConfig 函数加载环境变量：

npm install @next/env

import { loadEnvConfig } from '@next/env'
 
const projectDir = process.cwd()
loadEnvConfig(projectDir)

然后，你可以在需要的地方导入配置。例如：

import './envConfig.ts'
 
export default defineConfig({
  dbCredentials: {
    connectionString: process.env.DATABASE_URL!,
  },
})

Referencing Other Variables

Next.js 将自动展开在 .env* 文件中使用 $ 引用其他变量的变量，例如 $VARIABLE。这允许你引用其他密钥。例如：

TWITTER_USER=nextjs
TWITTER_URL=https://x.com/$TWITTER_USER

在上面的例子中，process.env.TWITTER_URL 将被设置为 https://x.com/nextjs。

值得注意的是：如果你需要在实际值中使用带有 $ 的变量，需要进行转义，例如 \$。

Bundling Environment Variables for the Browser

非 NEXT_PUBLIC_ 环境变量仅在 Node.js 环境中可用，这意味着它们不能被浏览器访问（客户端在不同的_环境_中运行）。

为了使环境变量的值在浏览器中可访问，Next.js 可以在构建时将值"内联"到传递给客户端的 js 包中，用硬编码值替换所有对 process.env.[variable] 的引用。要实现这一点，你只需要在变量前加上 NEXT_PUBLIC_ 前缀。例如：

NEXT_PUBLIC_ANALYTICS_ID=abcdefghijk

这将告诉 Next.js 用你运行 next build 的环境中的值替换 Node.js 环境中所有对 process.env.NEXT_PUBLIC_ANALYTICS_ID 的引用，允许你在代码的任何地方使用它。它将被内联到发送给浏览器的任何 JavaScript 中。

注意：构建完成后，你的应用将不再响应这些环境变量的变化。例如，如果你使用 Heroku 管道将在一个环境中构建的 slug 推广到另一个环境，或者如果你构建并部署单个 Docker 镜像到多个环境，所有 NEXT_PUBLIC_ 变量将被冻结为构建时评估的值，因此这些值需要在项目构建时适当设置。如果你需要访问运行时环境值，你需要设置自己的 API 来向客户端提供它们（按需或在初始化期间）。

import setupAnalyticsService from '../lib/my-analytics-service'
 
// 'NEXT_PUBLIC_ANALYTICS_ID' can be used here as it's prefixed by 'NEXT_PUBLIC_'.
// It will be transformed at build time to `setupAnalyticsService('abcdefghijk')`.
setupAnalyticsService(process.env.NEXT_PUBLIC_ANALYTICS_ID)
 
function HomePage() {
  return <h1>Hello World</h1>
}
 
export default HomePage

注意，动态查找将_不会_被内联，例如：

// This will NOT be inlined, because it uses a variable
const varName = 'NEXT_PUBLIC_ANALYTICS_ID'
setupAnalyticsService(process.env[varName])
 
// This will NOT be inlined, because it uses a variable
const env = process.env
setupAnalyticsService(env.NEXT_PUBLIC_ANALYTICS_ID)

Runtime Environment Variables

Next.js 可以同时支持构建时和运行时环境变量。

默认情况下，环境变量只在服务器上可用。要将环境变量暴露给浏览器，必须添加 NEXT_PUBLIC_ 前缀。然而，这些公共环境变量将在 next build 期间内联到 JavaScript 包中。

要读取运行时环境变量，我们建议使用 getServerSideProps 或逐步采用 App Router。

这允许你使用单个 Docker 镜像，可以在具有不同值的多个环境中推广使用。

值得注意的是：

• 你可以使用 register 函数 在服务器启动时运行代码。
• 我们不建议使用 runtimeConfig 选项，因为这不适用于独立输出模式。相反，如果你需要此功能，我们建议逐步采用 App Router。

Test Environment Variables

除了 development 和 production 环境外，还有第三个选项：test。与为开发或生产环境设置默认值的方式相同，你也可以使用 .env.test 文件为 testing 环境做同样的事情（尽管这个不像前两个那样常见）。Next.js 在 testing 环境中不会从 .env.development 或 .env.production 加载环境变量。

当使用 jest 或 cypress 等工具运行测试时，这个方法很有用，因为你需要仅为测试目的设置特定的环境变量。如果 NODE_ENV 设置为 test，将加载测试默认值，不过你通常不需要手动执行此操作，因为测试工具会为你处理。

test 环境与 development 和 production 环境之间有一个小区别，你需要记住：.env.local 不会被加载，因为你希望测试对每个人产生相同的结果。这样，每次测试执行都将使用相同的环境默认值，而忽略你的 .env.local（它的目的是覆盖默认设置）。

值得注意的是：与默认环境变量类似，.env.test 文件应该包含在你的代码库中，但 .env.test.local 不应该，因为 .env*.local 应该通过 .gitignore 被忽略。

在运行单元测试时，你可以通过利用 @next/env 包中的 loadEnvConfig 函数，确保以与 Next.js 相同的方式加载环境变量。

// The below can be used in a Jest global setup file or similar for your testing set-up
import { loadEnvConfig } from '@next/env'
 
export default async () => {
  const projectDir = process.cwd()
  loadEnvConfig(projectDir)
}

Environment Variable Load Order

环境变量按以下顺序在以下位置查找，一旦找到变量就停止。

1. process.env
2. .env.$(NODE_ENV).local
3. .env.local（当 NODE_ENV 为 test 时不检查。）
4. .env.$(NODE_ENV)
5. .env

例如，如果 NODE_ENV 是 development，并且你在 .env.development.local 和 .env 中都定义了一个变量，将使用 .env.development.local 中的值。

值得注意的是：NODE_ENV 允许的值是 production、development 和 test。

Good to know

• 如果你使用 /src 目录，.env.* 文件应保留在项目的根目录中。
• 如果环境变量 NODE_ENV 未分配，Next.js 在运行 next dev 命令时自动分配 development，或者在所有其他命令中分配 production。

Version History