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

Lazy Loading

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

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

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

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

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

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

Note: server componentがclient componentを動的にインポートする場合、自動的なコード分割は現在サポートされていません。

SSRのスキップ​

React.lazy()とSuspenseを使用する場合、client componentはデフォルトでプリレンダリング（SSR）されます。

Note: ssr: falseオプションはclient componentでのみ機能し、クライアントのコード分割が適切に動作するようにclient componentに移動してください。

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

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

Server Componentsのインポート​

server componentを動的にインポートする場合、そのserver componentの子であるclient componentのみが遅延ロードされます。server component自体は遅延ロードされません。 また、server componentで使用する場合、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>
  )
}

Note: server componentではssr: falseオプションはサポートされていません。server componentで使用しようとするとエラーが表示されます。 ssr: falseはserver componentでnext/dynamicと共に使用することはできません。client componentに移動してください。

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

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