遅延読み込み

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

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

Next.jsで遅延読み込みを実装するには、2つの方法があります。

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

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

`next/dynamic`

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

例

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

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>
      {/* Load immediately, but in a separate client bundle */}
      <ComponentA />
 
      {/* Load on demand, only when/if the condition is met */}
      {showMore && <ComponentB />}
      <button onClick={() => setShowMore(!showMore)}>Toggle</button>
 
      {/* Load only on the client side */}
      <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'
 
// Server Component:
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
          // Dynamically load 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

import dynamic from 'next/dynamic'
 
const WithCustomLoading = dynamic(
  () => import('../components/WithCustomLoading'),
  {
    loading: () => <p>Loading...</p>,
  }
)
 
export default function Page() {
  return (
    <div>
      {/* The loading component will be rendered while  <WithCustomLoading/> is loading */}
      <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)
)