NNext.js 中文网 GitHub

turbopackLazyDynamicImportsSSR

experimental

在开发环境下,当服务端渲染首次遇到动态导入时对其进行编译。

experimental.turbopackLazyDynamicImportsSSR 选项会推迟编译动态导入,直到 next dev 期间服务端渲染首次遇到它们。

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

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

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

module.exports = nextConfig

工作原理#

Client Components 可以使用 lazy 动态加载组件。启用 turbopackLazyDynamicImportsSSR 后,Turbopack 会在服务端渲染首次遇到某个导入的组件时对其进行编译。未被渲染的目标则保持未编译状态。

在以下示例中,当 showPreview 在服务端渲染期间为 true 时,Turbopack 会编译 Preview:

app/preview.tsx
'use client'

import { lazy } from 'react'

const Preview = lazy(() => import('./preview-panel'))

export function MaybePreview({ showPreview }: { showPreview: boolean }) {
  return showPreview ? <Preview /> : null
}
app/preview.js
'use client'

import { lazy } from 'react'

const Preview = lazy(() => import('./preview-panel'))

export function MaybePreview({ showPreview }) {
  return showPreview ? <Preview /> : null
}

小知识:

  • 该选项默认为 false,仅影响 next dev 期间使用 Turbopack 的 Node.js 运行时。它不会改变生产构建。
  • 要将客户端动态导入推迟到浏览器请求它们时,请使用 turbopackLazyDynamicImports。

版本历史#

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