如何在 Next.js 中使用环境变量

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

使用 .env 文件加载环境变量
通过前缀 NEXT_PUBLIC_ 将环境变量捆绑到浏览器

警告： 默认的 create-next-app 模板确保所有 .env 文件都已添加到您的 .gitignore 中。您几乎从不希望将这些文件提交到您的仓库。

加载环境变量

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

DB_HOST=localhost
DB_USER=myuser
DB_PASS=mypassword

注意：Next.js 也支持 .env* 文件中的多行变量

# .env
 
# you can write with line breaks
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
...
Kh9NV...
...
-----END DSA PRIVATE KEY-----"
 
# or with `\n` inside double quotes
PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\nKh9NV...\n-----END DSA PRIVATE KEY-----\n"

注意：如果您正在使用 /src 文件夹，请注意 Next.js 将只从父文件夹加载 .env 文件，而不从 /src 文件夹加载。这将自动将 process.env.DB_HOST、process.env.DB_USER 和 process.env.DB_PASS 加载到 Node.js 环境中，允许您在路由处理程序中使用它们。

例如

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

使用 `@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!,
  },
})

引用其他变量

Next.js 将自动展开在 .env* 文件中使用 $ 引用其他变量（例如 $VARIABLE）的变量。这允许您引用其他秘密。例如

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

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

须知：如果您需要在实际值中使用带有 $ 的变量，则需要对其进行转义，例如 \$。

为浏览器捆绑环境变量

非 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)

运行时环境变量

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

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

您可以在动态渲染期间安全地在服务器上读取环境变量

import { connection } from 'next/server'
 
export default async function Component() {
  await connection()
  // cookies, headers, and other Dynamic APIs
  // will also opt into dynamic rendering, meaning
  // this env variable is evaluated at runtime
  const value = process.env.MY_VALUE
  // ...
}

这允许您使用单个 Docker 镜像，该镜像可以通过具有不同值的多个环境进行推广。

须知

您可以使用register 函数在服务器启动时运行代码。

测试环境变量

除了 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)
}

环境变量加载顺序

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

process.env
.env.$(NODE_ENV).local
.env.local（当 NODE_ENV 为 test 时不检查。）
.env.$(NODE_ENV)
.env

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

须知：NODE_ENV 允许的值是 production、development 和 test。

须知

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

版本历史

版本	更改
`v9.4.0`	引入了对 `.env` 和 `NEXT_PUBLIC_` 的支持。