遅延ロード

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

これにより、クライアントコンポーネントやインポートされたライブラリのロードを遅延させ、必要なときにだけクライアントバンドルに含めることができます。例えば、ユーザーがクリックして開くまでモーダルのロードを遅延させたい場合などです。

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

next/dynamic を使用したダイナミックインポート
React.lazy() と Suspense の使用

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

`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

'use client'
 
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)
)