跳到内容

如何使用多区域和 Next.js 构建微前端

示例

多区域是一种微前端方法,它将域上的大型应用程序拆分为更小的 Next.js 应用程序,每个应用程序服务一组路径。当页面集合与应用程序中的其他页面无关时,这非常有用。通过将这些页面移动到单独的区域(即单独的应用程序),您可以减少每个应用程序的大小,从而缩短构建时间并删除仅对其中一个区域必要的代码。由于应用程序是解耦的,多区域还允许域上的其他应用程序使用自己的框架选择。

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

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

通过多区域支持,您可以创建三个应用程序,它们都在同一域上提供服务,并且对用户来说看起来相同,但您可以独立开发和部署每个应用程序。

Three zones: A, B, C. Showing a hard navigation between routes from different zones, and soft navigations between routes within the same zone.

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

从一个区域的页面导航到另一个区域的页面,例如从 / 导航到 /dashboard,将执行硬导航,卸载当前页面的资源并加载新页面的资源。经常一起访问的页面应该位于同一区域,以避免硬导航。

如何定义区域

区域是一个普通的 Next.js 应用程序,您还可以在其中配置一个 assetPrefix,以避免与其他区域中的页面和静态文件发生冲突。

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

Next.js 资产(例如 JavaScript 和 CSS)将以 assetPrefix 为前缀,以确保它们不会与其他区域的资产冲突。这些资产将在每个区域的 /assetPrefix/_next/... 下提供。

处理未路由到其他更具体区域的所有路径的默认应用程序不需要 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+',
        },
      ],
    }
  },
}

如何将请求路由到正确的区域

在多区域设置中,您需要将路径路由到正确的区域,因为它们由不同的应用程序提供。您可以使用任何 HTTP 代理来执行此操作,但其中一个 Next.js 应用程序也可以用于路由整个域的请求。

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

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 应该是由该区域提供的 URL,包括方案和域。这应该指向该区域的生产域,但它也可以用于在本地开发中将请求路由到 localhost

须知:URL 路径对于一个区域来说应该是唯一的。例如,两个区域试图提供 /blog 会造成路由冲突。

使用代理路由请求

建议通过 rewrites 路由请求,以最大限度地减少请求的延迟开销,但当需要在路由时进行动态决策时,也可以使用代理。例如,如果您正在使用功能标志来决定路径的路由位置,例如在迁移期间,则可以使用代理。

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

区域间链接

指向不同区域中的路径的链接应使用 a 标签而不是 Next.js 的 <Link> 组件。这是因为 Next.js 会尝试预取并软导航到 <Link> 组件中的任何相对路径,这在跨区域时不起作用。

共享代码

构成不同区域的 Next.js 应用程序可以存在于任何仓库中。然而,通常方便将这些区域放在 monorepo 中,以便更轻松地共享代码。对于位于不同仓库中的区域,也可以使用公共或私有 NPM 包共享代码。

由于不同区域中的页面可能在不同时间发布,功能标志对于在不同区域中统一启用或禁用功能非常有用。