logoNext.js 简体中文
文档博客学习
简介/指南/迁移指南/App Router

如何从 Pages Router 迁移到 App Router

本指南将帮助您：

升级步骤

Node.js 版本要求

最低 Node.js 版本要求为 v18.17。更多信息请参阅 Node.js 文档。

Next.js 版本升级

要升级到 Next.js 13 版本，请使用您偏好的包管理器运行以下命令：

终端
npm install next@latest react@latest react-dom@latest

ESLint 版本升级

如果您使用 ESLint，需要升级 ESLint 版本：

终端
npm install -D eslint-config-next@latest

须知：您可能需要重启 VS Code 中的 ESLint 服务器才能使更改生效。打开命令面板（Mac 上是 cmd+shift+p；Windows 上是 ctrl+shift+p）并搜索 ESLint: Restart ESLint Server。

后续步骤

升级完成后，请参考以下部分进行后续操作：

升级新功能

Next.js 13 引入了新的 App Router，包含新功能和约定。新 Router 位于 app 目录中，与 pages 目录共存。

升级到 Next.js 13 不要求必须使用 App Router。您可以继续使用 pages 目录，同时享受适用于两个目录的新功能，例如更新的 Image 组件、Link 组件、Script 组件 和 字体优化。

<Image/> 组件

Next.js 12 通过临时导入 next/future/image 对 Image 组件进行了改进。这些改进包括减少客户端 JavaScript、更简单的图像扩展和样式设置、更好的可访问性以及原生浏览器懒加载。

在版本 13 中，这些新行为已成为 next/image 的默认设置。

有两个代码修改工具可帮助您迁移到新的 Image 组件：

<Link> 组件 不再需要手动添加 <a> 标签作为子元素。此行为在 12.2 版本 中作为实验性选项添加，现已成为默认设置。在 Next.js 13 中，<Link> 始终渲染 <a> 并允许您将属性传递给底层标签。

例如：

import Link from 'next/link'

// Next.js 12: `<a>` 必须嵌套，否则会被排除
<Link href="/about">
  <a>About</a>
</Link>

// Next.js 13: `<Link>` 始终在底层渲染 `<a>`
<Link href="/about">
  About
</Link>

要将链接升级到 Next.js 13，可以使用 new-link 代码修改工具。

<Script> 组件

next/script 的行为已更新以支持 pages 和 app，但需要进行一些更改以确保顺利迁移：

  • 将之前包含在 _document.js 中的任何 beforeInteractive 脚本移动到根布局文件（app/layout.tsx）。
  • 实验性的 worker 策略尚不适用于 app，使用此策略的脚本必须移除或修改为使用其他策略（例如 lazyOnload）。
  • onLoad、onReady 和 onError 处理程序在服务端组件中不起作用，因此请确保将它们移动到 客户端组件 或完全移除。

字体优化

之前，Next.js 通过 内联字体 CSS 帮助优化字体。版本 13 引入了新的 next/font 模块，使您能够自定义字体加载体验，同时仍确保出色的性能和隐私。next/font 同时支持 pages 和 app 目录。

虽然 内联 CSS 在 pages 中仍然有效，但在 app 中不起作用。您应改用 next/font。

参阅 字体优化 页面了解如何使用 next/font。

从 pages 迁移到 app

🎥 观看视频：学习如何逐步采用 App Router → YouTube (16 分钟)。

迁移到 App Router 可能是首次使用 Next.js 构建的 React 功能，如服务端组件、Suspense 等。当与新的 Next.js 功能（如 特殊文件 和 布局）结合时，迁移意味着需要学习新概念、思维模型和行为变化。

我们建议通过将迁移分解为更小的步骤来降低这些更新的综合复杂性。app 目录的设计初衷是与 pages 目录同时工作，以实现逐页迁移。

  • app 目录支持嵌套路由 和 布局。了解更多。
  • 使用嵌套文件夹定义路由，并使用特殊的 page.js 文件使路由段公开可访问。了解更多。
  • 特殊文件约定 用于为每个路由段创建 UI。最常见的特殊文件是 page.js 和 layout.js。
    • 使用 page.js 定义特定于路由的 UI。
    • 使用 layout.js 定义跨多个路由共享的 UI。
    • 特殊文件可以使用 .js、.jsx 或 .tsx 文件扩展名。
  • 您可以在 app 目录中放置其他文件，如组件、样式、测试等。了解更多。
  • 数据获取函数如 getServerSideProps 和 getStaticProps 已被 app 中的 新 API 取代。getStaticPaths 已被 generateStaticParams 取代。
  • pages/_app.js 和 pages/_document.js 已被单个 app/layout.js 根布局取代。了解更多。
  • pages/_error.js 已被更细粒度的 error.js 特殊文件取代。了解更多。
  • pages/404.js 已被 not-found.js 文件取代。
  • pages/api/* API 路由已被 route.js（路由处理程序）特殊文件取代。

步骤 1：创建 app 目录

更新到最新的 Next.js 版本（需要 13.4 或更高版本）：

npm install next@latest

然后，在项目根目录（或 src/ 目录）下创建一个新的 app 目录。

步骤 2：创建根布局

在 app 目录中创建一个新的 app/layout.tsx 文件。这是一个 根布局，将应用于 app 内的所有路由。

export default function RootLayout({
  // 布局必须接受 children 属性。
  // 这将填充嵌套布局或页面
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <body>{children}</body>
    </html>
  )
}
  • app 目录 必须 包含一个根布局。
  • 根布局必须定义 <html> 和 <body> 标签，因为 Next.js 不会自动创建它们。
  • 根布局取代了 pages/_app.tsx 和 pages/_document.tsx 文件。
  • 布局文件可以使用 .js、.jsx 或 .tsx 扩展名。

要管理 <head> HTML 元素，可以使用 内置的 SEO 支持：

import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: 'Home',
  description: 'Welcome to Next.js',
}

迁移 _document.js 和 _app.js

如果您有现有的 _app 或 _document 文件，可以将内容（例如全局样式）复制到根布局（app/layout.tsx）。app/layout.tsx 中的样式 不会 应用于 pages/*。您应保留 _app/_document 以防止 pages/* 路由中断。完全迁移后，可以安全删除它们。

如果使用任何 React Context 提供程序，需要将它们移动到 客户端组件。

将 getLayout() 模式迁移到布局（可选）

Next.js 建议在 pages 目录中为页面组件添加 属性 以实现每页布局。此模式可被 app 目录中对 嵌套布局 的原生支持取代。

查看前后示例

迁移前

components/DashboardLayout.js
export default function DashboardLayout({ children }) {
  return (
    <div>
      <h2>My Dashboard</h2>
      {children}
    </div>
  )
}
pages/dashboard/index.js
import DashboardLayout from '../components/DashboardLayout'

export default function Page() {
  return <p>My Page</p>
}

Page.getLayout = function getLayout(page) {
  return <DashboardLayout>{page}</DashboardLayout>
}

迁移后

  • 从 pages/dashboard/index.js 中移除 Page.getLayout 属性，并按照 迁移页面的步骤 迁移到 app 目录。

    app/dashboard/page.js
    export default function Page() {
  return <p>My Page</p>
}

  • 将 DashboardLayout 的内容移动到新的 客户端组件 以保留 pages 目录的行为。

    app/dashboard/DashboardLayout.js
    'use client' // 此指令应位于文件顶部，任何导入之前。

// 这是一个客户端组件
export default function DashboardLayout({ children }) {
  return (
    <div>
      <h2>My Dashboard</h2>
      {children}
    </div>
  )
}

  • 将 DashboardLayout 导入到 app 目录中的新 layout.js 文件。

    app/dashboard/layout.js
    import DashboardLayout from './DashboardLayout'

// 这是一个服务端组件
export default function Layout({ children }) {
  return <DashboardLayout>{children}</DashboardLayout>
}

  • 您可以逐步将 DashboardLayout.js（客户端组件）中的非交互部分移动到 layout.js（服务端组件），以减少发送到客户端的组件 JavaScript 量。

步骤 3：迁移 next/head

在 pages 目录中，next/head React 组件用于管理 <head> HTML 元素，如 title 和 meta。在 app 目录中，next/head 被新的 内置 SEO 支持 取代。

迁移前：

import Head from 'next/head'

export default function Page() {
  return (
    <>
      <Head>
        <title>My page title</title>
      </Head>
    </>
  )
}

迁移后：

import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: 'My Page Title',
}

export default function Page() {
  return '...'
}

查看所有元数据选项。

步骤 4：迁移页面

我们建议将页面迁移分为两个主要步骤：

  1. 第一步：将默认导出的页面组件移至新的客户端组件中。
  2. 第二步：将新的客户端组件导入到 app 目录中的新 page.js 文件。

须知：这是最简单的迁移路径，因为其行为与 pages 目录最为相似。

第一步：创建新的客户端组件

  • 在 app 目录中创建一个新文件（例如 app/home-page.tsx 或类似名称），导出客户端组件。要定义客户端组件，需在文件顶部（任何导入之前）添加 'use client' 指令。
    • 与 Pages Router 类似，存在一个优化步骤，用于在初始页面加载时将客户端组件预渲染为静态 HTML。
  • 将 pages/index.js 中的默认导出页面组件移至 app/home-page.tsx。
'use client'

// 这是一个客户端组件（与 `pages` 目录中的组件相同）
// 它通过 props 接收数据，可以访问状态和副作用，
// 并在初始页面加载时在服务端预渲染。
export default function HomePage({ recentPosts }) {
  return (
    <div>
      {recentPosts.map((post) => (
        <div key={post.id}>{post.title}</div>
      ))}
    </div>
  )
}

第二步：创建新页面

  • 在 app 目录中创建新的 app/page.tsx 文件。默认情况下，这是一个服务端组件。

  • 将 home-page.tsx 客户端组件导入到页面中。

  • 如果在 pages/index.js 中获取数据，请将数据获取逻辑直接移至服务端组件，使用新的数据获取 API。详情请参阅数据获取升级指南。

    // 导入你的客户端组件
import HomePage from './home-page'

async function getPosts() {
  const res = await fetch('https://...')
  const posts = await res.json()
  return posts
}

export default async function Page() {
  // 直接在服务端组件中获取数据
  const recentPosts = await getPosts()
  // 将获取的数据传递给客户端组件
  return <HomePage recentPosts={recentPosts} />
}

  • 如果之前的页面使用了 useRouter，则需要更新为新的路由钩子。了解更多。

  • 启动开发服务器并访问 http://localhost:3000。你应该能看到现有的索引路由，现在通过 app 目录提供服务。

步骤 5：迁移路由钩子

新增了一个路由器以支持 app 目录中的新行为。

在 app 目录中，应使用从 next/navigation 导入的三个新钩子：useRouter()、usePathname() 和 useSearchParams()。

  • 新的 useRouter 钩子从 next/navigation 导入，其行为与从 next/router 导入的 pages 中的 useRouter 钩子不同。
  • 新的 useRouter 不返回 pathname 字符串。请改用单独的 usePathname 钩子。
  • 新的 useRouter 不返回 query 对象。搜索参数和动态路由参数现在是分开的。请改用 useSearchParams 和 useParams 钩子。
  • 可以结合使用 useSearchParams 和 usePathname 来监听页面变化。详情请参阅路由事件部分。
  • 这些新钩子仅在客户端组件中受支持，不能在服务端组件中使用。
'use client'

import { useRouter, usePathname, useSearchParams } from 'next/navigation'

export default function ExampleClientComponent() {
  const router = useRouter()
  const pathname = usePathname()
  const searchParams = useSearchParams()

  // ...
}

此外，新的 useRouter 钩子还有以下变更：

  • 移除了 isFallback，因为 fallback 已被替换。
  • 移除了 locale、locales、defaultLocales、domainLocales 值，因为 app 目录中不再需要 Next.js 的内置 i18n 功能。了解更多关于 i18n。
  • 移除了 basePath。替代方案将不属于 useRouter，目前尚未实现。
  • 移除了 asPath，因为新路由器中移除了 as 的概念。
  • 移除了 isReady，因为它不再必要。在静态渲染 (static rendering)期间，任何使用 useSearchParams() 钩子的组件将跳过预渲染步骤，改为在运行时在客户端渲染。
  • 移除了 route。可以使用 usePathname 或 useSelectedLayoutSegments() 作为替代。

查看 useRouter() API 参考。

在 pages 和 app 之间共享组件

为了使组件在 pages 和 app 路由器之间兼容，请参考从 next/compat/router 导入的 useRouter 钩子。 这是 pages 目录中的 useRouter 钩子，但旨在用于在路由器之间共享组件。准备仅在 app 路由器中使用时，请更新为新的从 next/navigation 导入的 useRouter。

步骤 6：迁移数据获取方法

pages 目录使用 getServerSideProps 和 getStaticProps 为页面获取数据。在 app 目录中，这些旧的数据获取函数被替换为基于 fetch() 和异步 React 服务端组件的更简单 API。

export default async function Page() {
  // 此请求应缓存直到手动失效。
  // 类似于 `getStaticProps`。
  // `force-cache` 是默认值，可以省略。
  const staticData = await fetch(`https://...`, { cache: 'force-cache' })

  // 此请求应在每次请求时重新获取。
  // 类似于 `getServerSideProps`。
  const dynamicData = await fetch(`https://...`, { cache: 'no-store' })

  // 此请求应缓存 10 秒。
  // 类似于带 `revalidate` 选项的 `getStaticProps`。
  const revalidatedData = await fetch(`https://...`, {
    next: { revalidate: 10 },
  })

  return <div>...</div>
}

服务端渲染 (getServerSideProps)

在 pages 目录中，getServerSideProps 用于在服务端获取数据并将 props 传递给文件中的默认导出 React 组件。页面的初始 HTML 由服务端预渲染，随后在浏览器中“水合”（使其可交互）。

pages/dashboard.js
// `pages` 目录

export async function getServerSideProps() {
  const res = await fetch(`https://...`)
  const projects = await res.json()

  return { props: { projects } }
}

export default function Dashboard({ projects }) {
  return (
    <ul>
      {projects.map((project) => (
        <li key={project.id}>{project.name}</li>
      ))}
    </ul>
  )
}

在 App Router 中，我们可以使用服务端组件 (Server Components) 将数据获取逻辑与 React 组件放在一起。这样可以减少发送到客户端的 JavaScript，同时保留服务端渲染的 HTML。

通过将 cache 选项设置为 no-store，我们可以指示获取的数据应永不缓存。这与 pages 目录中的 getServerSideProps 类似。

// `app` 目录

// 此函数可以任意命名
async function getProjects() {
  const res = await fetch(`https://...`, { cache: 'no-store' })
  const projects = await res.json()

  return projects
}

export default async function Dashboard() {
  const projects = await getProjects()

  return (
    <ul>
      {projects.map((project) => (
        <li key={project.id}>{project.name}</li>
      ))}
    </ul>
  )
}

访问请求对象

在 pages 目录中，可以基于 Node.js HTTP API 获取请求相关的数据。

例如，可以从 getServerSideProps 获取 req 对象，并使用它获取请求的 cookies 和 headers。

pages/index.js
// `pages` 目录

export async function getServerSideProps({ req, query }) {
  const authHeader = req.getHeaders()['authorization'];
  const theme = req.cookies['theme'];

  return { props: { ... }}
}

export default function Page(props) {
  return ...
}

app 目录公开了新的只读函数来获取请求数据：

// `app` 目录
import { cookies, headers } from 'next/headers'

async function getData() {
  const authHeader = (await headers()).get('authorization')

  return '...'
}

export default async function Page() {
  // 可以直接在服务端组件中使用 `cookies` 或 `headers`，
  // 或在数据获取函数中使用
  const theme = (await cookies()).get('theme')
  const data = await getData()
  return '...'
}

静态站点生成 (getStaticProps)

在 pages 目录中，getStaticProps 函数用于在构建时预渲染页面。此函数可用于从外部 API 或直接从数据库获取数据，并在构建期间将数据传递给整个页面。

pages/index.js
// `pages` 目录

export async function getStaticProps() {
  const res = await fetch(`https://...`)
  const projects = await res.json()

  return { props: { projects } }
}

export default function Index({ projects }) {
  return projects.map((project) => <div>{project.name}</div>)
}

在 app 目录中，使用 fetch() 获取数据时，默认 cache: 'force-cache'，这将缓存请求数据直到手动失效。这与 pages 目录中的 getStaticProps 类似。

app/page.js
// `app` 目录

// 此函数可以任意命名
async function getProjects() {
  const res = await fetch(`https://...`)
  const projects = await res.json()

  return projects
}

export default async function Index() {
  const projects = await getProjects()

  return projects.map((project) => <div>{project.name}</div>)
}

动态路径 (getStaticPaths)

在 pages 目录中，getStaticPaths 函数用于定义构建时应预渲染的动态路径。

pages/posts/[id].js
// `pages` 目录
import PostLayout from '@/components/post-layout'

export async function getStaticPaths() {
  return {
    paths: [{ params: { id: '1' } }, { params: { id: '2' } }],
  }
}

export async function getStaticProps({ params }) {
  const res = await fetch(`https://.../posts/${params.id}`)
  const post = await res.json()

  return { props: { post } }
}

export default function Post({ post }) {
  return <PostLayout post={post} />
}

在 app 目录中，getStaticPaths 被 generateStaticParams 替代。

generateStaticParams 的行为与 getStaticPaths 类似，但提供了更简化的 API 来返回路由参数，并且可以在 布局 (layouts) 内部使用。generateStaticParams 的返回形式是一个段 (segment) 数组，而不是嵌套的 param 对象数组或解析后的路径字符串。

app/posts/[id]/page.js
// `app` 目录
import PostLayout from '@/components/post-layout'

export async function generateStaticParams() {
  return [{ id: '1' }, { id: '2' }]
}

async function getPost(params) {
  const res = await fetch(`https://.../posts/${(await params).id}`)
  const post = await res.json()

  return post
}

export default async function Post({ params }) {
  const post = await getPost(params)

  return <PostLayout post={post} />
}

在 app 目录的新模型中，使用 generateStaticParams 比 getStaticPaths 更合适。get 前缀被更具描述性的 generate 替代，因为现在不再需要 getStaticProps 和 getServerSideProps。Paths 后缀被替换为 Params，这更适合具有多个动态段 (dynamic segment) 的嵌套路由。

替换 fallback

在 pages 目录中，getStaticPaths 返回的 fallback 属性用于定义未在构建时预渲染的页面的行为。此属性可以设置为 true 以在页面生成时显示回退页面，false 以显示 404 页面，或 blocking 以在请求时生成页面。

pages/posts/[id].js
// `pages` 目录

export async function getStaticPaths() {
  return {
    paths: [],
    fallback: 'blocking'
  };
}

export async function getStaticProps({ params }) {
  ...
}

export default function Post({ post }) {
  return ...
}

在 app 目录中，config.dynamicParams 属性 控制如何处理 generateStaticParams 之外的参数：

  • true：（默认值）未包含在 generateStaticParams 中的动态段会按需生成。
  • false：未包含在 generateStaticParams 中的动态段将返回 404。

这替代了 pages 目录中 getStaticPaths 的 fallback: true | false | 'blocking' 选项。fallback: 'blocking' 选项未包含在 dynamicParams 中，因为在使用流式传输 (streaming) 时，'blocking' 和 true 之间的差异可以忽略不计。

app/posts/[id]/page.js
// `app` 目录

export const dynamicParams = true;

export async function generateStaticParams() {
  return [...]
}

async function getPost(params) {
  ...
}

export default async function Post({ params }) {
  const post = await getPost(params);

  return ...
}

当 dynamicParams 设置为 true（默认值）时，如果请求的路由段尚未生成，它将在服务器端渲染并缓存。

增量静态再生 (getStaticProps 与 revalidate)

在 pages 目录中，getStaticProps 函数允许你添加 revalidate 字段以在一定时间后自动重新生成页面。

pages/index.js
// `pages` 目录

export async function getStaticProps() {
  const res = await fetch(`https://.../posts`)
  const posts = await res.json()

  return {
    props: { posts },
    revalidate: 60,
  }
}

export default function Index({ posts }) {
  return (
    <Layout>
      <PostList posts={posts} />
    </Layout>
  )
}

在 app 目录中，使用 fetch() 获取数据时可以使用 revalidate，这将缓存请求指定的秒数。

app/page.js
// `app` 目录

async function getPosts() {
  const res = await fetch(`https://.../posts`, { next: { revalidate: 60 } })
  const data = await res.json()

  return data.posts
}

export default async function PostList() {
  const posts = await getPosts()

  return posts.map((post) => <div>{post.name}</div>)
}

API 路由

API 路由在 pages/api 目录中继续工作，无需任何更改。然而，在 app 目录中，它们已被 路由处理器 (Route Handlers) 替代。

路由处理器允许你使用 Web Request 和 Response API 为给定路由创建自定义请求处理器。

export async function GET(request: Request) {}

须知：如果你之前使用 API 路由从客户端调用外部 API，现在可以使用 服务器组件 (Server Components) 来安全地获取数据。了解更多关于 数据获取 的信息。

单页应用 (SPA)

如果你同时从单页应用 (SPA) 迁移到 Next.js，请参阅我们的 文档 了解更多信息。

步骤 7：样式

在 pages 目录中，全局样式表仅限于 pages/_app.js。在 app 目录中，此限制已被取消。全局样式可以添加到任何布局、页面或组件中。

Tailwind CSS

如果你使用 Tailwind CSS，需要在 tailwind.config.js 文件中添加 app 目录：

tailwind.config.js
module.exports = {
  content: [
    './app/**/*.{js,ts,jsx,tsx,mdx}', // <-- 添加此行
    './pages/**/*.{js,ts,jsx,tsx,mdx}',
    './components/**/*.{js,ts,jsx,tsx,mdx}',
  ],
}

还需要在 app/layout.js 文件中导入全局样式：

app/layout.js
import '../styles/globals.css'

export default function RootLayout({ children }) {
  return (
    <html lang="en">
      <body>{children}</body>
    </html>
  )
}

了解更多关于 使用 Tailwind CSS 进行样式设计

同时使用 App Router 和 Pages Router

在不同 Next.js 路由器之间导航时，会发生硬导航 (hard navigation)。使用 next/link 的自动链接预取不会跨路由器预取。

相反，你可以 优化导航 以在 App Router 和 Pages Router 之间保留预取和快速的页面过渡。了解更多。

Codemods

Next.js 提供了 Codemod 转换来帮助在功能弃用时升级代码库。更多信息请参阅 Codemods。

迁移指南

了解如何从主流框架迁移至 Next.js

Create React App

了解如何将现有的 React 应用从 Create React App 迁移到 Next.js。

On this page