麦饭:可能是你见过最酷最简单的微前端解决方案

目前国内最火的微前端框架是来自阿里的qiankun,以及它底层的single-spa,但是,这是最终形态吗?在我看来并不是。无论是single-spa,还是qiankun,都有比较强的协议规定,对原有应用的侵入更多,细节上某些设计也不太符合我的口味。这篇文章重新思考微前端这个话题,聊一聊其中的一些技术点,提出一个更新更酷更简洁的微前端框架:麦饭。

微前端到底要解决什么问题?

如果单纯从技术层面去思考,微前端最后很有可能沦为玩具,无法成为主要生产方式。技术领域有一项陋习,只要是新技术火了,不管三七二十一,上就是了。微前端火了,上就是了。为了微前端而微前端,只会让项目在之后的维护中,成本更大。我认为,就像vue所提倡的一样,微前端是一个渐进式需求的结果,当你需要它的时候,才使用它

那我们什么时候需要微前端呢?回答这个问题,也就回答了“微前端到底解决什么问题”这个问题了。

如果从微前端的形式出发,有些人会把重点放在应用“可拆分”这个点上,认为微前端解决的是将一个大应用拆分成小应用,通过变小提高效率或可维护性等。但是我认为,微前端真正要解决的是,当技术更新换代时,应用可兼容不同代际应用,用阿里大佬的话,就是“技术栈无关”。所谓“技术栈无关”不是说在开发的时候就不考虑技术栈,而是当应用需要用新一代技术写时,老技术栈的应用仍然可以被兼容,不需要重写。兼容老技术栈,是微前端最基本的素质

微前端框架

我们首先要了解,微前端架构本身要解决的问题,以及从技术层面要解决哪些问题。微前端,从技术上,目标是要在当前应用中运行其他应用。其他应用在技术栈上,是未知的,无法像我们在vue中使用别人开发的vue组件,在react中使用别人开发的react组件,我们无法在当前的应用架构上预测别人开发的组件/应用是不是符合本应用框架的协议。因此,我们要找到一种办法,在当前应用的技术架构上,可以运行别人通过任何技术栈完成的应用,而这种方法,就是微前端,能够支撑实现这效果的,就是微前端框架。

技术上,我认为微前端框架解决的最主要问题有三个:资源加载、环境隔离、父子通信。在开发体验上,我觉得除了写法上简单之外,微前端框架应该做到对子应用的无侵入,也就是子应用开发者不需要思考它的外部环境如何使用它,这也符合Clean架构的思想。

我收集了网上看到的微前端框架/技术方案,现在把它们罗列出来进行对比。

框架名 技术栈无关 子应用独立运行 无侵入子应用 多子应用共存 路由穿透 父子通信 子应用嵌套子应用
Mooa
Single-SPA
Qiankun
Icestark
console-os
Module Federation
Luigi
FrintJS
PuzzleJS
ngx-planet
麦饭

大部分框架还是存在一定的技术栈门槛,需要开发者对框架进行大量学习后,在特定的条件下才能完成微应用的接入,而single-spa/qiankun采用expose接口的方式,只要子应用对应导出bootstrap,mount,unmount方法就可以运行,而麦饭也是导出接口,但是不需要子应用接入任何协议,子应用可以忽略麦饭存在。子应用可以独立运行是一个必备的条件,因为开发者并不知道自己的应用会被哪些框架哪去用,甚至在开发时,开发者不应该在潜意识里面刻印“要被使用”的思想,应该按照应用开发的方式直接完成开发,并且可以独立部署运行。在所有框架中,只有麦饭做到了对子应用的无侵入,不需要子应用按照特定的方式开发或导出接口,这是对开发者最友好的方式。另外,也只有麦饭做到了子应用内,还可以再嵌套子应用。

麦饭,精巧简易微前端框架

对于开发者而言,特别是子应用开发者而言,如果不需要在子应用内再嵌套子应用,也不需要和父应用通信,那么可以完全不理会麦饭。只有父应用的开发者,需要在代码中引入麦饭的接口,而麦饭的接口非常简单,总共只有四个,其中路由接口还是可选的,可不需要引入。

<div class="container">
  <mfy-app name="some"></mfy-app>
</div>

<script type="module">
import { importSource, resiterMicroApp } from 'https://unpkg.com/mfy/es/index.js'

const app = registerMicroApp({
  name: 'some',
  autoMount: true, // 自动挂载子应用
  source: importSource('./apps/some/index.html'),
})
</script>

这就是麦饭最最最简单的使用方法,它包含三个部分:

  • 在html结构中使用<mfy-app>确定一个子应用要挂载的位置
  • registerMicroApp注册一个子应用
  • app.bootstrap/app.mount启动和挂载注册好的子应用(上面代码中通过autoMount配置,让子应用自动启动并挂载)

在没有路由系统的情况下,开发者要自己决定什么时候启动、挂载、卸载、销毁该子应用。麦饭的全部接口,总共就四个接口,其中路由和通信接口还是可选的。

手动加星

环境隔离

微前端中,最难解决的就是环境隔离问题,这个问题包含两个具体问题:样式隔离,JS运行隔离。在麦饭中,提供了3种隔离方案,一种是iframe,一种是shadowdom,一种是none(默认),不同方案通过type进行配置。

iframe方案将子应用放在一个沙箱模式下的iframe中,其内部具有较独立的运行环境。但iframe方案的缺点也很明显,当iframe的src被修改时,所有资源会被重新加载,无法复用资源缓存;另一个缺点是iframe形成了封闭文档,导致一些被挂载在document.body下的弹出层无法在顶层窗口打开,所以,iframe不适合这种情况,或者仅适合将iframe铺满整个屏幕的情况。

shadowdom方案将子应用放在一个shadowdom中,所有样式被加载在这个shadowdom内部,因此样式实现了快速隔离。不过,由于样式只在shadowdom内生效,这导致被挂载到外部文档的节点丢失了样式,为了解决这个问题,我提供了hoistCssRules配置项,让开发者自己决定,哪些样式将被挂载在顶层文档上,以保证弹窗样式的正常。JS运行时的隔离是个大问题,麦饭采用了代理沙箱,为子应用的脚本运行创建了一个虚拟的环境,子应用的脚本都在这个环境中运行(注意:子应用中type="module"的脚本块无法在沙箱中运行,这个问题尚未解决),这样就避免了子应用脚本运行时可能对父应用产生的某些破坏。

和其他框架不同,麦饭不仅隔离了全局变量,还虚拟了子应用的location和history,子应用内部的代码可以正常改变url来达到界面变化的效果,但对于父应用而言,子应用的url变化不会影响浏览器的url变化。

none方案将子应用直接运行在当前文档中,所有样式被加上一个前缀实现样式隔离,但js完全没有隔离,路由也是和当前浏览器url共享。

资源加载

麦饭中,我们需要使用importSource加载资源,之所以要自己提供接口来加载资源,主要有两点考虑:1.资源缓存;2.为资源绑定基础环境。麦饭遵循的第一原则是,对已有的应用不做任何修改,就可以拿过来当作子应用进行加载和运行。我们主要面对的是技术更新迭代时,不想重写老应用的尴尬,而没有考虑微前端的另外一个场景:项目一开始就要求所有团队按照微前端架构进行开发,子应用团队必须提供对应的接口。正是由于这种限制,导致麦饭在实现时更难,最终得到的结果也有一些限制,比如,麦饭很难解决跨域加载资源的问题,如果将子应用放在另外一个域名下面,比如cdn域名上,就会产生问题,这是不同选择得到的结果,没有好坏之分。

正因为我想不对子应用做任何修改就可以立即运行,所以,我选择以子应用的index.html作为子应用的入口,去解析index.html的内容,然后加载到父应用中来运行。

解析时,会遇到子应用引用了其他资源的问题,一般而言,我们的应用都是以外链的形式引入css和js文件,现在已经很少看到直接把style和script写在html中的应用了。所以,在加载html之后,我需要再次请求里面的样式和脚本文件的内容。这里还是比较简单的,但是,接下来就会遇到新的问题,在样式表中,我们经常会看到使用 @import 引用其他css文件,使用 url() 引用图片等,这怎么办呢?我通过对样式表的解析,把这部分内容全部替换,比如 @import 的其他样式,我再次进行加载解析,把解析出来的样式表平铺到一个style标签中,如果里面还有嵌套,就再这么做一次。

对于使用 <script src> 的方式引入脚本的情况,如果直接插入该script标签,那么脚本将不会在沙箱中运行,所以,处理时也像上面 @import 的处理方式,把脚本内容请求回来之后,在放到沙箱中运行。

父子通信

在麦饭中,每一层的运行环境都对应一个scope,它的作用就是帮助父子应用进行通信(子应用之间也可以通信,但是需要借助父应用,有点像react中两个子组件通信一样)。

<script type="module">
import { connectScope } from 'https://unpkg.com/mfy/es/router.js'

const scope = connectScope()

scope.emit({ type: 'event', message: 'ok' }) // 向父应用发送消息
scrope.listen((data) => { // 接收到来自父应用发送的消息
  const { type } = data
  // ...
})
scope.watch(name, (data) => { // 接收到来自子应用发送的消息,name为子应用的名称
  // ..
})
scope.send(name, data) // 向单个子应用发送消息
scope.dispatch({ type: 'event', message: 'gogo' }) // 向所有子应用广播消息(不包含孙应用)
scope.broadcast({ type: 'xx', message: 'oo' }) // 向整个应用树广播消息,自顶向下进行广播
</script>

由于通信系统的存在,应用间的通信和状态共享成为可能,但是我并没有设计真正的状态共享机制,因为对于微前端架构而言,子应用之间应该尽可能的保持状态隔离,不应该有状态依赖,当然,两个子应用使用同一个全局状态管理器来达到共享全局状态的效果也是可行的,但这样做会让子应用本身的纯净性产生复杂数据问题,理论上,一个子应用的开发者,是不会知道也不应该知道自己的应用会和哪些子应用一起运行的,所以,实在需要共享一些数据时,通过消息传递的方式来进行消息发送。

路由映射

路由系统是可选的,但是作为微前端解决方案,麦饭提供了一种路由映射机制。因为子应用是运行在沙箱中的,所以,不同层的应用得到的location是不同的,父级应用使用浏览器的location,但是它的子应用则不是,我们修改浏览器的url之后,可以通过路由映射机制,伪造子应用得到的url:

<script type="module">
import { registerRouter } from 'https://unpkg.com/mfy/es/router.js'

const router = registerRouter({
  autoBootstrap: true,
  routes: [
    {
      app: app,
      match: ({ hash }) => hash.indexOf('#app') === 0,
      map: ({ search }) => '#' + search, // 将父级路由映射到子应用内部,子应用将接收到这里map结果的路由
    },
  ],
})
</script>

路由系统其实也很简单,主要是完成路由匹配和映射逻辑。匹配是为了当父应用获得某个url之后,触发子应用的mount,当然,对应的match返回false时子应用unmount。映射是为了保证父应用所在页面的url被转化为一个新的url传给子应用,也就是说,子应用读取自己所在环境下的url得到的不是浏览器的url,而是经过处理后的环境url。

应用树

我发明了一种应用树的数据结构,在一个微前端应用中,会构建一个树状的应用结构。一个麦饭应用,当它作为顶层应用时,它就是应用树顶端的应用,它作为子应用时,就在应用树的网络中。一棵应用树的结构大致是这样:

每一个app都处在一个scope中,最顶层的scope被称为root scope,一个scope内可能有一个或多个app,一个app在启动之后,又会形成自己的scope(作为自己子应用的scope)。基于这一设计,处于应用树中的应用相互通信成为可能,前面已经介绍过scope的通信功能,此外,rootScope还具有向整个网络广播的功能。从js本质上讲,rootScope是一个对象,可以在所有应用中被读取,也可以用来共享状态,但是,这显然是不被推荐的。

这种树状结构和组件式开发基本一致,它有它的好处。在编程上,你可以在应用中嵌套子应用,就像在组件中嵌套子组件。在数据流上,它也类似react一样,通过props完成数据的上下传递。

Custom Element

在设计中,麦饭要求开发者在html中使用<mfy-app>标签来决定子应用被放在什么位置。这个设计从技术层面可以解决几个问题,和其他微前端框架相比,具有更加明确的辨识度。为什么要这么设计呢?

一是解决标签被卸载和重载问题。在vue组件中,我们可能写出类似 <mfy-app name="xxx" v-if="showXXX"> 这样的控制代码,或者,<mfy-app>标签的父元素上挂载了v-if,这种在编程中是非常常见的。在其他框架中,如果被子应用挂载的节点被移除了会发生什么?这我真没有研究过。但是在麦饭中,<mfy-app>被从文档中移除之后,当它再次回来时(创建或重新插入),它将仍然工作。这主要是利用了custom element的监听能力。

另一个,解决子应用挂载和卸载的过渡动画效果。没错,麦饭支持子应用的transition动画,在live demo中你可以看到,子应用的出现是滑动过来的。由于我们使用了custom element,可以方便的处理shadow dom内部的元素的出现和隐藏,也就很好的实现了动画效果。

另外,使用custom element还避免了和原文档中其他标签冲突,形式上也更有辨识度,团队成员一看到这个标签,就知道这是一个麦饭应用,而无需通过阅读代码来寻找一个子应用将被挂载到那个元素上面。

没有银弹💔

和所有聊微前端的文章一样,我也要说这句话。微前端不是解决前端所有问题的统一方案,我们应该学习vue的渐进式思维,在需要的时候使用微前端,不需要的时候丢在一边。

当遇到如下场景时,是可以考虑使用微前端的:

  • 系统合并兼容:老系统还在运行,不想重新开发一遍,此时可以在新系统中采用微前端方案加载老系统
  • 巨无霸应用拆分:应用模块复杂又庞大,一个团队的人员维护起来疲于奔波,不如将团队进行拆分,每个squad专注一个或两个应用
  • 渐进式技术栈升级:想尝试新技术,又不敢直接在整个系统中马上引入,不如将其中的一个子应用先用新技术栈实现跑跑看

对于麦饭而言,出发点集中在第一点上,也就是完完全全不想改动已有的应用,但是又要使用新技术实现新系统。后面两点的出发点本身就不是麦饭的初衷,当然,如果有一个过渡期,通过麦饭进行改造,也可以在团队中实施分治,也就是整个应用按父子应用进行拆分。

结语

我认为微前端框架最主要要解决的是资源加载、环境隔离、父子通信问题,但并不意味着微前端只有这三个问题,其他问题不重要。实际上,在微前端的部署上也是一个重要话题,因为麦饭要求应用尽可能是同域的,这就导致在部署时,不大可能直接通过发cdn就可以完成,具体怎么做还需要在实践中不断摸索。总之,在微前端的路上,我迈出了这一步,带来了一个使用起来极其简单的框架。

2020-11-02 541

为价值买单

本文价值5.41RMB