Menu

运行时配置

警告:

要为你的应用添加运行时配置,打开 next.config.js 并添加 publicRuntimeConfigserverRuntimeConfig 配置:

next.config.js
module.exports = {
  serverRuntimeConfig: {
    // 仅在服务器端可用
    mySecret: 'secret',
    secondSecret: process.env.SECOND_SECRET, // 传递环境变量
  },
  publicRuntimeConfig: {
    // 在服务器和客户端都可用
    staticFolder: '/static',
  },
}

将任何仅服务器端的运行时配置放在 serverRuntimeConfig 下。

任何客户端和服务器端代码都可以访问的配置应放在 publicRuntimeConfig 下。

依赖 publicRuntimeConfig 的页面必须使用 getInitialPropsgetServerSideProps,或者你的应用必须有一个带有 getInitialProps自定义 App 以选择退出自动静态优化。如果没有服务器端渲染,运行时配置将不可用于任何页面(或页面中的组件)。

要在你的应用中访问运行时配置,使用 next/config,如下所示:

import getConfig from 'next/config'
import Image from 'next/image'
 
// 仅包含 serverRuntimeConfig 和 publicRuntimeConfig
const { serverRuntimeConfig, publicRuntimeConfig } = getConfig()
// 仅在服务器端可用
console.log(serverRuntimeConfig.mySecret)
// 在服务器端和客户端都可用
console.log(publicRuntimeConfig.staticFolder)
 
function MyImage() {
  return (
    <div>
      <Image
        src={`${publicRuntimeConfig.staticFolder}/logo.png`}
        alt="logo"
        layout="fill"
      />
    </div>
  )
}
 
export default MyImage