从 Vite 迁移

本指南将帮助你将现有的 Vite 应用程序迁移到 Next.js。

为什么要切换？

你可能想要从 Vite 切换到 Next.js 的几个原因：

初始页面加载时间慢

如果你使用 React 的默认 Vite 插件构建了你的应用程序，那么你的应用程序是一个纯粹的客户端应用程序。纯客户端应用程序，也称为单页应用程序 (SPA)，通常会遇到初始页面加载时间慢的问题。这发生的原因有以下几点：

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

没有自动代码拆分

先前加载时间慢的问题可以通过代码拆分在某种程度上得到管理。但是，如果你尝试手动进行代码拆分，通常会使性能更差。在手动代码拆分时，很容易无意中引入网络瀑布流。Next.js 提供了内置在其路由器中的自动代码拆分。

网络瀑布流

当应用程序进行连续的客户端-服务器请求来获取数据时，就会发生性能不佳的常见原因。SPA 中数据获取的一种常见模式是最初渲染一个占位符，然后在组件挂载后获取数据。不幸的是，这意味着获取数据的子组件在父组件完成加载其自身数据之前无法开始获取。

虽然 Next.js 支持在客户端获取数据，但它也允许你选择将数据获取转移到服务器，这可以消除客户端-服务器瀑布流。

快速且有意的加载状态

凭借对通过 React Suspense 进行流式处理的内置支持，你可以更有意地决定 UI 的哪些部分你想先加载以及以什么顺序加载，而不会引入网络瀑布流。

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

选择数据获取策略

根据你的需求，Next.js 允许你在页面和组件级别选择你的数据获取策略。你可以决定在构建时、在服务器上的请求时或在客户端获取。例如，你可以从你的 CMS 获取数据并在构建时渲染你的博客文章，然后可以有效地将其缓存在 CDN 上。

中间件

Next.js 中间件允许你在请求完成之前在服务器上运行代码。这对于避免用户访问仅限身份验证的页面时出现未经验证内容闪烁的情况尤其有用，方法是将用户重定向到登录页面。中间件也适用于实验和国际化。

内置优化

图像、字体和第三方脚本通常对应用程序的性能有重大影响。Next.js 附带内置组件，可自动为你优化这些组件。

迁移步骤

我们这次迁移的目标是尽快获得一个可用的 Next.js 应用程序，以便你可以逐步采用 Next.js 的功能。首先，我们将保持它作为一个纯粹的客户端应用程序 (SPA)，而无需迁移你现有的路由器。这有助于最大限度地减少在迁移过程中遇到问题的机会，并减少合并冲突。

步骤 1：安装 Next.js 依赖

你需要做的第一件事是安装 next 作为依赖项

终端

npm install next@latest

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

在你的项目根目录创建一个 next.config.mjs。此文件将保存你的 Next.js 配置选项。

next.config.mjs

/** @type {import('next').NextConfig} */
const nextConfig = {
  output: 'export', // Outputs a Single-Page Application (SPA).
  distDir: './dist', // Changes the build output directory to `./dist/`.
}
 
export default nextConfig

须知： 你可以为你的 Next.js 配置文件使用 .js 或 .mjs。

步骤 4：创建根布局

Next.js App Router 应用程序必须包含一个根布局文件，这是一个 React 服务器组件，它将包裹你应用程序中的所有页面。此文件在 app 目录的顶层定义。

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

在此步骤中，你将把你的 index.html 文件转换为根布局文件

在你的 src 目录中创建一个新的 app 目录。
在该 app 目录内创建一个新的 layout.tsx 文件

app/layout.tsx

export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return '...'
}

须知：.js、.jsx 或 .tsx 扩展名可以用于布局文件。

将你的 index.html 文件的内容复制到先前创建的 <RootLayout> 组件中，同时将 body.div#root 和 body.script 标签替换为 <div id="root">{children}</div>

app/layout.tsx

export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <head>
        <meta charset="UTF-8" />
        <link rel="icon" type="image/svg+xml" href="/icon.svg" />
        <meta name="viewport" content="width=device-width, initial-scale=1.0" />
        <title>My App</title>
        <meta name="description" content="My App is a..." />
      </head>
      <body>
        <div id="root">{children}</div>
      </body>
    </html>
  )
}

Next.js 默认已包含 meta charset 和 meta viewport 标签，因此你可以安全地从你的 <head> 中删除这些标签

app/layout.tsx

export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <head>
        <link rel="icon" type="image/svg+xml" href="/icon.svg" />
        <title>My App</title>
        <meta name="description" content="My App is a..." />
      </head>
      <body>
        <div id="root">{children}</div>
      </body>
    </html>
  )
}

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

app/layout.tsx

export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return (
    <html lang="en">
      <head>
        <title>My App</title>
        <meta name="description" content="My App is a..." />
      </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: 'My App',
  description: 'My App is a...',
}
 
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 和 Web 共享性。

步骤 5：创建入口点页面

在 Next.js 上，你可以通过创建一个 page.tsx 文件来声明应用程序的入口点。Vite 上与此文件最接近的等效文件是你的 main.tsx 文件。在此步骤中，你将设置应用程序的入口点。

在你的 app 目录中创建一个 [[...slug]] 目录。

由于在本指南中，我们的首要目标是将 Next.js 设置为 SPA（单页应用程序），因此你需要你的页面入口点来捕获应用程序的所有可能路由。为此，在你的 app 目录中创建一个新的 [[...slug]] 目录。

此目录被称为可选的 catch-all 路由段。Next.js 使用基于文件系统的路由器，其中文件夹用于定义路由。这个特殊的目录将确保你的应用程序的所有路由都将定向到其包含的 page.tsx 文件。

在 app/[[...slug]] 目录下创建一个新的 page.tsx 文件，内容如下：

app/[[...slug]]/page.tsx

import '../../index.css'
 
export function generateStaticParams() {
  return [{ slug: [''] }]
}
 
export default function Page() {
  return '...' // We'll update this
}

须知： Page 文件可以使用 .js、.jsx 或 .tsx 扩展名。

此文件是一个服务器组件。当您运行 next build 时，该文件会被预渲染成静态资源。它不需要任何动态代码。

此文件导入了我们的全局 CSS，并告知 generateStaticParams 我们将只生成一个路由，即 / 处的索引路由。

现在，让我们移动 Vite 应用程序的其余部分，它将仅在客户端运行。

app/[[...slug]]/client.tsx

'use client'
 
import React from 'react'
import dynamic from 'next/dynamic'
 
const App = dynamic(() => import('../../App'), { ssr: false })
 
export function ClientOnly() {
  return <App />
}

此文件是一个客户端组件，由 'use client' 指令定义。客户端组件仍然会在发送到客户端之前在服务器上预渲染为 HTML。

由于我们希望客户端应用程序启动，我们可以配置 Next.js 以禁用从 App 组件向下的预渲染。

const App = dynamic(() => import('../../App'), { ssr: false })

现在，更新您的入口页面以使用新的组件

app/[[...slug]]/page.tsx

import '../../index.css'
import { ClientOnly } from './client'
 
export function generateStaticParams() {
  return [{ slug: [''] }]
}
 
export default function Page() {
  return <ClientOnly />
}

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

Next.js 处理静态图片导入的方式与 Vite 略有不同。使用 Vite，导入图片文件将返回其公共 URL 作为字符串

App.tsx

import image from './img.png' // `image` will be '/assets/img.2d8efhg.png' in production
 
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 导入的图片的绝对导入路径转换为相对导入

// Before
import logo from '/logo.png'
 
// After
import logo from '../public/logo.png'

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

// Before
<img src={logo} />
 
// After
<img src={logo.src} />

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

警告： 如果您正在使用 TypeScript，则在访问 src 属性时可能会遇到类型错误。您可以暂时忽略这些错误。它们将在本指南的末尾修复。

步骤 7：迁移环境变量

Next.js 支持 .env 环境变量，类似于 Vite。主要区别在于用于在客户端公开环境变量的前缀。

将所有带有 VITE_ 前缀的环境变量更改为 NEXT_PUBLIC_。

Vite 在特殊的 import.meta.env 对象上公开了一些内置环境变量，Next.js 不支持这些环境变量。您需要按如下方式更新它们的用法：

import.meta.env.MODE ⇒ process.env.NODE_ENV
import.meta.env.PROD ⇒ process.env.NODE_ENV === 'production'
import.meta.env.DEV ⇒ process.env.NODE_ENV !== 'production'
import.meta.env.SSR ⇒ typeof window !== 'undefined'

Next.js 也不提供内置的 BASE_URL 环境变量。但是，如果您需要，您仍然可以配置一个。

将以下内容添加到您的 .env 文件中

.env

# ...
NEXT_PUBLIC_BASE_PATH="/some-base-path"

在您的 next.config.mjs 文件中将 basePath 设置为 process.env.NEXT_PUBLIC_BASE_PATH

next.config.mjs

/** @type {import('next').NextConfig} */
const nextConfig = {
  output: 'export', // Outputs a Single-Page Application (SPA).
  distDir: './dist', // Changes the build output directory to `./dist/`.
  basePath: process.env.NEXT_PUBLIC_BASE_PATH, // Sets the base path to `/some-base-path`.
}
 
export default nextConfig

将 import.meta.env.BASE_URL 的用法更新为 process.env.NEXT_PUBLIC_BASE_PATH

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

现在您应该能够运行您的应用程序，以测试是否已成功迁移到 Next.js。但在此之前，您需要使用 Next.js 相关命令更新 package.json 中的 scripts，并将 .next 和 next-env.d.ts 添加到您的 .gitignore 中

package.json

{
  "scripts": {
    "dev": "next dev",
    "build": "next build",
    "start": "next start"
  }
}

.gitignore

# ...
.next
next-env.d.ts
dist

现在运行 npm run dev，并打开 https://127.0.0.1:3000。您应该看到您的应用程序现在在 Next.js 上运行。

示例： 查看此拉取请求，了解将 Vite 应用程序迁移到 Next.js 的工作示例。

步骤 9：清理

现在您可以从代码库中清理与 Vite 相关的工件

删除 main.tsx
删除 index.html
删除 vite-env.d.ts
删除 tsconfig.node.json
删除 vite.config.ts
卸载 Vite 依赖项

后续步骤

如果一切按计划进行，您现在应该有一个作为单页应用程序运行的 Next.js 应用程序。但是，您尚未利用 Next.js 的大多数优势，但您现在可以开始进行增量更改以获得所有好处。这是您接下来可能想要做的事情：

从 React Router 迁移到 Next.js App Router 以获得：
- 自动代码拆分
- 流式服务器渲染
- React 服务器组件
使用 <Image> 组件优化图片
使用 next/font 优化字体
使用 <Script> 组件优化第三方脚本
更新您的 ESLint 配置以支持 Next.js 规则