Menu

如何从 Create React App 迁移到 Next.js

本指南将帮助你将现有的 Create React App (CRA) 站点迁移到 Next.js。

为什么要切换？

你可能想从 Create React App 切换到 Next.js 有以下几个原因：

初始页面加载时间慢

Create React App 使用纯客户端渲染。纯客户端应用程序，也称为单页应用程序 (SPA)，通常会遇到初始页面加载时间慢的问题。这是由以下几个原因造成的：

  1. 浏览器需要等待 React 代码和整个应用程序包下载并运行完成后，你的代码才能发送请求来加载数据。
  2. 你的应用程序代码会随着每个新功能和依赖项的添加而增长。

没有自动代码拆分

前面提到的加载缓慢问题可以通过代码拆分在一定程度上得到缓解。但是，如果你尝试手动进行代码拆分，可能会无意中引入网络瀑布流。Next.js 在其路由器和构建流程中内置了自动代码拆分和 tree-shaking。

网络瀑布流

导致性能不佳的一个常见原因是应用程序发起顺序的客户端-服务器请求来获取数据。在 SPA 中数据获取的一种模式是先渲染一个占位符，然后在组件挂载后再获取数据。不幸的是，子组件只能在其父组件完成加载自己的数据后才能开始获取数据，从而导致请求"瀑布流"。

虽然 Next.js 支持客户端数据获取，但 Next.js 还允许你将数据获取移到服务器端。这通常可以完全消除客户端-服务器瀑布流。

快速且有意的加载状态

通过内置的 React Suspense 流式传输支持，你可以定义 UI 的哪些部分首先加载以及以什么顺序加载，而不会创建网络瀑布流。

这使你能够构建加载更快的页面，并消除布局偏移。

选择数据获取策略

根据你的需求，Next.js 允许你在页面或组件级别选择数据获取策略。例如，你可以在构建时从 CMS 获取数据并渲染博客文章 (SSG) 以获得快速的加载速度，或者在必要时在请求时获取数据 (SSR)。

Proxy

Next.js Proxy 允许你在请求完成之前在服务器上运行代码。例如，你可以通过在 proxy 中将用户重定向到登录页面来避免未经身份验证内容的闪烁，这适用于仅限已验证用户的页面。你还可以将其用于 A/B 测试、实验和国际化等功能。

内置优化

图片、字体和第三方脚本通常对应用程序的性能有很大影响。Next.js 包含专门的组件和 API，可以自动为你优化它们。

迁移步骤

我们的目标是尽快获得一个可运行的 Next.js 应用程序，以便你可以逐步采用 Next.js 功能。首先，我们将把你的应用程序视为纯客户端应用程序 (SPA)，而不立即替换现有的路由器。这可以降低复杂性和合并冲突。

注意：如果你使用了高级 CRA 配置，例如 package.json 中的自定义 homepage 字段、自定义 service worker 或特定的 Babel/webpack 调整，请参阅本指南末尾的其他注意事项部分，了解如何在 Next.js 中复制或调整这些功能的提示。

步骤 1：安装 Next.js 依赖项

在现有项目中安装 Next.js：

Terminal
npm install next@latest

步骤 2：创建 Next.js 配置文件

在项目根目录（与 package.json 同级）创建一个 next.config.ts。此文件包含你的 Next.js 配置选项。

next.config.ts
import type { NextConfig } from 'next'
 
const nextConfig: NextConfig = {
  output: 'export', // 输出单页应用程序 (SPA)
  distDir: 'build', // 将构建输出目录更改为 `build`
}
 
export default nextConfig

注意：使用 output: 'export' 意味着你正在进行静态导出。你将无法访问 SSR 或 API 等服务器端功能。你可以删除此行以利用 Next.js 服务器功能。

步骤 3：创建根布局

Next.js App Router 应用程序必须包含一个根布局文件，它是一个 React Server Component，将包裹所有页面。

在 CRA 应用程序中，根布局文件最接近的等价物是 public/index.html，它包含你的 <html>、<head> 和 <body> 标签。

  1. 在 src 文件夹内创建一个新的 app 目录（或者如果你希望 app 在根目录，则在项目根目录创建）。
  2. 在 app 目录内，创建一个 layout.tsx（或 layout.js）文件：
app/layout.tsx
TypeScript
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return '...'
}

现在将旧的 index.html 的内容复制到这个 <RootLayout> 组件中。将 body div#root（和 body noscript）替换为 <div id="root">{children}</div>。

app/layout.tsx
TypeScript
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <head>
        <meta charSet="UTF-8" />
        <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
        <meta name="viewport" content="width=device-width, initial-scale=1" />
        <title>React App</title>
        <meta name="description" content="Web site created..." />
      </head>
      <body>
        <div id="root">{children}</div>
      </body>
    </html>
  )
}

值得注意的是：Next.js 默认会忽略 CRA 的 public/manifest.json、额外的图标和测试配置。如果你需要这些，Next.js 通过其 Metadata API 和测试设置提供支持。

步骤 4：元数据

Next.js 会自动包含 <meta charset="UTF-8" /> 和 <meta name="viewport" content="width=device-width, initial-scale=1" /> 标签，因此你可以从 <head> 中删除它们：

app/layout.tsx
TypeScript
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <head>
        <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
        <title>React App</title>
        <meta name="description" content="Web site created..." />
      </head>
      <body>
        <div id="root">{children}</div>
      </body>
    </html>
  )
}

任何元数据文件，例如 favicon.ico、icon.png、robots.txt，只要你将它们放置在 app 目录的顶层，就会自动添加到应用程序的 <head> 标签中。将所有支持的文件移动到 app 目录后，你可以安全地删除它们的 <link> 标签：

app/layout.tsx
TypeScript
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <head>
        <title>React App</title>
        <meta name="description" content="Web site created..." />
      </head>
      <body>
        <div id="root">{children}</div>
      </body>
    </html>
  )
}

最后，Next.js 可以使用 Metadata API 管理你最后的 <head> 标签。将最终的元数据信息移动到导出的 metadata 对象中：

app/layout.tsx
TypeScript
import type { Metadata } from 'next'
 
export const metadata: Metadata = {
  title: 'React App',
  description: 'Web site created with Next.js.',
}
 
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <body>
        <div id="root">{children}</div>
      </body>
    </html>
  )
}

通过上述更改，你从在 index.html 中声明所有内容转变为使用 Next.js 内置于框架中的基于约定的方法（Metadata API）。这种方法使你能够更轻松地改善页面的 SEO 和网络分享能力。

步骤 5：样式

与 CRA 一样，Next.js 开箱即用地支持 CSS Modules。它还支持全局 CSS 导入。

如果你有全局 CSS 文件，请在 app/layout.tsx 中导入它：

app/layout.tsx
TypeScript
import '../index.css'
 
export const metadata = {
  title: 'React App',
  description: 'Web site created with Next.js.',
}
 
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <body>
        <div id="root">{children}</div>
      </body>
    </html>
  )
}

如果你使用的是 Tailwind CSS，请参阅我们的安装文档。

步骤 6：创建入口页面

Create React App 使用 src/index.tsx（或 index.js）作为入口点。在 Next.js (App Router) 中，app 目录内的每个文件夹对应一个路由，每个文件夹都应该有一个 page.tsx。

由于我们现在想将应用程序保持为 SPA 并拦截所有路由，我们将使用可选的捕获所有路由。

  1. 在 app 内创建一个 [[...slug]] 目录。
app
 ┣ [[...slug]]
 ┃ ┗ page.tsx
 ┣ layout.tsx
  1. 将以下内容添加到 page.tsx：
app/[[...slug]]/page.tsx
TypeScript
export function generateStaticParams() {
  return [{ slug: [''] }]
}
 
export default function Page() {
  return '...' // 我们稍后会更新这个
}

这告诉 Next.js 为空 slug（/）生成单个路由，有效地将所有路由映射到同一页面。此页面是一个 Server Component，预渲染为静态 HTML。

步骤 7：添加仅客户端入口点

接下来，我们将把 CRA 的根 App 组件嵌入到 Client Component 中，以便所有逻辑保持在客户端。如果这是你第一次使用 Next.js，值得了解的是客户端组件（默认情况下）仍然在服务器上预渲染。你可以将它们视为具有运行客户端 JavaScript 的额外能力。

在 app/[[...slug]]/ 中创建一个 client.tsx（或 client.js）：

app/[[...slug]]/client.tsx
TypeScript
'use client'
 
import dynamic from 'next/dynamic'
 
const App = dynamic(() => import('../../App'), { ssr: false })
 
export function ClientOnly() {
  return <App />
}
  • 'use client' 指令使此文件成为客户端组件。
  • 带有 ssr: false 的 dynamic 导入禁用了 <App /> 组件的服务器端渲染，使其真正成为仅客户端 (SPA)。

现在更新你的 page.tsx（或 page.js）以使用新组件：

app/[[...slug]]/page.tsx
TypeScript
import { ClientOnly } from './client'
 
export function generateStaticParams() {
  return [{ slug: [''] }]
}
 
export default function Page() {
  return <ClientOnly />
}

步骤 8：更新静态图片导入

在 CRA 中，导入图片文件会返回其公共 URL 作为字符串：

import image from './img.png'
 
export default function App() {
  return <img src={image} />
}

在 Next.js 中，静态图片导入返回一个对象。然后可以直接将该对象与 Next.js <Image> 组件一起使用，或者你可以将对象的 src 属性与现有的 <img> 标签一起使用。

<Image> 组件具有自动图片优化的额外优势。<Image> 组件会根据图片的尺寸自动设置生成的 <img> 的 width 和 height 属性。这可以防止图片加载时的布局偏移。但是，如果你的应用程序包含只有一个维度被样式化而另一个没有样式化为 auto 的图片，这可能会导致问题。当没有样式化为 auto 时，维度将默认为 <img> 维度属性的值，这可能导致图片看起来变形。

保留 <img> 标签将减少应用程序中的更改量，并防止上述问题。然后，你可以稍后通过配置 loader 或迁移到具有自动图片优化的默认 Next.js 服务器来选择性地迁移到 <Image> 组件以利用图片优化。

将从 /public 导入的图片的绝对导入路径转换为相对导入：

// 之前
import logo from '/logo.png'
 
// 之后
import logo from '../public/logo.png'

将图片的 src 属性而不是整个图片对象传递给你的 <img> 标签：

// 之前
<img src={logo} />
 
// 之后
<img src={logo.src} />

或者，你可以根据文件名引用图片资源的公共 URL。例如，public/logo.png 将为你的应用程序在 /logo.png 提供图片，这将是 src 值。

警告： 如果你使用的是 TypeScript，访问 src 属性时可能会遇到类型错误。要修复它们，你需要将 next-env.d.ts 添加到 tsconfig.json 文件的 include 数组中。Next.js 将在你在步骤 9 运行应用程序时自动生成此文件。

步骤 9：迁移环境变量

Next.js 支持环境变量，与 CRA 类似，但需要 NEXT_PUBLIC_ 前缀才能在浏览器中公开任何变量。

主要区别在于用于在客户端公开环境变量的前缀。将所有带有 REACT_APP_ 前缀的环境变量更改为 NEXT_PUBLIC_。

步骤 10：更新 package.json 中的脚本

更新 package.json 脚本以使用 Next.js 命令。此外，将 .next 和 next-env.d.ts 添加到 .gitignore：

package.json
{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "npx serve@latest ./build"
  }
}
.gitignore
# ...
.next
next-env.d.ts

现在你可以运行：

npm run dev

打开 http://localhost:3000。你应该看到你的应用程序现在在 Next.js 上运行（以 SPA 模式）。

步骤 11：清理

你现在可以删除特定于 Create React App 的工件：

  • public/index.html
  • src/index.tsx
  • src/react-app-env.d.ts
  • reportWebVitals 设置
  • react-scripts 依赖项（从 package.json 中卸载它）

其他注意事项

在 CRA 中使用自定义 homepage

如果你在 CRA package.json 中使用 homepage 字段将应用程序提供在特定子路径下，你可以在 next.config.ts 中使用 basePath 配置在 Next.js 中复制这一点：

next.config.ts
import { NextConfig } from 'next'
 
const nextConfig: NextConfig = {
  basePath: '/my-subpath',
  // ...
}
 
export default nextConfig

处理自定义 Service Worker

如果你使用了 CRA 的 service worker（例如，来自 create-react-app 的 serviceWorker.js），你可以学习如何使用 Next.js 创建渐进式 Web 应用程序 (PWA)。

代理 API 请求

如果你的 CRA 应用程序使用 package.json 中的 proxy 字段将请求转发到后端服务器，你可以在 next.config.ts 中使用 Next.js rewrites 来复制这一点：

next.config.ts
import { NextConfig } from 'next'
 
const nextConfig: NextConfig = {
  async rewrites() {
    return [
      {
        source: '/api/:path*',
        destination: 'https://your-backend.com/:path*',
      },
    ]
  },
}

自定义 Webpack

如果你在 CRA 中有自定义的 webpack 或 Babel 配置，你可以在 next.config.ts 中扩展 Next.js 的配置：

next.config.ts
import { NextConfig } from 'next'
 
const nextConfig: NextConfig = {
  webpack: (config, { isServer }) => {
    // 在这里修改 webpack 配置
    return config
  },
}
 
export default nextConfig

注意：这将需要通过在 dev 脚本中添加 --webpack 来使用 Webpack。

TypeScript 设置

如果你有 tsconfig.json，Next.js 会自动设置 TypeScript。确保 next-env.d.ts 列在你的 tsconfig.json include 数组中：

{
  "include": ["next-env.d.ts", "app/**/*", "src/**/*"]
}

打包工具兼容性

Create React App 使用 webpack 进行打包。Next.js 现在默认使用 Turbopack 以实现更快的本地开发：

next dev  # 默认使用 Turbopack

要改用 Webpack（类似于 CRA）：

next dev --webpack

如果你需要从 CRA 迁移高级 webpack 设置，你仍然可以提供自定义 webpack 配置。

后续步骤

如果一切正常，你现在拥有一个作为单页应用程序运行的功能性 Next.js 应用程序。你还没有利用 Next.js 的功能，如服务器端渲染或基于文件的路由，但你现在可以逐步这样做：

注意：使用静态导出（output: 'export'）目前不支持 useParams hook 或其他服务器功能。要使用所有 Next.js 功能，请从 next.config.ts 中删除 output: 'export'。