Menu

从 Vite 迁移

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

为什么要切换？

从 Vite 切换到 Next.js 有以下几个原因：

初始页面加载时间慢

如果你使用 默认的 Vite React 插件 构建应用，你的应用是一个纯客户端应用。纯客户端应用，也称为单页面应用 (SPA)，经常会遇到初始页面加载缓慢的问题。这主要有以下几个原因：

  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', // 输出单页面应用 (SPA)
  distDir: './dist', // 将构建输出目录更改为 `./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"]
}

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

步骤 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 对 .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 环境变量。但是，如果你需要，你仍然可以配置一个：

  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', // 输出单页面应用 (SPA)
  distDir: './dist', // 将构建输出目录更改为 `./dist/`
  basePath: process.env.NEXT_PUBLIC_BASE_PATH, // 将基础路径设置为 `/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 上了。

示例： 查看 这个 pull request 获取一个 Vite 应用迁移到 Next.js 的工作示例。

步骤 9：清理

你现在可以清理代码库中与 Vite 相关的文件：

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

下一步

如果一切按计划进行，你现在就有了一个作为单页面应用运行的功能完整的 Next.js 应用。然而，你还没有利用到 Next.js 的大部分优势，但你现在可以开始进行渐进式改变来收获所有好处。以下是你可能想要做的事情：