Menu

output

在构建过程中,Next.js 会自动追踪每个页面及其依赖项,以确定部署生产版本应用程序所需的所有文件。

此功能有助于大幅减少部署的大小。以前,在使用 Docker 部署时,你需要安装包的 dependencies 中的所有文件以运行 next start。从 Next.js 12 开始,你可以利用 .next/ 目录中的输出文件追踪功能,仅包含必要的文件。

此外,这消除了对已弃用的 serverless 目标的需求,该目标可能导致各种问题并产生不必要的重复。

工作原理

next build 期间,Next.js 将使用 @vercel/nft 静态分析 importrequirefs 的使用,以确定页面可能加载的所有文件。

Next.js 的生产服务器也会被追踪其所需的文件,并输出到 .next/next-server.js.nft.json,这在生产中可以利用。

要利用发送到 .next 输出目录的 .nft.json 文件,你可以读取每个追踪中相对于 .nft.json 文件的文件列表,然后将它们复制到你的部署位置。

自动复制追踪文件

Next.js 可以自动创建一个 standalone 文件夹,仅复制生产部署所需的必要文件,包括 node_modules 中的选定文件。

要利用此自动复制功能,可以在 next.config.js 中启用它:

next.config.js
module.exports = {
  output: "standalone",
};

这将在 .next/standalone 创建一个文件夹,然后可以独立部署,无需安装 node_modules

此外,还会输出一个最小的 server.js 文件,可以用它代替 next start。默认情况下,此最小服务器不会复制 public.next/static 文件夹,因为这些文件夹应由 CDN 处理,尽管可以手动将这些文件夹复制到 standalone/publicstandalone/.next/static 文件夹中,之后 server.js 文件将自动提供这些文件。

值得注意的是:

  • 如果你的项目需要监听特定端口或主机名,可以在运行 server.js 之前定义 PORTHOSTNAME 环境变量。例如,运行 PORT=8080 HOSTNAME=0.0.0.0 node server.js 以在 http://0.0.0.0:8080 上启动服务器。

注意事项

  • 在 monorepo 设置中进行追踪时,默认情况下使用项目目录进行追踪。对于 next build packages/web-apppackages/web-app 将是追踪根目录,该文件夹外的任何文件都不会被包含。要包含该文件夹外的文件,可以在 next.config.js 中设置 experimental.outputFileTracingRoot
packages/web-app/next.config.js
module.exports = {
  experimental: {
    // 这包括从 monorepo 基础目录向上两级的文件
    outputFileTracingRoot: path.join(__dirname, "../../"),
  },
};
  • 在某些情况下,Next.js 可能无法包含所需的文件,或者可能错误地包含未使用的文件。在这些情况下,可以在 next.config.js 中分别利用 experimental.outputFileTracingExcludesexperimental.outputFileTracingIncludes。每个配置接受一个对象,其中 minimatch 全局模式 用于匹配特定页面,值为相对于项目根目录的数组全局模式,以在追踪中包含或排除。
next.config.js
module.exports = {
  experimental: {
    outputFileTracingExcludes: {
      "/api/hello": ["./un-necessary-folder/**/*"],
    },
    outputFileTracingIncludes: {
      "/api/another": ["./necessary-folder/**/*"],
    },
  },
};
  • 目前,Next.js 不会对发出的 .nft.json 文件做任何处理。这些文件必须由你的部署平台读取,例如 Vercel,以创建最小的部署。在未来的版本中,计划新增一个命令来利用这些 .nft.json 文件。

实验性 turbotrace

追踪依赖项可能会很慢,因为它需要非常复杂的计算和分析。我们创建了 turbotrace 作为 Rust 中更快、更智能的替代 JavaScript 实现。

要启用它,可以在 next.config.js 中添加以下配置:

next.config.js
module.exports = {
  experimental: {
    turbotrace: {
      // 控制 turbotrace 的日志级别,默认为 `error`
      logLevel?:
      | 'bug'
      | 'fatal'
      | 'error'
      | 'warning'
      | 'hint'
      | 'note'
      | 'suggestions'
      | 'info',
      // 控制 turbotrace 的日志是否包含分析的详细信息,默认为 `false`
      logDetail?: boolean
      // 显示所有日志消息而不限制
      // turbotrace 默认只显示每个类别的 1 条日志消息
      logAll?: boolean
      // 控制 turbotrace 的上下文目录
      // 上下文目录外的文件不会被追踪
      // 设置 `experimental.outputFileTracingRoot` 有相同的效果
      // 如果 `experimental.outputFileTracingRoot` 和此选项都设置,将使用 `experimental.turbotrace.contextDirectory`
      contextDirectory?: string
      // 如果你的代码中有 `process.cwd()` 表达式,可以设置此选项告诉 `turbotrace` 在追踪时 `process.cwd()` 的值。
      // 例如 require(process.cwd() + '/package.json') 将被追踪为 require('/path/to/cwd/package.json')
      processCwd?: string
      // 控制 turbotrace 的最大内存使用量,以 `MB` 为单位,默认为 `6000`。
      memoryLimit?: number
    },
  },
}