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

Lazy Loading

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

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

Next.jsで遅延読み込みを実装する方法は2つあります：

  1. next/dynamicを用いたDynamic Imports
  2. React.lazy()を用いたSuspense

デフォルトでは、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 Component自体は遅延読み込みされません。 この操作により、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>
  )
}

注意： Server Componentsでは ssr: false オプションはサポートされていません。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
          // dynamicaly fune.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
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)
)