跳到內容
Pages 路由指南延遲載入

如何延遲載入客戶端元件和庫

Next.js 中的延遲載入透過減少渲染路由所需的 JavaScript 數量,有助於提高應用程式的初始載入效能。

next/dynamic

next/dynamicReact.lazy()Suspense 的組合。它在 apppages 目錄中的行為方式相同,以實現增量遷移。

在下面的示例中,透過使用 next/dynamic,頁面的初始 JavaScript 包將不包含頁首元件。頁面將首先渲染 Suspense fallback,然後在 Suspense 邊界解析時渲染 Header 元件。

import dynamic from 'next/dynamic'
 
const DynamicHeader = dynamic(() => import('../components/header'), {
  loading: () => <p>Loading...</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>Hello!</p>
}
 
// pages/index.js
import dynamic from 'next/dynamic'
 
const DynamicComponent = dynamic(() =>
  import('../components/hello').then((mod) => mod.Hello)
)

不帶 SSR

要在客戶端動態載入元件,您可以使用 ssr 選項停用伺服器渲染。如果外部依賴項或元件依賴於 window 等瀏覽器 API,這會很有用。

'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="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>
  )
}