How to self-host your Next.js application

在部署你的 Next.js 应用时，你可能希望根据你的基础设施配置不同功能的处理方式。

🎥 观看： 了解更多关于自托管 Next.js → YouTube（45 分钟）。

图像优化

通过 next/image 进行的图像优化在使用 next start 部署时无需配置即可自托管。如果你更喜欢使用单独的服务来优化图像，你可以配置图像加载器。

图像优化可以通过在 next.config.js 中定义自定义图像加载器与静态导出一起使用。注意，图像是在运行时优化的，而不是在构建过程中。

值得注意的是：

• 在基于 glibc 的 Linux 系统上，图像优化可能需要额外配置以防止过度内存使用。
• 了解更多关于优化图像的缓存行为以及如何配置 TTL。
• 如果你愿意，你也可以禁用图像优化，同时保留使用 next/image 的其他好处。例如，如果你自己单独优化图像。

中间件

中间件在使用 next start 部署时无需配置即可自托管。由于它需要访问传入的请求，因此在使用静态导出时不支持。

中间件使用运行时，这是所有可用 Node.js API 的一个子集，有助于确保低延迟，因为它可能在应用程序的每个路由或资源前运行。如果你不想这样，你可以使用完整的 Node.js 运行时来运行中间件。

如果你想添加需要所有 Node.js API 的逻辑（或使用外部包），你可能可以将此逻辑移到布局中作为服务器组件。例如，检查头部和重定向。你还可以使用头部、cookie 或查询参数通过 next.config.js 进行重定向或重写。如果这些方法都不起作用，你还可以使用自定义服务器。

环境变量

Next.js 可以支持构建时和运行时环境变量。

默认情况下，环境变量仅在服务器上可用。要将环境变量暴露给浏览器，必须以 NEXT_PUBLIC_ 为前缀。但是，这些公共环境变量将在 next build 期间内联到 JavaScript 包中。

你可以在动态渲染期间安全地在服务器上读取环境变量。

import { connection } from 'next/server'
 
export default async function Component() {
  await connection()
  // cookies, headers, and other Dynamic APIs
  // will also opt into dynamic rendering, meaning
  // this env variable is evaluated at runtime
  const value = process.env.MY_VALUE
  // ...
}

这允许你使用单一的 Docker 镜像，可以在具有不同值的多个环境中推广。

值得注意的是：

• 你可以使用register 函数在服务器启动时运行代码。
• 我们不建议使用runtimeConfig选项，因为它不适用于独立输出模式。相反，我们建议逐步采用 App Router。

缓存和 ISR

Next.js 可以缓存响应、生成的静态页面、构建输出以及其他静态资源，如图像、字体和脚本。

缓存和重新验证页面（使用增量静态再生成）使用相同的共享缓存。默认情况下，此缓存存储在 Next.js 服务器的文件系统（磁盘）上。这在使用 Pages 和 App Router 自托管时自动工作。

如果你想将缓存的页面和数据持久化到持久存储中，或者在 Next.js 应用程序的多个容器或实例之间共享缓存，你可以配置 Next.js 缓存位置。

自动缓存

• Next.js 为真正不可变的资源设置 Cache-Control 头为 public, max-age=31536000, immutable。这不能被覆盖。这些不可变文件在文件名中包含 SHA 哈希值，因此可以安全地无限期缓存。例如，静态图像导入。你可以配置图像的 TTL。
• 增量静态再生成（ISR）设置 Cache-Control 头为 s-maxage: <revalidate in getStaticProps>, stale-while-revalidate。这个重新验证时间在你的getStaticProps 函数中以秒为单位定义。如果你设置 revalidate: false，它将默认为一年的缓存持续时间。
• 动态渲染的页面设置 Cache-Control 头为 private, no-cache, no-store, max-age=0, must-revalidate，以防止用户特定数据被缓存。这适用于 App Router 和 Pages Router。这也包括草稿模式。

静态资源

如果你想在不同的域名或 CDN 上托管静态资源，你可以在 next.config.js 中使用 assetPrefix 配置。Next.js 将在检索 JavaScript 或 CSS 文件时使用此资源前缀。将资源分离到不同的域名会带来额外的 DNS 和 TLS 解析时间的缺点。

了解更多关于 assetPrefix。

配置缓存

默认情况下，生成的缓存资源将存储在内存中（默认为 50mb）和磁盘上。如果你使用 Kubernetes 等容器编排平台托管 Next.js，每个 pod 将有一个缓存副本。为了防止由于缓存默认不在 pod 之间共享而显示过时数据，你可以配置 Next.js 缓存以提供缓存处理程序并禁用内存中缓存。

要在自托管时配置 ISR/数据缓存位置，你可以在 next.config.js 文件中配置自定义处理程序：

module.exports = {
  cacheHandler: require.resolve('./cache-handler.js'),
  cacheMaxMemorySize: 0, // disable default in-memory caching
}

然后，在项目根目录创建 cache-handler.js，例如：

const cache = new Map()
 
module.exports = class CacheHandler {
  constructor(options) {
    this.options = options
  }
 
  async get(key) {
    // This could be stored anywhere, like durable storage
    return cache.get(key)
  }
 
  async set(key, data, ctx) {
    // This could be stored anywhere, like durable storage
    cache.set(key, {
      value: data,
      lastModified: Date.now(),
      tags: ctx.tags,
    })
  }
 
  async revalidateTag(tags) {
    // tags is either a string or an array of strings
    tags = [tags].flat()
    // Iterate over all entries in the cache
    for (let [key, value] of cache) {
      // If the value's tags include the specified tag, delete this entry
      if (value.tags.some((tag) => tags.includes(tag))) {
        cache.delete(key)
      }
    }
  }
 
  // If you want to have temporary in memory cache for a single request that is reset
  // before the next request you can leverage this method
  resetRequestCache() {}
}

使用自定义缓存处理程序将允许你确保托管 Next.js 应用程序的所有 pod 之间的一致性。例如，你可以将缓存值保存在任何地方，如 Redis 或 AWS S3。

值得注意的是：

• revalidatePath 是缓存标签之上的便捷层。调用 revalidatePath 将以提供页面的特殊默认标签调用 revalidateTag 函数。

构建缓存

Next.js 在 next build 期间生成一个 ID 来标识正在提供的应用程序版本。同一构建应该用于启动多个容器。

如果你为环境的每个阶段重新构建，你需要生成一个一致的构建 ID 在容器之间使用。使用 next.config.js 中的 generateBuildId 命令：

module.exports = {
  generateBuildId: async () => {
    // This could be anything, using the latest git hash
    return process.env.GIT_HASH
  },
}

版本偏差

Next.js 将自动缓解大多数版本偏差的情况，并在检测到时自动重新加载应用程序以检索新资源。例如，如果 deploymentId 不匹配，页面之间的转换将执行硬导航，而不是使用预取值。

当应用程序重新加载时，如果应用程序状态未设计为在页面导航之间持久化，则可能会丢失应用程序状态。例如，使用 URL 状态或本地存储会在页面刷新后保持状态。但是，像 useState 这样的组件状态会在这种导航中丢失。

流式传输和 Suspense

Next.js App Router 支持自托管时的流式响应。如果你使用 Nginx 或类似的代理，你需要配置它以禁用缓冲以启用流式传输。

例如，你可以通过将 X-Accel-Buffering 设置为 no 来禁用 Nginx 中的缓冲：

module.exports = {
  async headers() {
    return [
      {
        source: '/:path*{/}?',
        headers: [
          {
            key: 'X-Accel-Buffering',
            value: 'no',
          },
        ],
      },
    ]
  },
}

部分预渲染

部分预渲染（实验性）默认与 Next.js 一起工作，不仅仅是 CDN 功能。这包括通过 next start 部署为 Node.js 服务器以及与 Docker 容器一起使用时。

与 CDN 一起使用

当在 Next.js 应用程序前面使用 CDN 时，访问动态 API 时页面将包含 Cache-Control: private 响应头。这确保生成的 HTML 页面被标记为不可缓存。如果页面完全预渲染为静态，它将包含 Cache-Control: public 以允许页面在 CDN 上缓存。

如果你不需要静态和动态组件的混合，你可以使整个路由变为静态并在 CDN 上缓存输出 HTML。当运行 next build 且不使用动态 API 时，这种自动静态优化是默认行为。

随着部分预渲染变得稳定，我们将通过部署适配器 API 提供支持。

after

在使用 next start 自托管时，完全支持after。

停止服务器时，通过发送 SIGINT 或 SIGTERM 信号并等待，确保优雅关闭。这允许 Next.js 服务器等待，直到 after 中使用的待处理回调函数或承诺完成。