NNext.js 中文网 GitHub

turbopackLazyDynamicImports

experimental

在开发环境中首次请求客户端动态导入时对其进行编译。

experimental.turbopackLazyDynamicImports 选项会将客户端动态 import() 目标的编译推迟到 next dev 期间浏览器首次请求它们时。

next.config.ts
import type { NextConfig } from 'next'

const nextConfig: NextConfig = {
  experimental: {
    turbopackLazyDynamicImports: true,
  },
}

export default nextConfig
next.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
  experimental: {
    turbopackLazyDynamicImports: true,
  },
}

module.exports = nextConfig

工作原理#

启用 turbopackLazyDynamicImports 后,Turbopack 会等待浏览器请求某个客户端动态 import() 目标的 chunk,然后再编译该目标。应用从未导入的代码在整个开发会话期间保持未编译状态。

例如,当访问者点击按钮时,此 Client Component 中的模块才会被编译:

app/greeting-button.tsx
'use client'

import { useState } from 'react'

export function GreetingButton() {
  const [message, setMessage] = useState('')

  async function showGreeting() {
    const { getGreeting } = await import('./get-greeting')
    setMessage(getGreeting('Ada'))
  }

  return (
    <>
      <button onClick={showGreeting}>Show greeting</button>
      <p>{message}</p>
    </>
  )
}
app/greeting-button.js
'use client'

import { useState } from 'react'

export function GreetingButton() {
  const [message, setMessage] = useState('')

  async function showGreeting() {
    const { getGreeting } = await import('./get-greeting')
    setMessage(getGreeting('Ada'))
  }

  return (
    <>
      <button onClick={showGreeting}>Show greeting</button>
      <p>{message}</p>
    </>
  )
}

小知识:

  • 该选项默认为 false,仅影响 next dev 期间的 Turbopack。它不会改变生产构建。
  • 延迟模块中的错误会在 Turbopack 首次编译该模块时出现。
  • 某些 next/dynamic 目标仍会被立即编译。
  • 要在服务端渲染 Client Components 时推迟所遇到的动态导入,请使用 turbopackLazyDynamicImportsSSR。

版本历史#

版本变更
v16.4.0新增 experimental.turbopackLazyDynamicImports 配置选项。
Next.js 中文网