NNext.js 中文网 GitHub

如何使用多区域(Multi-Zones)和 Next.js 构建微前端

了解如何使用 Next.js 多区域(Multi-Zones)构建微前端,在单个域名下部署多个 Next.js 应用。

<details open> <summary>示例</summary>

</details>

Multi-Zones 是一种微前端方法,它将某个域名上的大型应用拆分为多个较小的 Next.js 应用,每个应用负责提供一组路径。当应用中存在与其他页面无关的一组页面时,这种方法很有用。通过将这些页面移动到单独的 zone(即单独的应用程序),你可以减小每个应用的体积,从而缩短构建时间,并移除仅对某个 zone 必要的代码。由于应用程序彼此解耦,Multi-Zones 还允许域名上的其他应用使用自己选择的框架。

例如,假设你有以下一组想要拆分的页面:

  • /blog/* 用于所有博客文章
  • /dashboard/* 用于用户登录仪表盘后的所有页面
  • /* 用于网站中未被其他 zone 覆盖的其余部分

借助 Multi-Zones 支持,你可以创建三个应用,它们都在同一个域名上提供服务,对用户来说看起来一样,但你可以独立开发和部署每个应用。

在同一 zone 内的页面之间导航会执行软导航,即无需重新加载页面的导航。例如,在此图中,从 / 导航到 /products 将是软导航。

从一个 zone 的页面导航到另一个 zone 的页面(例如从 / 到 /dashboard)会执行硬导航,卸载当前页面的资源并加载新页面的资源。经常一起访问的页面应放在同一个 zone 中,以避免硬导航。

如何定义 zone#

zone 就是一个普通的 Next.js 应用程序,你还需要配置 assetPrefix 以避免与其他 zone 中的页面和静态文件冲突。

next.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
  assetPrefix: '/blog-static',
}

Next.js 的资源(如 JavaScript 和 CSS)将添加 assetPrefix 前缀,以确保它们不会与其他 zone 的资源冲突。这些资源将在每个 zone 的 /assetPrefix/_next/... 路径下提供。

处理所有未被路由到更具体 zone 的路径的默认应用不需要 assetPrefix。

在早于 Next.js 15 的版本中,你可能还需要额外的重写规则来处理静态资源。在 Next.js 15 中不再需要这样做。

next.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
  assetPrefix: '/blog-static',
  async rewrites() {
    return {
      beforeFiles: [
        {
          source: '/blog-static/_next/:path+',
          destination: '/_next/:path+',
        },
      ],
    }
  },
}

如何将请求路由到正确的 zone#

在 Multi Zones 设置中,由于路径由不同的应用程序提供服务,你需要将路径路由到正确的 zone。你可以使用任何 HTTP proxy 来实现这一点,但也可以使用其中一个 Next.js 应用程序来路由整个域名的请求。

要使用 Next.js 应用程序路由到正确的 zone,可以使用 rewrites。对于每个由不同 zone 提供服务的路径,你需要添加一条重写规则,将该路径发送到另一个 zone 的域名,还需要重写静态资源的请求。例如:

next.config.js
async rewrites() {
    return [
        {
            source: '/blog',
            destination: `${process.env.BLOG_DOMAIN}/blog`,
        },
        {
            source: '/blog/:path+',
            destination: `${process.env.BLOG_DOMAIN}/blog/:path+`,
        },
        {
            source: '/blog-static/:path+',
            destination: `${process.env.BLOG_DOMAIN}/blog-static/:path+`,
        }
    ];
}

destination 应该是由该 zone 提供服务的 URL,包括协议和域名。它应指向该 zone 的生产域名,但在本地开发中也可用于将请求路由到 localhost。

小知识:URL 路径应对某个 zone 保持唯一。例如,两个 zone 都试图提供 /blog 会造成路由冲突。

使用 proxy 路由请求#

建议通过 rewrites 路由请求,以最大程度减少请求的延迟开销,但当路由时需要动态决策时也可以使用 proxy。例如,如果你在迁移期间使用功能标志来决定某个路径应路由到哪里,可以使用 proxy。

proxy.js
export async function proxy(request) {
  const { pathname, search } = request.nextUrl
  if (pathname === '/your-path' && myFeatureFlag.isEnabled()) {
    return NextResponse.rewrite(`${rewriteDomain}${pathname}${search}`)
  }
}

zone 之间的链接#

指向其他 zone 中路径的链接应使用 a 标签,而不是 Next.js 的 <Link> 组件。这是因为 Next.js 会尝试对 <Link> 组件中的任何相对路径进行预取和软导航,而这无法跨 zone 工作。

共享代码#

构成不同 zone 的 Next.js 应用可以位于任何仓库中。不过,通常将这些 zone 放在 monorepo 中会更便于共享代码。对于位于不同仓库中的 zone,也可以使用公共或私有的 NPM 包来共享代码。

由于不同 zone 中的页面可能在不同时间发布,功能标志可用于在不同 zone 中同时启用或禁用功能。

Server Actions#

在 Multi-Zones 中使用 Server Actions 时,你必须显式允许面向用户的来源,因为面向用户的域名可能服务于多个应用。在 next.config.js 文件中添加以下几行:

next.config.js
const nextConfig = {
  experimental: {
    serverActions: {
      allowedOrigins: ['your-production-domain.com'],
    },
  },
}

有关更多信息,请参阅 experimental.serverActions.allowedOrigins。

Next.js 中文网