Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

微前端的几种架构介绍 #32

Open
Bulandent opened this issue Feb 2, 2024 · 0 comments
Open

微前端的几种架构介绍 #32

Bulandent opened this issue Feb 2, 2024 · 0 comments

Comments

@Bulandent
Copy link
Owner

什么是微前端

而提到微前端就离不开微服务,大家对微服务都比较熟悉了,微服务允许后端体系结构通过松散耦合的代码库进行扩展,每个代码库负责自己的业务逻辑,并公开一个API,每个API均可独立部署,并且各自由不同的团队拥有和维护。

-w610

前端架构经历了从单体,到前后端分离,再到微服务,最终发展到现在的微前端的过程如下图所示:

-w697

微前端的思路是把微服务的架构引入到前端,其核心都是要能够以业务为单元构建端到端的垂直架构,使得单个的团队能够独立自主的进行相关的开发,同时又具备相当的灵活性,按需求来组成交付应用。

“微前端”一词最早于2016年底在 ThoughtWorks 技术雷达中提出的。它将微服务的概念扩展到了前端世界。微前端的核心思路其实是远程应用程序,包含组件/模块/包的运行时加载。

-w478

如上图,对于用户而言,访问的是一个微前端的容器(container),容器加载运行在远程服务上的应用,把这些远程应用作为组件/模块/包在本地浏览器中加载。

  • 组件是底层UI库的构建单元;
  • 模块是相应运行时的构建单元;
  • 包是依赖性解析器的构建单元;
  • 微前端是所提出的应用程序的构建块。

上面说了很多,总结一下就是:微前端(Micro-Frontends)是一种类似于微服务的架构,他将微服务的理念应用于浏览器端,即将 Web 应用由单一的单体应用转变为多个小型前端应用聚合为一的应用。各个前端应用还可以独立开发独立部署独立运行。微前端不是单纯的前端框架或者工具,而是一套架构体系。

-w665

为什么需要微前端

在前面我们看到的微前端之前的架构,所有的前端还是一个单体,前端团队会依赖所有的服务或者后台的 API,前端开发会成为整个系统的瓶颈。使用微前端,就是要让前端业务从水平分层变为垂直应用的一部分,进入业务团队,剥离耦合。

那么微前端有什么好处,为什么要采用微前端架构呢?

  • 各个团队独立开发,相互不影响,独立开发、独立部署,微应用仓库独立,前后端可独立开发,部署完成后主框架自动完成同步更新;
  • 增量升级,在面对各种复杂场景时,通常很难对一个已经存在的系统做全量的技术栈升级或重构,而微前端是一种非常好的实施渐进式重构的手段和策略。因为是运行时加载,可以在没有重建的情况下添加,删除或替换前端的各个部分;
  • 不受技术影响,每个团队都应该能够选择和升级其技术栈,而无需与其他团队进行协调。也就是说 A 应用可以用 React,而 B 应用使用 Vue,大家可以通过同一个基座应用来加载;
  • 独立运行时,每个微应用之间状态隔离,运行时状态不共享。隔离团队代码,即使所有团队都使用相同的框架,也不要共享运行时。构建自包含的独立应用程序。不要依赖共享状态或全局变量;
  • 建立团队命名空间,对于CSS,事件,本地存储和Cookies,可以避免冲突并阐明所有权。

因此,微前端和微服务的本质都是关于去耦合。而只有当应用程序达到一定规模时,这才开始变得更有意义。

如何实现微前端架构

微前端不是一个库,是一种前端架构的设计思路,要实现微前端,本质上就是在运行时远程加载应用。如下列了一些实现方案,但不仅仅只是这样:

  • 纯 nginx 路由转发;
  • 使用 iframe 创建容器;
  • 组合式应用路由分发;
  • 使用 Web Components 技术构建;
  • Module Federation;

纯 nginx 路由转发

即通过路由将不同的业务分发到不同的、独立前端应用上。其通常可以通过 HTTP 服务器的反向代理来实现。这种方案,不涉及前端的改造,完全是依靠运维层面的配置。

-w498

当在浏览器里访问 www.nrp.com/app1 的时候,其实访问的是 app1 这个应用;当访问 www.nrp.com/app2 的时候,其实访问的是 app2 这个应用。要实现这个功能,就可以用 nginx 的反向代理来实现路由分发:

http {
  server {
    listen       80;
    server_name  www.nrp.com;
    location / {
      root   /www/wwwroot/www.nrp.com/;
      index  index.html index.htm;
    }
    location /app1 {
      proxy_pass http://www.app1.com/;
    }
    location /app2 {
      proxy_pass http://www.app2.com/;
    }
  }
}

通过 http 服务分发不同的路由到不同的独立应用上,虽然实现上很简单,但是缺点也相当明显:

  • 每一次切换应用的时候都会重新请求资源,没办法做到局部更新当前页面,就相当于是刷新了浏览器,完全丢失了单页应用的体验;
  • 需要配置一个通用可扩展的路由规则,否则当引入新的应用的时候,还需要修改 nginx的路由配置;

使用 iframe 创建容器

HTML 内联框架元素 <iframe> 表示嵌套的正在浏览的上下文,能有效地将另一个 HTML 页面嵌入到当前页面中。

<iframe src="http://www.baidu.com/"></iframe>

iframe 可以创建一个全新的独立的宿主环境,这意味着我们的前端应用之间可以相互独立运行。通过给 iframe 的 src 指定不同的地址,来实现加载不同的子应用。

<template v-for="app in appList">
    <iframe
        v-show="currAppCode == app.code"
        :key="app.code"
        :src="app.src"
    ></iframe>
</template>

使用 iframe 来加载不同的微应用,接入非常简单,且由于 iframe 天然的沙箱环境使得 js 和样式隔离都非常完美。但他存在以下一些问题:

  • 页面加载问题:iframe 和主页面共享连接池,而浏览器对相同域的连接有限制,所以会影响页面的并行加载,阻塞 onload 事件。相比于 SPA 加载会更慢;
  • 布局问题:iframe 必须给一个指定的高度,否则会塌陷。另外有些时候会出现多个滚动条,用户体验不佳;
  • 弹窗及遮罩层问题:弹窗只能在 iframe 区域进行展示,没办法在浏览器视口里显示,导致的问题是,弹窗遮罩无法覆盖浏览器视口且弹窗位置可能没有垂直水平居中;
  • 浏览器记录和前进后退问题:iframe 和主页面共用浏览器记录,导致前进后退的时候不能切换不同的应用;刷新页面无法保存当前状态,比如访问一个微应用的列表页,当从列表页点击进入详情,此时刷新浏览器,会加载列表页

组合式应用路由分发

这个方案和第一种方案很像,都是需要通过 nginx 来将路由分发到不同的应用上,可以认为是它的升级版,区别是这种方式的系统在运行时将由主应用来进行路由管理,子应用的加载、启动、卸载以及通信都需要依靠主应用来完成。

这种方式的代表开源框架就是 qiankun

作为微前端的基座应用,是整个应用的入口,负责承载当前微应用的展示和对其他路由微应用的转发,对于当前微应用的展示,一般是由以下几步构成:

-w767

  • 作为一个 SPA 的基座应用,本身是一套纯前端项目,要想展示微应用的页面除了采用iframe 之外,要能先拉取到微应用的页面内容,这就需要远程拉取机制。
  • 远程拉取实施的前提是需要知道拉取的地址是什么?所以就需要先在主应用里集成一套微应用的管理机制,比如说当浏览器地址匹配 /app1 的时候就去加载 app1 应用的内容,而 app1 的地址其实是动态配置到本地的映射,最终将指向一个可以独立访问的域名。
  • 有了拉取地址之后,通常会采用 fetch API 来首先获取到微应用的 HTML 内容。然后通过解析将微应用的 JavaScript 和 CSS 进行抽离,采用 eval 方法来运行JavaScript,并将 CSS 和 HTML 内容 append 到基座应用中留给微应用的展示区域,当微应用切换走时,可以在主应用里同步卸载这些内容,这就构成的当前应用的展示流程。

对于路由分发而言,以采用vue-router开发的基座SPA应用来举例,主要是下面这个流程:

当浏览器的路径变化后,vue-router 会监听 hashchange 或者 popstate 事件,从而获取到路由切换的时机。
最先接收到这个变化的是基座的 router,通过查询注册信息可以获取到转发到那个微应用,经过一些逻辑处理后,采用修改 hash 方法或者 pushState 方法来路由信息推送给微应用的路由,微应用可以是手动监听 hashchange 或者 popstate 事件接收,或者采用 React-router,vue-router 接管路由,后面的逻辑就由微应用自己控制。

使用 Web Components 技术构建

Web Components 是一套不同的技术,允许您创建可重用的定制元素(它们的功能封装在您的代码之外)并且在您的 Web 应用中使用它们。

它主要有三项技术组件:

  • Custom elements(自定义元素):一组 JavaScript API,允许您定义 custom elements 及其行为,然后可以在您的用户界面中按照需要使用它们。
  • Shadow DOM(影子 DOM):一组 JavaScript API,用于将封装的“影子”DOM 树附加到元素(与主文档 DOM 分开呈现)并控制其关联的功能。通过这种方式,您可以保持元素的功能私有,这样它们就可以被脚本化和样式化,而不用担心与文档的其他部分发生冲突。
  • HTML templates(HTML 模板): <template><slot> 元素使您可以编写不在呈现页面中显示的标记模板。然后它们可以作为自定义元素结构的基础被多次重用。

这里有一个在线的 Web Components 示例

随后,在各自的 HTML 文件里,创建相应的组件元素,编写相应的组件逻辑。一个典型的 Web Components 应用架构如下图所示:

-w810

可以看到这边方式与我们上面使用 iframe 的方式很相似,组件拥有自己独立的 Scripts 和 Styles,以及对应的用于单独部署组件的域名。然而它并没有想象中的那么美好,要直接使用纯 Web Components 来构建前端应用的难度有:

  • 重写现有的前端应用。是的,现在我们需要完成使用 Web Components 来完成整个系统的功能。
  • 上下游生态系统不完善。缺乏相应的一些第三方控件支持,这也是为什么 jQuery 相当流行的原因。
  • 系统架构复杂。当应用被拆分为一个又一个的组件时,组件间的通讯就成了一个特别大的麻烦。
  • Web Components 中的 ShadowDOM 更像是新一代的前端 DOM 容器。而遗憾的是并不是所有的浏览器,都可以完全支持 Web Components。

MicroApp 借鉴了Web Component 的思想,通过 CustomElement 结合自定义的 ShadowDom,将微前端封装成一个类 Web Component 组件,从而实现微前端的组件化渲染。

Module Federation

Module Federation 是 webpack 5 中的一个新特性,能轻易实现在两个使用 webpack 构建的项目之间共享代码,通俗点讲,Module Federation 提供了能在当前应用加载其他应用的能力。这就为实现微前端提供了另一种可能。

EMP 就是基于这个特性研发出来的微前端解决方案。

对于 Module Federation,它有几个概念:

  • local module(本地模块):就是普通模块,对于某个项目而言,每次构建就都是产生本地模块的过程;
  • remote module(远程模块):远程模块不属于当前构建,并在运行时从所谓的容器加载;加载远程模块被认为是异步操作,通常可以通过调用 import() 实现;
  • container(容器):每个构建都充当一个容器,也可将其他构建作为容器。通过这种方式,每个构建都能够通过从对应容器中加载模块来访问其他容器暴露出来的模块。
  • shared module(共享模块):共享模块是指既可重写的又可作为向嵌套容器提供重写的模块。它们通常指向每个构建中的相同模块,例如相同的库。

所以,当前模块想要加载其他模块,就要有一个引入动作,同样,如果想让其他模块使用,就需要有一个导出动作。通过以下 2 个 webpack 插件配置参数可以实现模块的导入和导出。

  • expose:导出应用,被其他应用导入;
  • remote:引入其他应用;

这与基座模式完全不同,像 iframe 和 qiankun 都是需要一个基座(中心容器)去加载其他子应用。而 Module Federation 任意一个模块都可以引用其他应用,同时也可以导出被其他应用使用,这就没有了容器中心的概念。

想要使用 Module Federation 功能需要引入 webpack 5 中内置的插件 ModuleFederationPlugin,通过配置该插件来完成。比如 base 应用需要引入 expose 应用里导出的 HelloWorld 模块,可以这样配置:

expose 的 vue.config.js:

new webpack.container.ModuleFederationPlugin({
    name: "app_expose",
    filename: "remoteEntry.js"
    exposes: {
      "./HelloWorld.vue": "./src/components/HelloWorld.vue",
    },
    shared: {
      vue: {
        singleton: true,
      },
    },
}),

base 应用的 vue.config.js:

new webpack.container.ModuleFederationPlugin({
    name: "app_base",
    filename: "remoteEntry.js",
    remotes: {
      app_expose: "app_expose@http://localhost:8082/remoteEntry.js",
    },
    shared: {
      vue: {
        singleton: true,
      },
    },
}),

使用 expose 应用的 HelloWorld 模块:

<template>
  <div class="home">
    <img alt="Vue logo" src="../assets/logo.png" />
    <HelloWorld msg="Welcome to Your Vue.js" />
  </div>
</template>

<script lang="js">
import {  defineComponent } from "vue";
import HelloWorld from "app_expose/HelloWorld.vue";
export default defineComponent({
  name: 'HomeView',
  components: {
    HelloWorld
  },
})
</script>

webpack 5 与之前版本的模块管理对比图:
-w859

微前端的问题和缺点

讲了这么多的优点和实现,那么微前端是不是解决前端开发问题的银弹呢?当然不是。所有的架构都是取舍和权衡,这个世界上并不存在银弹,微前端架构和微服务一样也存在他的弊端,单体架构未必就差。

  • 微前端的构建通常比较复杂,从工具,打包,到部署,微前端都是更为复杂的存在,天下没有免费的午餐,对于小型项目,它的成本太高;
  • 每个团队可以使用不同的框架,这个听上去很美,但是实际操作起来,除了要支持历史遗留的应用,它的意义不大。同时也为带来体验上的问题。可以远程加载不同的框架代码是一回事,把它们都用好是另一回事;
  • 性能上来看,如果优化得不好微前端的性能可能会存在问题,至少微前端框架是额外的一层加载。如果不同的微前端使用了不同的框架,那么每一个框架都需要额外的加载;

微前端架构还在不断发展之中,本文提到的 nginx / iframe/ qiankun/Web Components / Module Federation 只是诸多解决方案中的一小部分,前端的发展变化和生态系统实在是丰富,相信未来会有更多以及更好用的微前端架构的出现。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant