如何懒加载客户端组件与库

Next.js 中的懒加载通过减少渲染路由所需的 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 目录中的行为相同，以支持渐进式迁移。

示例

导入客户端组件

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