NNext.js 中文网 GitHub

如何优化内存使用

优化应用程序在开发和生产环境中使用的内存。

随着应用程序变得更大、功能更丰富,在本地开发或创建生产构建时可能需要更多资源。

让我们探讨一些优化内存和解决 Next.js 中常见内存问题的策略与技巧。

减少依赖数量#

依赖数量庞大的应用程序会占用更多内存。

Bundle Analyzer 可以帮助你排查应用程序中可能可以移除的大型依赖,从而改善性能和内存使用。

尝试 experimental.webpackMemoryOptimizations#

从 v15.0.0 开始,你可以在 next.config.js 文件中添加 experimental.webpackMemoryOptimizations: true,以更改 Webpack 的行为,降低最大内存占用,但可能会略微增加编译时间。

小知识: 该功能目前处于实验阶段,希望先在更多项目上进行测试,但被认为风险较低。

使用 --experimental-debug-memory-usage 运行 next build#

从 14.2.0 开始,你可以运行 next build --experimental-debug-memory-usage,让构建以一种模式运行:Next.js 会在整个构建过程中持续打印内存使用信息,例如堆使用情况和垃圾回收统计。当内存使用接近配置的限制时,还会自动拍下堆快照。

小知识: 该功能与 Webpack build worker 选项不兼容,除非你有自定义的 webpack 配置,否则该选项会自动启用。

记录堆性能分析#

要排查内存问题,你可以从 Node.js 记录堆性能分析,并将其加载到 Chrome DevTools 中,以识别潜在的内存泄漏来源。

在终端中,启动 Next.js 构建时向 Node.js 传入 --heap-prof 标志:

sh
node --heap-prof node_modules/next/dist/bin/next build

构建结束时,Node.js 会创建一个 .heapprofile 文件。

在 Chrome DevTools 中,打开 Memory 选项卡并点击"Load Profile"按钮即可可视化该文件。

分析堆快照#

你可以使用检查器工具来分析应用程序的内存使用情况。

运行 next build 或 next dev 命令时,在命令开头添加 NODE_OPTIONS=--inspect。这会在默认端口上暴露检查器代理。 如果你希望在任何用户代码开始执行前中断,可以改用 --inspect-brk。在进程运行期间,你可以使用 Chrome DevTools 等工具连接到调试端口,记录并分析堆快照,以查看哪些内存被保留。

从 14.2.0 开始,你还可以使用 --experimental-debug-memory-usage 标志运行 next build,以便更轻松地拍下堆快照。

在此模式下运行时,你可以在任意时刻向进程发送 SIGUSR2 信号,进程会随即拍下一份堆快照。

堆快照会保存到 Next.js 应用程序的项目根目录,并可加载到任何堆分析器(如 Chrome DevTools)中,以查看哪些内存被保留。此模式目前尚不兼容 Webpack build worker。

有关更多信息,请参阅如何记录和分析堆快照。

Webpack build worker#

Webpack build worker 允许你在单独的 Node.js worker 中运行 Webpack 编译,从而降低构建期间应用程序的内存使用。

从 v14.1.0 开始,如果你的应用程序没有自定义的 Webpack 配置,该选项会默认启用。

如果你使用的是较旧版本的 Next.js,或者你有自定义的 Webpack 配置,可以通过在 next.config.js 中设置 experimental.webpackBuildWorker: true 来启用该选项。

小知识: 该功能可能与某些自定义 Webpack 插件不兼容。

禁用 Webpack 缓存#

Webpack 缓存会将生成的 Webpack 模块保存在内存和/或磁盘中,以提高构建速度。这有助于提升性能,但也会增加应用程序的内存使用,以存储缓存数据。

你可以通过在应用程序中添加自定义 Webpack 配置来禁用此行为:

next.config.mjs
/** @type {import('next').NextConfig} */
const nextConfig = {
  webpack: (
    config,
    { buildId, dev, isServer, defaultLoaders, nextRuntime, webpack }
  ) => {
    if (config.cache && !dev) {
      config.cache = Object.freeze({
        type: 'memory',
      })
    }
    // 重要:返回修改后的配置
    return config
  },
}

export default nextConfig

禁用静态分析#

类型检查可能需要大量内存,尤其是在大型项目中。 不过,大多数项目都有专门的 CI 运行器来处理这些任务。 当构建在"Running TypeScript"步骤中出现内存不足问题时,你可以在构建期间禁用该任务:

next.config.mjs
/** @type {import('next').NextConfig} */
const nextConfig = {
  typescript: {
    // !! 警告 !!
    // 危险:即使你的项目存在类型错误,
    // 也允许生产构建成功完成。
    // !! 警告 !!
    ignoreBuildErrors: true,
  },
}

export default nextConfig

请记住,这可能会因类型错误而产生有问题的部署。 我们强烈建议仅在静态分析完成后才将构建提升到生产环境。 如果你部署到 Vercel,可以查看暂存部署指南,了解如何在自定义任务成功后将构建提升到生产环境。

禁用 source map#

生成 source map 会在构建过程中消耗额外的内存。

你可以通过在 Next.js 配置中添加 productionBrowserSourceMaps: false 和 experimental.serverSourceMaps: false 来禁用 source map 生成。

在 next build 的预渲染阶段,Next.js 默认会使用 source map。 如果你在该阶段("Generating static pages"之后)持续遇到内存问题,可以尝试在 Next.js 配置中添加 enablePrerenderSourceMaps: false,以在该阶段禁用 source map。

小知识: 某些插件可能会启用 source map,可能需要自定义配置才能禁用。

Edge 内存问题#

Next.js v14.1.3 修复了使用 Edge 运行时时的内存问题。请更新到该版本(或更高版本),看看是否能解决你的问题。

预加载入口#

当 Next.js 服务器启动时,它会将每个页面的 JavaScript 模块预加载到内存中,而不是在请求时才加载。

这种优化可以加快响应时间,但代价是更大的初始内存占用。

要禁用此优化,请将 experimental.preloadEntriesOnStart 标志设为 false。

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

const config: NextConfig = {
  experimental: {
    preloadEntriesOnStart: false,
  },
}

export default config
next.config.mjs
/** @type {import('next').NextConfig} */
const config = {
  experimental: {
    preloadEntriesOnStart: false,
  },
}

export default config

Next.js 不会卸载这些 JavaScript 模块,这意味着即使禁用了此优化,如果最终所有页面都被请求过,Next.js 服务器的内存占用最终也会相同。

Next.js 中文网