Menu

遅延読み込み

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

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

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

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

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

next/dynamic

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

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

app/page.js
'use client'
 
import { useState } from 'react'
import dynamic from 'next/dynamic'
 
// クライアントコンポーネント:
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)}>切り替え</button>
 
      {/* クライアント側でのみ読み込む */}
      <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'
 
// サーバーコンポーネント:
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="検索"
        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>結果: {JSON.stringify(results, null, 2)}</pre>
    </div>
  )
}

カスタムローディングコンポーネントの追加

app/page.js
import dynamic from 'next/dynamic'
 
const WithCustomLoading = dynamic(
  () => import('../components/WithCustomLoading'),
  {
    loading: () => <p>読み込み中...</p>,
  }
)
 
export default function Page() {
  return (
    <div>
      {/* <WithCustomLoading/>の読み込み中、ローディングコンポーネントがレンダリングされます */}
      <WithCustomLoading />
    </div>
  )
}

名前付きエクスポートのインポート

名前付きエクスポートを動的にインポートするには、import()関数が返すPromiseからそれを返すことができます:

components/hello.js
'use client'
 
export function Hello() {
  return <p>こんにちは!</p>
}
app/page.js
import dynamic from 'next/dynamic'
 
const ClientComponent = dynamic(() =>
  import('../components/hello').then((mod) => mod.Hello)
)