メインコンテンツまでスキップ

Lazy Loading

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

これは、Client Componentsやインポートされたライブラリの読み込みを遅らせ、必要なときにのみクライアントバンドルに含めることを可能にします。たとえば、ユーザーがモーダルを開くまでその読み込みを遅らせたい場合があります。

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

  1. next/dynamicを使用したDynamic Imports
  2. Suspenseと共にReact.lazy()を使用

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

next/dynamic​

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

例​

Client Componentsのインポート​

app/page.js
'use client'

import { useState } from 'react'
import dynamic from 'next/dynamic'

// Client Components:
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を使用する場合、Client Componentsはデフォルトで事前レンダリング（SSR）されます。

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

Client Componentの事前レンダリングを無効にしたい場合は、ssrオプションをfalseに設定できます：

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

Server Componentsのインポート​

Server Componentを動的にインポートする場合、Server Component自体ではなく、その子であるClient Componentsのみが遅延ロードされます。 また、Server Componentsで使用する際にCSSなどの静的アセットを事前ロードするのにも役立ちます。

app/page.js
import dynamic from 'next/dynamic'

// Server Component:
const ServerComponent = dynamic(() => import('../components/ServerComponent'))

export default function ServerComponentExample() {
  return (
    <div>
      <ServerComponent />
    </div>
  )
}

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

外部ライブラリのロード​

外部ライブラリは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)
)