如何懒加载 Client Components 和库

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

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

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

使用 next/dynamic 的动态导入
使用 React.lazy() 配合 Suspense

默认情况下，Server Components 会自动进行代码分割，并且你可以使用流式传输将 UI 片段从服务器逐步发送到客户端。懒加载适用于 Client Components。

`next/dynamic`

next/dynamic 是 React.lazy() 和 Suspense 的组合。它在 app 和 pages 目录中的行为方式相同，以允许增量迁移。

示例

导入 Client Components

app/page.js

'use client'
 
import { useState } from 'react'
import dynamic from 'next/dynamic'
 
// Client Components:
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>
      {/* 立即加载，但在单独的客户端 bundle 中 */}
      <ComponentA />
 
      {/* 按需加载，仅在满足条件时 */}
      {showMore && <ComponentB />}
      <button onClick={() => setShowMore(!showMore)}>Toggle</button>
 
      {/* 仅在客户端加载 */}
      <ComponentC />
    </div>
  )
}

注意： 当 Server Component 动态导入 Client Component 时，目前不支持自动代码分割。

跳过 SSR

当使用 React.lazy() 和 Suspense 时，Client Components 默认会被预渲染（SSR）。

注意： ssr: false 选项仅适用于 Client Components，将其移入 Client Components 以确保客户端代码分割正常工作。

如果你想要禁用 Client Component 的预渲染，可以使用 ssr 选项并将其设置为 false：

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

导入 Server Components

如果你动态导入一个 Server Component，只有作为 Server Component 子组件的 Client Components 会被懒加载——而不是 Server Component 本身。当你在 Server Components 中使用它时，这也有助于预加载静态资源（如 CSS）。

app/page.js

import dynamic from 'next/dynamic'
 
// Server Component:
const ServerComponent = dynamic(() => import('../components/ServerComponent'))
 
export default function ServerComponentExample() {
  return (
    <div>
      <ServerComponent />
    </div>
  )
}

注意： Server Components 中不支持 ssr: false 选项。如果你尝试在 Server Components 中使用它，会看到错误。 Server Components 中的 next/dynamic 不允许使用 ssr: false。请将其移到 Client Component 中。

加载外部库

可以使用 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="Search"
        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>Results: {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>Loading...</p>,
  }
)
 
export default function Page() {
  return (
    <div>
      {/* 在 <WithCustomLoading/> 加载时会渲染加载组件 */}
      <WithCustomLoading />
    </div>
  )
}

导入命名导出

要动态导入命名导出，你可以从 import() 函数返回的 Promise 中返回它：

components/hello.js

'use client'
 
export function Hello() {
  return <p>Hello!</p>
}

app/page.js

import dynamic from 'next/dynamic'
 
const ClientComponent = dynamic(() =>
  import('../components/hello').then((mod) => mod.Hello)
)