クライアントコンポーネントとライブラリを遅延ロードする方法

Next.jsにおける遅延ロードは、ルートをレンダリングするために必要なJavaScriptの量を減らすことで、アプリケーションの初期読み込みパフォーマンスを向上させます。

これにより、クライアントコンポーネントとインポートされたライブラリの読み込みを遅らせ、必要になったときだけクライアントバンドルに含めることができます。例えば、ユーザーがモーダルを開くボタンをクリックするまで、そのモーダルの読み込みを遅らせたい場合などに有効です。

Next.jsで遅延ロードを実装するには2つの方法があります：

next/dynamicを使用した動的インポート
SuspenseとReact.lazy()の使用

デフォルトでは、サーバーコンポーネントは自動的にコード分割され、ストリーミングを使用してUIの断片をサーバーからクライアントに段階的に送信することができます。遅延ロードはクライアントコンポーネントに適用されます。

`next/dynamic`

next/dynamicはReact.lazy()とSuspenseを組み合わせたものです。段階的な移行を可能にするため、appディレクトリとpagesディレクトリで同じように動作します。

例

クライアントコンポーネントのインポート

app/page.js

'use client'
 
import { useState } from 'react'
import dynamic from 'next/dynamic'
 
// クライアントコンポーネント:
const ComponentA = dynamic(() => import('../components/A'))
const ComponentB = dynamic(() => import('../components/B'))
const ComponentC = dynamic(() => import('../components/C'), { ssr: false })
 
export default function ClientComponentExample() {
  const [showMore, setShowMore] = useState(false)
 
  return (
    <div>
      {/* すぐに読み込むが、別のクライアントバンドルとして */}
      <ComponentA />
 
      {/* 条件が満たされた場合にのみ、必要に応じて読み込む */}
      {showMore && <ComponentB />}
      <button onClick={() => setShowMore(!showMore)}>Toggle</button>
 
      {/* クライアントサイドでのみ読み込む */}
      <ComponentC />
    </div>
  )
}

注意: サーバーコンポーネントがクライアントコンポーネントを動的にインポートする場合、自動的なコード分割は現在サポートされていません。

SSRのスキップ

React.lazy()とSuspenseを使用する場合、クライアントコンポーネントはデフォルトでプリレンダリング(SSR)されます。

注意: ssr: falseオプションはクライアントコンポーネントでのみ機能します。クライアントのコード分割が適切に機能するようにするには、クライアントコンポーネント内で使用してください。

クライアントコンポーネントのプリレンダリングを無効にしたい場合は、ssrオプションをfalseに設定できます：

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

サーバーコンポーネントのインポート

サーバーコンポーネントを動的にインポートする場合、サーバーコンポーネント自体ではなく、そのサーバーコンポーネントの子であるクライアントコンポーネントのみが遅延ロードされます。また、サーバーコンポーネントで使用する場合、CSSなどの静的アセットのプリロードにも役立ちます。

app/page.js

import dynamic from 'next/dynamic'
 
// サーバーコンポーネント:
const ServerComponent = dynamic(() => import('../components/ServerComponent'))
 
export default function ServerComponentExample() {
  return (
    <div>
      <ServerComponent />
    </div>
  )
}

注意: ssr: falseオプションはサーバーコンポーネントではサポートされていません。サーバーコンポーネントで使用しようとするとエラーが表示されます。サーバーコンポーネントではnext/dynamicとssr: falseの使用は許可されていません。クライアントコンポーネントに移動してください。

外部ライブラリの読み込み

外部ライブラリはimport()関数を使用してオンデマンドで読み込むことができます。この例では、あいまい検索のために外部ライブラリfuse.jsを使用しています。モジュールはユーザーが検索入力に入力した後にクライアントでのみ読み込まれます。

app/page.js

'use client'
 
import { useState } from 'react'
 
const names = ['Tim', 'Joe', 'Bel', 'Lee']
 
export default function Page() {
  const [results, setResults] = useState()
 
  return (
    <div>
      <input
        type="text"
        placeholder="Search"
        onChange={async (e) => {
          const { value } = e.currentTarget
          // fuse.jsを動的に読み込む
          const Fuse = (await import('fuse.js')).default
          const fuse = new Fuse(names)
 
          setResults(fuse.search(value))
        }}
      />
      <pre>Results: {JSON.stringify(results, null, 2)}</pre>
    </div>
  )
}

カスタムローディングコンポーネントの追加

app/page.js

'use client'
 
import dynamic from 'next/dynamic'
 
const WithCustomLoading = dynamic(
  () => import('../components/WithCustomLoading'),
  {
    loading: () => <p>Loading...</p>,
  }
)
 
export default function Page() {
  return (
    <div>
      {/* <WithCustomLoading/>が読み込まれている間、ローディングコンポーネントが表示されます */}
      <WithCustomLoading />
    </div>
  )
}

名前付きエクスポートのインポート

名前付きエクスポートを動的にインポートするには、import()関数によって返されるPromiseからそれを返すことができます：

components/hello.js

'use client'
 
export function Hello() {
  return <p>Hello!</p>
}

app/page.js

import dynamic from 'next/dynamic'
 
const ClientComponent = dynamic(() =>
  import('../components/hello').then((mod) => mod.Hello)
)