遅延読み込み (Lazy Loading)
Next.jsの遅延読み込みは、ルートをレンダリングするために必要なJavaScriptの量を減らすことで、アプリケーションの初期読み込みパフォーマンスを向上させます。
クライアントコンポーネント (Client Components) やインポートされたライブラリの読み込みを遅延させ、必要な時だけクライアントバンドルに含めることができます。例えば、ユーザーがクリックするまでモーダルの読み込みを遅らせることができます。
Next.jsで遅延読み込みを実装する方法は2つあります:
next/dynamic
を使用した動的インポートReact.lazy()
と Suspense の使用
デフォルトでは、サーバーコンポーネントは自動的にコード分割され、ストリーミングを使用してサーバーからクライアントへUIを段階的に送信できます。遅延読み込みはクライアントコンポーネントに適用されます。
next/dynamic
next/dynamic
は React.lazy()
と Suspense の複合体です。app
と pages
ディレクトリで同じように動作し、段階的な移行を可能にします。
例
クライアントコンポーネントのインポート
'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)}>Toggle</button>
{/* クライアント側でのみ読み込み */}
<ComponentC />
</div>
)
}
SSRのスキップ
React.lazy()
と Suspense を使用する場合、クライアントコンポーネントはデフォルトでプリレンダリング(SSR)されます。
クライアントコンポーネントのプリレンダリングを無効にしたい場合は、ssr
オプションを false
に設定します:
const ComponentC = dynamic(() => import('../components/C'), { ssr: false })
サーバーコンポーネントのインポート
サーバーコンポーネントを動的にインポートする場合、サーバーコンポーネント自体ではなく、その子クライアントコンポーネントのみが遅延読み込みされます。
import dynamic from 'next/dynamic'
// サーバーコンポーネント:
const ServerComponent = dynamic(() => import('../components/ServerComponent'))
export default function ServerComponentExample() {
return (
<div>
<ServerComponent />
</div>
)
}
外部ライブラリの読み込み
外部ライブラリは import()
関数を使用してオンデマンドで読み込めます。この例では、ファジー検索のために外部ライブラリ fuse.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>
)
}
カスタムローディングコンポーネントの追加
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から返します:
'use client'
export function Hello() {
return <p>Hello!</p>
}
import dynamic from 'next/dynamic'
const ClientComponent = dynamic(() =>
import('../components/hello').then((mod) => mod.Hello)
)