如何从 Pages 迁移到 App Router

本指南将帮助你：

将你的 Next.js 应用程序从版本 12 更新到版本 13
升级在 pages 和 app 目录中都能使用的功能
逐步将现有应用程序从 pages 迁移到 app

升级

Node.js 版本

最低 Node.js 版本现在是 v18.17。更多信息请参阅 Node.js 文档。

Next.js 版本

要更新到 Next.js 版本 13，请使用你喜欢的包管理器运行以下命令：

Terminal

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

ESLint 版本

如果你正在使用 ESLint，需要升级你的 ESLint 版本：

Terminal

npm install -D eslint-config-next@latest

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

后续步骤

更新完成后，请参阅以下章节了解后续步骤：

升级新功能：帮助你升级到新功能的指南，例如改进的 Image 和 Link 组件。
从 pages 迁移到 app 目录：逐步指南，帮助你从 pages 逐步迁移到 app 目录。

升级新功能

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 的默认行为。

有两个 codemod 可以帮助你迁移到新的 Image 组件：

next-image-to-legacy-image codemod：安全且自动地将 next/image 导入重命名为 next/legacy/image。现有组件将保持相同的行为。
next-image-experimental codemod：危险地添加内联样式并删除未使用的 props。这将改变现有组件的行为以匹配新的默认值。要使用此 codemod，你需要先运行 next-image-to-legacy-image codemod。

`<Link>` 组件

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

例如：

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 codemod。

`<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 Routes 已被 route.js（Route Handler）特殊文件替换。

步骤 2：创建根布局

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

app/layout.tsx

TypeScript

export default function RootLayout({
  // 布局必须接受 children prop。
  // 这将填充嵌套布局或页面
  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 支持：

app/layout.tsx

TypeScript

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 量。

步骤 4：迁移页面

app 目录中的页面默认是服务器组件。这与 pages 目录不同，后者的页面是客户端组件。
app 中的数据获取已更改。getServerSideProps、getStaticProps 和 getInitialProps 已被更简单的 API 替换。
app 目录使用嵌套文件夹定义路由，并使用特殊的 page.js 文件使路由段可公开访问。
pages 目录 app 目录路由
index.js page.js /
about.js about/page.js /about
blog/[slug].js blog/[slug]/page.js /blog/post-1

`pages` 目录	`app` 目录	路由
`index.js`	`page.js`	`/`
`about.js`	`about/page.js`	`/about`
`blog/[slug].js`	`blog/[slug]/page.js`	`/blog/post-1`

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

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

值得注意的是：这是最简单的迁移路径，因为它与 pages 目录的行为最相似。

步骤 1：创建新的客户端组件

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

app/home-page.tsx

TypeScript

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

步骤 2：创建新页面

在 app 目录内创建一个新的 app/page.tsx 文件。默认情况下，这是一个服务器组件。
将 home-page.tsx 客户端组件导入页面。

如果你在 pages/index.js 中获取数据，请使用新的数据获取 API 将数据获取逻辑直接移动到服务器组件中。更多详细信息请参阅数据获取升级指南。

app/page.tsx

TypeScript

// 导入你的客户端组件
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，你需要更新到新的路由 hooks。了解更多。
启动开发服务器并访问 http://localhost:3000。你应该看到现有的索引路由，现在通过 app 目录提供服务。

步骤 5：迁移路由 Hooks

已添加一个新的 router 以支持 app 目录中的新行为。

在 app 中，你应该使用从 next/navigation 导入的三个新 hooks：useRouter()、usePathname() 和 useSearchParams()。

新的 useRouter hook 从 next/navigation 导入，其行为与从 next/router 导入的 pages 中的 useRouter hook 不同。
- 从 next/router 导入的 useRouter hook 在 app 目录中不受支持，但可以继续在 pages 目录中使用。
新的 useRouter 不返回 pathname 字符串。请改用单独的 usePathname hook。
新的 useRouter 不返回 query 对象。搜索参数和动态路由参数现在是分开的。请改用 useSearchParams 和 useParams hooks。
你可以一起使用 useSearchParams 和 usePathname 来监听页面变化。更多详细信息请参阅 Router Events 部分。
这些新 hooks 仅在客户端组件中受支持。它们不能在服务器组件中使用。

app/example-client-component.tsx

TypeScript

'use client'
 
import { useRouter, usePathname, useSearchParams } from 'next/navigation'
 
export default function ExampleClientComponent() {
  const router = useRouter()
  const pathname = usePathname()
  const searchParams = useSearchParams()
 
  // ...
}

此外，新的 useRouter hook 有以下更改：

isFallback 已被删除，因为 fallback 已被替换。
locale、locales、defaultLocales、domainLocales 值已被删除，因为 app 目录中不再需要内置的 i18n Next.js 功能。了解更多关于 i18n。
basePath 已被删除。替代方案不会是 useRouter 的一部分。它尚未实现。
asPath 已被删除，因为新 router 中删除了 as 的概念。
isReady 已被删除，因为它不再必要。在静态渲染期间，任何使用 useSearchParams() hook 的组件都会跳过预渲染步骤，而是在运行时在客户端渲染。
route 已被删除。usePathname 或 useSelectedLayoutSegments() 提供了替代方案。

查看 useRouter() API 参考。

要使组件在 pages 和 app router 之间兼容，请参考来自 next/compat/router 的 useRouter hook。这是来自 pages 目录的 useRouter hook，但旨在在 router 之间共享组件时使用。一旦你准备好仅在 app router 上使用它，请更新到来自 next/navigation 的新 useRouter。

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

pages 目录使用 getServerSideProps 和 getStaticProps 为页面获取数据。在 app 目录内，这些之前的数据获取函数被基于 fetch() 和 async React 服务器组件构建的更简单的 API 替换。

app/page.tsx

TypeScript

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 中，我们可以使用服务器组件在 React 组件内部放置数据获取。这使我们能够向客户端发送更少的 JavaScript，同时保持服务器渲染的 HTML。

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

app/dashboard/page.tsx

TypeScript

// `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 目录公开了新的只读函数来检索请求数据：

headers：基于 Web Headers API，可以在服务器组件内使用以检索请求 headers。
cookies：基于 Web Cookies API，可以在服务器组件内使用以检索 cookies。

app/page.tsx

TypeScript

// `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，并且可以在布局内使用。generateStaticParams 的返回形状是段数组，而不是嵌套 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 替换，这对于具有多个动态段的嵌套路由更合适。

替换 `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 之外的 params 如何处理：

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

这替换了 pages 目录中 getStaticPaths 的 fallback: true | false | 'blocking' 选项。fallback: 'blocking' 选项不包含在 dynamicParams 中，因为使用流式传输时 '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（默认值）时，当请求尚未生成的路由段时，它将在服务器上渲染并缓存。

增量静态再生（带有 `revalidate` 的 `getStaticProps`）

在 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 Routes

API Routes 继续在 pages/api 目录中工作，无需任何更改。但是，它们已被 app 目录中的 Route Handlers 替换。

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

app/api/route.ts

TypeScript

export async function GET(request: Request) {}

值得注意的是：如果你之前使用 API routes 从客户端调用外部 API，现在可以改用服务器组件来安全地获取数据。了解更多关于数据获取。

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 routers 提供的路由之间导航时，将会有硬导航。使用 next/link 的自动链接预取不会跨 routers 预取。

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

Codemods

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

如何从 Pages 迁移到 App Router

升级

Node.js 版本

Next.js 版本

ESLint 版本

后续步骤

升级新功能

`<Image/>` 组件

`<Link>` 组件

`<Script>` 组件

字体优化

从 `pages` 迁移到 `app`

步骤 1：创建 `app` 目录

步骤 2：创建根布局

迁移 `_document.js` 和 `_app.js`

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

步骤 3：迁移 `next/head`

步骤 4：迁移页面

步骤 5：迁移路由 Hooks

在 `pages` 和 `app` 之间共享组件

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

服务器端渲染（`getServerSideProps`）

访问请求对象

静态站点生成（`getStaticProps`）

动态路径（`getStaticPaths`）

替换 `fallback`

增量静态再生（带有 `revalidate` 的 `getStaticProps`）

API Routes

单页应用

步骤 7：样式

Tailwind CSS

同时使用 App Router 和 Pages Router

Codemods