微前端+qiankun介绍

微前端

微前端就是将不同的功能按照不同的维度拆分成多个子应用。通过主应用来加载这些子应用。


对于后端来说,为了解决庞大的一整块后端服务带来的变更与扩展方面的限制,出现了微服务架构。

具体地,将应用构建成一组小型服务。这些服务都能够独立部署、独立扩展,每个服务都具有稳固的模块边界,甚至允许使用不同的编程语言来编写不同服务,也可以由不同的团队来管理

越来越重的前端工程也面临同样的问题,自然地想到了将微服务思想应用(照搬)到前端,于是有了 微前端 的概念

一种由独立交付的多个前端应用组成整体的架构风格。具体的,将前端应用分解成一些更小、更简单的能够独立开发、测试、部署的小块,而在用户看来仍然是内聚的单个产品

为什么

  • 不同团队间开发同一个应用技术栈不同

  • 希望每个团队都可以独立开发,独立部署

  • 项目中还需要老的应用代码

将一个应用划分成若干个子应用,再将子应用打包成一个个的lib,路径切换时加载不同的子应用,这样每个子应用都是独立的,技术栈也就不用再做限制

特点

微前端的理念类似于微服务——将庞大的整体拆成可控的小块,并明确它们之间的依赖关系

  • 代码库更小,更内聚、可维护性更高

  • 松耦合、自治的团队可扩展性更好

  • 渐进地升级、更新甚至重写部分前端功能成为了可能

增量升级

旧项目升级的问题

  • 技术栈落后,甚至强行混用多种技术栈

  • 耦合混乱,不敢动,牵一发何止动全身

  • 重构不彻底,重构-烂尾,换个姿势重构-又烂尾

而要对这些代码进行彻底重构的话,最大的问题是很难有充裕的资源去大刀阔斧地一步到位,在逐步重构的同时,既要确保中间版本能够平滑过渡,同时还要持续交付新特性

为了实施渐进式重构,我们需要一种增量升级的能力,先让新旧代码和谐共存,再逐步转化旧代码,直到整个重构完成,这种增量升级的能力意味着我们能够对产品功能进行低风险的局部替换,包括升级依赖项、更替架构、UI 改版等

独立部署

独立部署的能力在微前端体系中至关重要,能够缩小变更范围,进而降低相关风险

因此,每个微前端都应具备有自己的持续交付流水线(包括构建、测试并部署到生产环境),并且要能独立部署

实现方案

多 Bundle 集成

微前端架构中一般会有个**容器应用(container application)**将各子应用集成起来

  • 渲染公共的页面元素,比如 header、footer

  • 解决横切关注点(cross-cutting concerns),如身份验证和导航

  • 将各个微前端整合到一个页面上,并控制微前端的渲染区域和时机

集成方式分为 3 类

  • 服务端集成:如 SSR 拼装模板

  • 构建时集成:如 Code Splitting

  • 运行时集成:如通过 iframe、JS、Web Components 等方式

运行时集成

将集成时机从构建时推迟到运行时,就能避免发布阶段的耦合

  • iframe

  • JS:比如前端路由

  • Web Components

iframe 无疑是最简单的方式,但很难将应用各个部分联系一起管理

最常见的方式是前端路由,每个子应用暴露出渲染函数,主应用在启动时加载各个子应用的独立 Bundle,之后根据路由规则渲染相应的子应用。目前看来,是最灵活的方式

还有一种类似的方式是Web Components,将每个子应用封装成自定义 HTML 元素(而不是前端路由方案中的渲染函数)

资源复用

资源复用对于 UI 一致性和代码复用有重要意义,但并非所有的可复用资源(如组件)都必须在一开始就提出来复用,建议的做法是前期允许一定程度的冗余,各个 Bundle 在各自的代码库中创建组件,直到形成相对明确的组件 API 时再建立可供复用的公共组件

  • 基础资源:完全不含逻辑功能的图标、标签、按钮等

  • UI 组件:含有一定 UI 逻辑的搜索框(如自动完成)、表格(如排序、筛选、分页)等

  • 业务组件:含有业务逻辑

不建议跨子应用复用业务组件,因为会造成高度耦合,增加变更成本

应用间通信

通过自定义事件间接通信是一种避免直接耦合的常用方式,路由参数也可以作为一种通信手段

但原则上,无论采用哪种方式,都应该尽可能减少子应用间的通信,以避免大量弱依赖造成的强耦合

主要目的

  • 技术架构上进一步的扩展性(模块边界清晰、依赖明确)

  • 开发流程上能独立开发、独立交付

最大的意义在于解锁了多技术栈并存的能力,尤其适用于渐进式重构中架构升级过渡期

允许低成本尝试新技术栈,甚至允许选用最合适的技术栈做不同的事情(类似于微服务中允许用不同的语言编写不同服务)

优点

  • 技术栈无关——框架不限制接入应用的技术栈,微应用具备完全自主权

  • 独立开发、独立部署——微应用仓库独立,前后端可独立开发,部署完成后主框架自动完成同步更新

  • 增量升级——在面对各种复杂场景时,我们通常很难对一个已经存在的系统做全量的技术栈升级或重构,而微前端是一种非常好的实施渐进式重构的手段和策略

  • 独立运行——每个微应用之间状态隔离,运行时状态不共享

缺点

  • 导致依赖项冗余,增加用户的流量负担

  • 独立构建意味着公共资源的冗余,继而增加用户的流量负担

没有非常理想的解决办法,一种简单的方案是将公共依赖从(子应用的)构建产物中剔除,但又会引入构建时耦合

qiankun

qiankun 是一个基于 single-spaopen in new window微前端open in new window实现库,旨在帮助大家能更简单、无痛的构建一个生产可用微前端架构系统。

qiankun官方文档open in new window

项目实践

链股产品系统目前都是放在linkkap-admin这个项目中,用微前端的方式将多个项目合在一起

项目结构

打包结果

主应用微前端相关配置

配置子应用入口

main\src\microApp.js

配置每个子应用的name、entry、activeRule,entry通过cli的环境变量区分是子应用是本地端口还是打包路径,name和activeRule要不相同,否则nginx会匹配错

配置qiankun应用通信

main\src\store.jscommon\src\store\global-register.js

通过qiankun的apiinitGlobalState初始化全局状态和获取通信的方法

在common中定义一个注册全局store的一个方法,在子应用加载时调用这个方法把通信方法注册到子应用的stroe,名称为global

主应用运行qiankun配置

main\src\main.jsmain\src\App.vue

子应用微前端相关配置

enterprise-administration\vue.config.js

区分是本地运行和打包运行

优点:简单

存在的问题:子应用里面存在大量重复代码,主应用每次都加载了全部的子应用

将子应用公用的组件和工具方法抽出到common目录(类似npm库)

优化点:减少大量重复代码。缺点:common更新需要重新install

将依赖抽离到dll里面

优化点:利用浏览器缓存提升子应用访问速度,减少子应用打包体积

先在主项目中把项目中部分的公告依赖打包成dll,然后在其他项目的vue.config.js中使用这些dll,这样公告的依赖就不会打包进去,也可以使用到依赖

只加载当前菜单需要的子应用

优化点:主应用不用每次都加载全部的子应用

通过文档知道在start方法中prefetch是控制预加载的应用,之前是全部加载,改成先在主应用的菜单接口请求后,匹配菜单中需要的应用,再进行预加载,避免当前项目加载到不需要的子应用

会议记录

微前端+qiankun介绍open in new window

主题 :rikka的快速会议

日期 :2022-02-22 19:06:42

录制文件:https://meeting.tencent.com/v2/cloud-record/share?id=95c2c665-19b3-4675-b57c-5017d7848e84&from=3