Menu

How to migrate from Vite to Next.js

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

为什么要切换？

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

初始页面加载时间慢

如果你使用默认的 Vite React 插件构建应用程序，你的应用程序是一个纯客户端应用程序。纯客户端应用程序，也称为单页应用程序（SPAs），通常会经历较慢的初始页面加载时间。这种情况发生的原因有几个：

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

没有自动代码分割

前面提到的加载时间慢的问题可以通过代码分割来部分解决。但是，如果你尝试手动进行代码分割，通常会使性能变得更糟。在手动进行代码分割时，很容易无意中引入网络瀑布流。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 作为依赖项：

Terminal
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

值得注意的是： 你可以使用 .js 或 .mjs 作为 Next.js 配置文件的扩展名。

步骤 3：更新 TypeScript 配置

如果你使用 TypeScript，需要对 tsconfig.json 文件进行以下更改以使其与 Next.js 兼容。如果你不使用 TypeScript，可以跳过此步骤。

  1. 删除对 tsconfig.node.json 的项目引用
  2. 在 include 数组中添加 ./dist/types/**/*.ts 和 ./next-env.d.ts
  3. 在 exclude 数组中添加 ./node_modules
  4. 在 compilerOptions 中的 plugins 数组中添加 { "name": "next" }："plugins": [{ "name": "next" }]
  5. 将 esModuleInterop 设置为 true："esModuleInterop": true
  6. 将 jsx 设置为 preserve："jsx": "preserve"
  7. 将 allowJs 设置为 true："allowJs": true
  8. 将 forceConsistentCasingInFileNames 设置为 true："forceConsistentCasingInFileNames": true
  9. 将 incremental 设置为 true："incremental": true

下面是一个包含这些更改的可用 tsconfig.json 示例：

tsconfig.json
{
  "compilerOptions": {
    "target": "ES2020",
    "useDefineForClassFields": true,
    "lib": ["ES2020", "DOM", "DOM.Iterable"],
    "module": "ESNext",
    "esModuleInterop": true,
    "skipLibCheck": true,
    "moduleResolution": "bundler",
    "allowImportingTsExtensions": true,
    "resolveJsonModule": true,
    "isolatedModules": true,
    "noEmit": true,
    "jsx": "preserve",
    "strict": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "noFallthroughCasesInSwitch": true,
    "allowJs": true,
    "forceConsistentCasingInFileNames": true,
    "incremental": true,
    "plugins": [{ "name": "next" }]
  },
  "include": ["./src", "./dist/types/**/*.ts", "./next-env.d.ts"],
  "exclude": ["./node_modules"]
}

关于配置 TypeScript 的更多信息，可以在Next.js 文档中找到。

步骤 4：创建根布局

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

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

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

  1. 在 src 目录中创建一个新的 app 目录。
  2. 在该 app 目录内创建一个新的 layout.tsx 文件：
app/layout.tsx
TypeScript
export default function RootLayout({
  children,
}: {
  children: React.ReactNode
}) {
  return '...'
}

值得注意的是: 布局文件可以使用 .js、.jsx 或 .tsx 扩展名。

  1. 将 index.html 文件的内容复制到之前创建的 <RootLayout> 组件中，同时将 body.div#root 和 body.script 标签替换为 <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" 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>
  )
}
  1. Next.js 默认已包含 meta charset 和 meta viewport 标签，因此你可以安全地从 <head> 中删除这些标签：
app/layout.tsx
TypeScript
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>
  )
}
  1. 任何元数据文件，如 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>My App</title>
        <meta name="description" content="My App is a..." />
      </head>
      <body>
        <div id="root">{children}</div>
      </body>
    </html>
  )
}
  1. 最后，Next.js 可以使用元数据 API 管理你最后的 <head> 标签。将你的最终元数据信息移动到导出的 metadata 对象中：
app/layout.tsx
TypeScript
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 和网络共享能力。

步骤 5：创建入口点页面

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

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

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

这个目录是所谓的可选全捕获路由段。Next.js 使用基于文件系统的路由器，其中文件夹用于定义路由。这个特殊目录将确保你的应用程序的所有路由都会被引导到其包含的 page.tsx 文件。

  1. 在 app/[[...slug]] 目录中创建一个包含以下内容的新 page.tsx 文件：
app/[[...slug]]/page.tsx
TypeScript
import '../../index.css'
 
export function generateStaticParams() {
  return [{ slug: [''] }]
}
 
export default function Page() {
  return '...' // 我们将更新这个
}

值得注意的是：页面文件可以使用 .js、.jsx 或 .tsx 扩展名。

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

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

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

app/[[...slug]]/client.tsx
TypeScript
'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
TypeScript
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` 会是 '/assets/img.2d8efhg.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 服务器。

  1. 将从 /public 导入图像的绝对导入路径转换为相对导入：
// 之前
import logo from '/logo.png'
 
// 之后
import logo from '../public/logo.png'
  1. 将图像的 src 属性而不是整个图像对象传递给 <img> 标签：
// 之前
<img src={logo} />
 
// 之后
<img src={logo.src} />

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

警告： 如果你使用 TypeScript，访问 src 属性时可能会遇到类型错误。现在可以安全地忽略这些错误。它们将在本指南结束时得到修复。

步骤 7：迁移环境变量

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

  • 将所有带有 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 环境变量。但是，如果需要，你仍然可以配置一个：

  1. 在 .env 文件中添加以下内容：
.env
# ...
NEXT_PUBLIC_BASE_PATH="/some-base-path"
  1. 在 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
  1. 将 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，并打开 http://localhost: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 的大部分优势，不过你现在可以开始进行增量更改以获得所有好处。以下是你接下来可能想要做的事情：