跳到主要内容

如何从 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 在其路由器和构建管道中内置了自动代码分割和树摇。

网络瀑布​

当应用程序进行顺序的客户端-服务器请求来获取数据时，通常会导致性能不佳。SPA 中数据获取的一种模式是渲染占位符，然后在组件挂载后获取数据。不幸的是，子组件只能在其父组件完成加载自己的数据后才开始获取数据，导致请求的"瀑布"。

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

快速和有意向的加载状态​

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

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

选择数据获取策略​

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

中间件​

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

内置优化​

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

迁移步骤​

我们的目标是尽快获得一个工作的 Next.js 应用程序，这样您就可以逐步采用 Next.js 功能。首先，我们将把您的应用程序视为纯客户端应用程序（SPA），而不立即替换您现有的路由器。这减少了复杂性和合并冲突。

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

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

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

Terminal
npm install next@latest

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

在项目根目录创建 next.config.ts（与 package.json 同级）。此文件包含您的 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 路由器 应用程序必须包含一个根布局文件，这是一个React 服务器组件，将包装您的所有页面。

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

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

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

app/layout.tsx
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 应用</title>
        <meta name="description" content="创建的网站..." />
      </head>
      <body>
        <div id="root">{children}</div>
      </body>
    </html>
  )
}

提示： Next.js 默认忽略 CRA 的 public/manifest.json、额外图标和测试配置。如果您需要这些，Next.js 通过其元数据 API 和测试设置提供支持。

步骤 4：元数据​

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

app/layout.tsx
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <head>
        <link rel="icon" href="%PUBLIC_URL%/favicon.ico" />
        <title>React 应用</title>
        <meta name="description" content="创建的网站..." />
      </head>
      <body>
        <div id="root">{children}</div>
      </body>
    </html>
  )
}

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

app/layout.tsx
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <head>
        <title>React 应用</title>
        <meta name="description" content="创建的网站..." />
      </head>
      <body>
        <div id="root">{children}</div>
      </body>
    </html>
  )
}

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

app/layout.tsx
import type { Metadata } from 'next'

export const metadata: Metadata = {
  title: 'React 应用',
  description: '使用 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 内置在框架中的基于约定的方法（元数据 API）。这种方法使您能够更容易地改善页面的 SEO 和网络可共享性。

步骤 5：样式​

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

如果您有全局 CSS 文件，请将其导入到 app/layout.tsx：

app/layout.tsx
import '../index.css'

export const metadata = {
  title: 'React 应用',
  description: '使用 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 路由器）中，app 目录内的每个文件夹对应一个路由，每个文件夹应该有一个 page.tsx。

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

  1. 在 app 内创建 [[...slug]] 目录。
app
 ┣ [[...slug]]
 ┃ ┗ page.tsx
 ┣ layout.tsx
  1. 在 page.tsx 中添加以下内容：
app/[[...slug]]/page.tsx
export function generateStaticParams() {
  return [{ slug: [''] }]
}

export default function Page() {
  return '...' // 我们将更新这个
}

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

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

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

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

app/[[...slug]]/client.tsx
'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
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> 标签将减少应用程序中的更改量并防止上述问题。然后您可以选择稍后迁移到 <Image> 组件，通过配置加载器来利用优化图片的优势，或移动到具有自动图片优化的默认 Next.js 服务器。

将从 /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 数组中。当您在第 9 步运行应用程序时，Next.js 将自动生成此文件。

步骤 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 --turbopack",
    "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.js 中使用 next.config.ts 中的 basePath 配置来复制：

next.config.ts
import { NextConfig } from 'next'

const nextConfig: NextConfig = {
  basePath: '/my-subpath',
  // ...
}

export default nextConfig

处理自定义 Service Worker​

如果您使用 CRA 的服务工作者（例如，来自 create-react-app 的 serviceWorker.js），您可以学习如何使用 Next.js 创建渐进式 Web 应用程序（PWA）。

代理 API 请求​

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

next.config.ts
import { NextConfig } from 'next'

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

自定义 Webpack / Babel 配置​

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

next.config.ts
import { NextConfig } from 'next'

const nextConfig: NextConfig = {
  webpack: (config, { isServer }) => {
    // 在此处修改 webpack 配置
    return config
  },
}

注意： 这将需要通过从 dev 脚本中删除 --turbopack 来禁用 Turbopack。

TypeScript 设置​

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

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

打包器兼容性​

Create React App 和 Next.js 都默认使用 webpack 进行打包。Next.js 还提供 Turbopack 以更快地进行本地开发：

next dev --turbopack

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

下一步​

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

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

最后于 更新