如何延遲載入客戶端元件與函式庫

Next.js 中的延遲載入 (Lazy loading) 可透過減少渲染路由所需的 JavaScript 量，來提升應用程式的初始載入效能。

它允許您延遲載入客戶端元件 (Client Components) 和導入的函式庫，僅在使用時才將其包含在客戶端套件中。例如，您可以延遲載入模態框，直到使用者點擊開啟它為止。

在 Next.js 中有兩種實現延遲載入的方式：

使用 next/dynamic 進行動態導入
使用 React.lazy() 搭配 Suspense

預設情況下，伺服器元件 (Server Components) 會自動進行程式碼分割 (code splitting)，您可以使用串流 (streaming) 逐步從伺服器傳送 UI 片段到客戶端。延遲載入適用於客戶端元件。

`next/dynamic`

next/dynamic 是 React.lazy() 和 Suspense 的組合。它在 app 和 pages 目錄中的行為相同，以支援漸進式遷移。

範例

使用 next/dynamic 時，標頭元件不會包含在頁面的初始 JavaScript 套件中。頁面會先渲染 Suspense 的 fallback，然後在 Suspense 邊界解析後渲染 Header 元件。

import dynamic from 'next/dynamic'

const DynamicHeader = dynamic(() => import('../components/header'), {
  loading: () => <p>載入中...</p>,
})

export default function Home() {
  return <DynamicHeader />
}

須知：在 import('path/to/component') 中，路徑必須明確寫出。不能是模板字串或變數。此外，import() 必須位於 dynamic() 呼叫內部，以便 Next.js 能夠將 webpack 套件/模組 ID 與特定的 dynamic() 呼叫匹配，並在渲染前預載它們。dynamic() 不能在 React 渲染內部使用，因為它需要標記在模組的頂層以實現預載功能，類似於 React.lazy。

使用具名導出

要動態導入具名導出，您可以從 import() 返回的 Promise 中返回它：

components/hello.js

export function Hello() {
  return <p>你好！</p>
}

// pages/index.js
import dynamic from 'next/dynamic'

const DynamicComponent = dynamic(() =>
  import('../components/hello').then((mod) => mod.Hello)
)

不使用 SSR

要在客戶端動態載入元件，您可以使用 ssr 選項禁用伺服器渲染。這在外部依賴或元件依賴於瀏覽器 API（如 window）時非常有用。

'use client'

import dynamic from 'next/dynamic'

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

使用外部函式庫

此範例使用外部函式庫 fuse.js 進行模糊搜尋。該模組僅在使用者在搜尋輸入框中輸入後才會在瀏覽器中載入。

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

如何延遲載入客戶端元件與函式庫

next/dynamic

範例

使用具名導出

不使用 SSR

使用外部函式庫

On this page

`next/dynamic`