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のどちらでも使用できます。

ステップ3：TypeScript設定を更新する

TypeScriptを使用している場合、Next.jsと互換性を持たせるために、tsconfig.jsonファイルを次の変更で更新する必要があります。TypeScriptを使用していない場合は、このステップをスキップできます。

tsconfig.node.jsonへのプロジェクト参照を削除する
./dist/types/**/*.ts と ./next-env.d.ts をinclude配列に追加する
./node_modules をexclude配列に追加する
compilerOptionsのplugins配列に { "name": "next" } を追加する: "plugins": [{ "name": "next" }]
esModuleInteropをtrueに設定する: "esModuleInterop": true
jsxをpreserveに設定する: "jsx": "preserve"
allowJsをtrueに設定する: "allowJs": true
forceConsistentCasingInFileNamesをtrueに設定する: "forceConsistentCasingInFileNames": true
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アプリケーションには、アプリケーション内のすべてのページをラップするルートレイアウトファイルを含める必要があります。このファイルはappディレクトリの最上位に定義されます。

Viteアプリケーションにおけるルートレイアウトファイルに最も近いのは、<html>、<head>、および<body>タグを含むindex.htmlファイルです。

このステップでは、index.htmlファイルをルートレイアウトファイルに変換します。

srcディレクトリ内に新しいappディレクトリを作成します。
そのappディレクトリ内に新しいlayout.tsxファイルを作成します。

app/layout.tsx

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

豆知識：レイアウトファイルには.js、.jsx、または.tsxの拡張子を使用できます。

以前作成した<RootLayout>コンポーネントにindex.htmlファイルの内容をコピーし、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などのメタデータファイルは、appディレクトリの最上位に配置されていれば、アプリケーションの<head>タグに自動的に追加されます。サポートされているすべてのファイルを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はMetadata 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の規約ベースのアプローチ（Metadata API）を使用する方法へと移行しました。このアプローチにより、ページのSEOとウェブでの共有性をより簡単に向上させることができます。

ステップ5：エントリーポイントページを作成する

Next.jsでは、page.tsxファイルを作成することでアプリケーションのエントリーポイントを宣言します。Viteにおけるこのファイルに最も近いのはmain.tsxファイルです。このステップでは、アプリケーションのエントリーポイントを設定します。

appディレクトリ内に[[...slug]]ディレクトリを作成します。

このガイドではまずNext.jsをSPA（シングルページアプリケーション）として設定することを目指しているため、アプリケーションのすべての可能なルートを捕捉するページのエントリーポイントが必要です。そのためには、appディレクトリに新しい[[...slug]]ディレクトリを作成します。

このディレクトリは、オプションのキャッチオールルートセグメントと呼ばれます。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
}

豆知識：ページファイルには.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>コンポーネントで直接使用することも、既存の<img>タグでオブジェクトのsrcプロパティを使用することもできます。

<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は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環境変数は提供されていません。ただし、必要に応じて構成することは可能です。

.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への移行が成功したかテストするためにアプリケーションを実行できるはずです。しかしその前に、package.jsonのscriptsをNext.js関連のコマンドで更新し、.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://: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ルールをサポートする