v3.16
Nuxt on GitHub

Runtime Config

Nuxt 提供了一个运行时配置 API，用于在你的应用中暴露配置和敏感信息。

暴露配置

要在应用的其余部分暴露配置和环境变量，你需要在 nuxt.config 文件中使用 runtimeConfig 选项定义运行时配置。

nuxt.config.ts
export default defineNuxtConfig({
  runtimeConfig: {
    // 仅在服务端可用的私有键
    apiSecret: '123',
    // public 中的键也会暴露给客户端
    public: {
      apiBase: '/api'
    }
  }
})

将 apiBase 添加到 runtimeConfig.public 时，Nuxt 会将其添加到每个页面的有效负载中。我们可以在服务端和浏览器中统一访问 apiBase。

const runtimeConfig = useRuntimeConfig()

console.log(runtimeConfig.apiSecret)
console.log(runtimeConfig.public.apiBase)
公共运行时配置在 Vue 模板中可以通过 $config.public 访问。

序列化

你的运行时配置在传递给 Nitro 之前会被序列化。这意味着任何无法序列化和反序列化的内容（如函数、Set、Map 等）都不应在 nuxt.config 中设置。

与其从 nuxt.config 向应用传递不可序列化的对象或函数，你可以将这些代码放在 Nuxt 或 Nitro 的插件或中间件中。

环境变量

提供配置的最常见方式是使用环境变量。

Nuxi CLI 在开发、构建和生成时内置支持读取你的 .env 文件。但在运行构建后的服务器时，不会读取你的 .env 文件。
阅读更多 Docs > Guide > Directory Structure > Env.

运行时配置值会在运行时自动被匹配的环境变量替换。

有两个关键要求：

  1. 你希望的变量必须在你的 nuxt.config 中定义。这确保不会将任意环境变量暴露给你的应用代码。
  2. 只有特定命名的环境变量才能覆盖运行时配置属性。即，以 NUXT_ 开头的大写环境变量，并使用 _ 分隔键和大小写变化。
将 runtimeConfig 的默认值设置为不同命名的环境变量（例如将 myVar 设置为 process.env.OTHER_VARIABLE）仅在构建时有效，运行时会失败。 建议使用与 runtimeConfig 对象结构匹配的环境变量。
观看 Alexander Lichter 的视频，展示开发者在使用 runtimeConfig 时常犯的最大错误。

示例

.env
NUXT_API_SECRET=api_secret_token
NUXT_PUBLIC_API_BASE=https://nuxtjs.org
nuxt.config.ts
export default defineNuxtConfig({
  runtimeConfig: {
    apiSecret: '', // 可被 NUXT_API_SECRET 环境变量覆盖
    public: {
      apiBase: '', // 可被 NUXT_PUBLIC_API_BASE 环境变量覆盖
    }
  },
})

读取配置

Vue 应用

在 Nuxt 应用的 Vue 部分，你需要调用 useRuntimeConfig() 来访问运行时配置。

客户端和服务端的行为不同：
  • 在客户端，只有 runtimeConfig.public 和 runtimeConfig.app（Nuxt 内部使用）中的键可用，且对象是可写且响应式的。
  • 在服务端，整个运行时配置都可用，但它是只读的，以避免上下文共享。 ::
pages/index.vue
<script setup lang="ts">
const config = useRuntimeConfig()

console.log('运行时配置：', config)
if (import.meta.server) {
  console.log('API 密钥：', config.apiSecret)
}
</script>

<template>
  <div>
    <div>查看开发者控制台！</div>
  </div>
</template>
安全提示： 小心不要通过渲染或传递给 useState 将运行时配置键暴露给客户端。

插件

如果你想在任何（自定义）插件中使用运行时配置，可以在 defineNuxtPlugin 函数中使用 useRuntimeConfig()。
plugins/config.ts
export default defineNuxtPlugin((nuxtApp) => {
  const config = useRuntimeConfig()

  console.log('API 基础 URL：', config.public.apiBase)
});

服务器路由

你也可以在服务器路由中使用 useRuntimeConfig 访问运行时配置。
server/api/test.ts
export default defineEventHandler(async (event) => {
  const { apiSecret } = useRuntimeConfig(event)
  const result = await $fetch('https://my.api.com/test', {
    headers: {
      Authorization: `Bearer ${apiSecret}`
    }
  })
  return result
})
将 event 作为参数传递给 useRuntimeConfig 是可选的，但建议传递它，以获取在服务器路由运行时由环境变量覆盖的运行时配置。

类型化运行时配置

Nuxt 会尝试使用 unjs/untyped 从提供的运行时配置自动生成 TypeScript 接口。但你也可以手动为运行时配置定义类型：
index.d.ts
declare module 'nuxt/schema' {
  interface RuntimeConfig {
    apiSecret: string
  }
  interface PublicRuntimeConfig {
    apiBase: string
  }
}
// 增强类型时，始终确保导入/导出一个内容
export {}
nuxt/schema 是为最终用户提供的便利，方便访问项目中使用的 Nuxt 模式版本。模块作者应改为增强 @nuxt/schema。