如何延遲載入客戶端組件和函式庫

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

它允許您延遲載入客戶端組件 (Client Components) 和導入的函式庫，僅在需要時才將它們包含在客戶端套件中。例如，您可能希望延遲載入模態框，直到用戶點擊打開它。

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

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

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

`next/dynamic`

next/dynamic 是 React.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>
  )
}

注意： 當伺服器組件動態導入客戶端組件時，目前不支援自動程式碼分割 (code splitting)。

跳過 SSR

使用 React.lazy() 和 Suspense 時，客戶端組件預設會進行預渲染 (prerendered) (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 選項。如果您嘗試在伺服器組件中使用它，將會看到錯誤。 ssr: false 不允許在伺服器組件中使用 next/dynamic。請將其移至客戶端組件。

載入外部函式庫

可以使用 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

'use client'

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

如何延遲載入客戶端組件和函式庫

On this page