Viteから Next.jsへの移行方法

このガイドは、既存の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を依存関係としてインストールすることです：

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

補足: Next.js設定ファイルには.jsまたは.mjsのいずれかを使用できます。

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

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

tsconfig.node.jsonへのプロジェクト参照を削除する
include配列に./dist/types/**/*.tsと./next-env.d.tsを追加する
exclude配列に./node_modulesを追加する
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ルーターアプリケーションには、アプリケーション内のすべてのページをラップするルートレイアウトファイルが必要です。このファイルはReactサーバーコンポーネントであり、appディレクトリのトップレベルで定義されます。

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

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

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

app/layout.tsx

TypeScript

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

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>
  )
}

Next.jsにはデフォルトでmetaキャラクターセットとmetaビューポートタグが含まれているため、これらを<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>
  )
}

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>
  )
}

最後に、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ファイルです。このステップでは、アプリケーションのエントリーポイントを設定します。

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

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

このディレクトリはオプションのキャッチオールルートセグメントと呼ばれるものです。Next.jsはファイルシステムベースのルーターを使用しており、フォルダがルートの定義に使用されます。この特別なディレクトリにより、アプリケーションのすべてのルートがそのディレクトリ内のpage.tsxファイルに向けられるようになります。

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に事前レンダリングされます。

最初はクライアントのみのアプリケーションにしたいため、Appコンポーネント以下の事前レンダリングを無効にするようにNext.jsを設定できます。

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サーバーに移行したりして、画像を最適化することができます。

/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プロパティにアクセスする際に型エラーが発生する可能性があります。これらは安全に無視できます。このガイドの最後までに修正されます。

ステップ7：環境変数を移行する

Next.jsは、Viteと同様に.env環境変数をサポートしています。主な違いは、クライアント側で環境変数を公開するために使用されるプレフィックスです。

VITE_プレフィックスを持つすべての環境変数をNEXT_PUBLIC_に変更します。

Viteでは、Next.jsではサポートされていない特別なimport.meta.envオブジェクトにいくつかの組み込み環境変数を公開しています。それらの使用方法を以下のように更新する必要があります：

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', // シングルページアプリケーション（SPA）を出力します。
  distDir: './dist', // ビルド出力ディレクトリを`./dist/`に変更します。
  basePath: process.env.NEXT_PUBLIC_BASE_PATH, // ベースパスを`/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関連のコマンドで更新し、.gitignoreに.nextとnext-env.d.tsを追加する必要があります：

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関連のアーティファクトコードベースから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ルーターに移行して、以下を得ることができます：
- 自動コード分割
- ストリーミングサーバーレンダリング
- Reactサーバーコンポーネント
<Image>コンポーネントで画像を最適化する
next/fontでフォントを最適化する
<Script>コンポーネントでサードパーティスクリプトを最適化する
Next.jsのルールをサポートするようにESLint設定を更新する