跳到主要内容

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

Next.js 中的懒加载通过减少渲染路由所需的 JavaScript 量来帮助提高应用程序的初始加载性能。

它允许您延迟加载客户端组件和导入的库，并且仅在需要时才将它们包含在客户端包中。例如，您可能想要延迟加载模态框，直到用户点击打开它。

在 Next.js 中有两种实现懒加载的方法：

  1. 使用 next/dynamic 的动态导入
  2. 使用 React.lazy() 和 Suspense

默认情况下，服务器组件会自动进行代码分割，您可以使用流式渲染逐步将 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>
  )
}

注意： 当服务器组件动态导入客户端组件时，目前不支持自动代码分割。

跳过 SSR​

使用 React.lazy() 和 Suspense 时，客户端组件默认会被预渲染（SSR）。

注意： ssr: false 选项仅适用于客户端组件，将其移动到客户端组件中以确保客户端代码分割正常工作。

如果您想禁用客户端组件的预渲染，可以使用设置为 false 的 ssr 选项：

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 选项。如果您尝试在服务器组件中使用它，您将看到错误。 服务器组件中不允许使用 next/dynamic 的 ssr: false。请将其移动到客户端组件中。

加载外部库​

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

通过使用 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 选项禁用服务器端渲染。如果外部依赖项或组件依赖于 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="搜索"
        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>
  )
}
最后于 更新