自定义应用 (Custom App)

Next.js 使用 App 组件来初始化页面。您可以覆盖它并控制页面初始化，实现以下功能：

在页面切换时创建共享布局
向页面注入额外数据
添加全局 CSS

使用方法

要覆盖默认的 App，请按以下方式创建 pages/_app 文件：

import type { AppProps } from 'next/app'

export default function MyApp({ Component, pageProps }: AppProps) {
  return <Component {...pageProps} />
}

Component 属性表示当前活动的 page，因此在路由切换时，Component 会更新为新的 page。您传递给 Component 的任何属性都会被页面接收。

pageProps 是一个对象，包含通过数据获取方法为页面预加载的初始属性，如果没有预加载数据则为空对象。

须知

如果应用正在运行且您添加了自定义 App，需要重启开发服务器。仅当原先不存在 pages/_app.js 时才需要此操作。

App 不支持 Next.js 的数据获取方法，例如 getStaticProps 或 getServerSideProps。

在 `App` 中使用 `getInitialProps`

在 App 中使用 getInitialProps 会禁用没有 getStaticProps 的页面的自动静态优化 (Automatic Static Optimization)。

我们不推荐使用此模式。建议考虑渐进式迁移到 App Router，它能更便捷地为页面和布局获取数据。

import App, { AppContext, AppInitialProps, AppProps } from 'next/app'

type AppOwnProps = { example: string }

export default function MyApp({
  Component,
  pageProps,
  example,
}: AppProps & AppOwnProps) {
  return (
    <>
      <p>Data: {example}</p>
      <Component {...pageProps} />
    </>
  )
}

MyApp.getInitialProps = async (
  context: AppContext
): Promise<AppOwnProps & AppInitialProps> => {
  const ctx = await App.getInitialProps(context)

  return { ...ctx, example: 'data' }
}

使用方法

在 App 中使用 getInitialProps

On this page

在 `App` 中使用 `getInitialProps`