基于 Vue 技术栈的微前端方案实践


基于 Vue 技术栈的微前端方案实践

文章插图
 
作者: mcuking
转发连接:https://mp.weixin.qq.com/s/y_gPdEZ0lRdquxqRd_7kPQ
前言项目地址:
preload-routes
https://github.com/micro-frontends-vue/preload-routes
async-routes
https://github.com/micro-frontends-vue/async-routes
mobile-web-best-practice
https://github.com/mcuking/mobile-web-best-practice
前几天看到了 微前端在美团外卖的实践,感觉和笔者所在团队实践了一年多的微前端方案非常类似,只不过我们是基于 Vue 技术栈的,所以也想总结一篇文章分享给大家 。因为笔者文笔不算太好,其中借用了一些美团文章的一些总结性的文字,还请见谅哦~
更多Vue学习文章,请见本篇文章底部,有惊喜哦
背景介绍对于大型前端项目,比如公司内部管理系统(一般包括 OA、HR、CRM、会议预约等系统),如果将所有业务放在一个前端项目里,随着业务功能不断增加,就会导致如下这些问题:
  • 代码规模庞大,导致编译时间过长,开发、打包速度越来越慢
  • 项目文件越来越多,导致查找相关文件变得越来越困难
  • 某一个业务的小改动,导致整个项目的打包和部署
方案介绍preload-routes 和 async-routes 是目前笔者所在团队使用的微前端方案,最终会将整个前端项目拆解成一个主项目和多个的项目,其中两者作用如下:
  • 主项目:用于管理子项目的路由切换、注册子项目的路由和全局 Store 层、提供全局库和方法
  • 子项目:用于开发子业务线业务代码,一个子项目对应一个子业务线,并且包含两端(PC + Mobile)代码和复用层代码(项目分层中的非视图层)
结合笔者之前的采用分层架构实现复用非视图代码的方式(感兴趣的话请参考笔者之前的文章 前端分层架构实践心得),完整的方案如下:
基于 Vue 技术栈的微前端方案实践

文章插图
 
如图所示,将整个前端项目按照业务线拆分出多个子项目,每个子项目都是独立的仓库,只包含了单个业务线的代码,可以进行独立开发和部署,降低了项目维护的复杂度 。
采用这套方案,使得我们的前端项目不仅保有了横向上(多个子项目)的扩展性,又拥有了纵向上(单个子项目)的复用性 。那么这套方案具体是怎么实现的呢?下面就详细说明方案的实现机制 。
在讲解之前,首先明确下这套方案有两种实现方式,一种是预加载路由,另一种是懒加载路由,可以根据实际需求选择其中一个即可 。接下来就分别介绍这两种方式的实现机制 。
实现机制预加载路由方式preload-routes
1.子项目按照 vue-cli 3 的 library 模式进行打包,以便后续主项目引用
注:在 library 模式中,Vue 是外置的 。这意味着包中不会有 Vue,即便你在代码中导入了 Vue 。如果这个库会通过一个打包器使用,它将尝试通过打包器以依赖的方式加载 Vue;否则就会回退到一个全局的 Vue 变量 。
2.在编译主项目的时候,通过 InsertScriptPlugin 插件将子项目的入口文件 main.js 以 script 标签形式插入到主项目的 html 中
注:务必将子项目的入口文件 main.js 对应的 script 标签放在主项目入口文件 App.js 的 script 标签之上,这是为了确保子项目的入口文件先于主项目的入口文件代码执行,接下来的步骤就会明白为什么这么做 。
再注:本地开发环境下项目的入口文件编译后的 main.js 是保存在内存中的,所以磁盘上看不见,但是可以访问 。
InsertScriptPlugin 核心代码如下:
compiler.hooks.compilation.tap('InsertScriptWebpackPlugin', compilation => {compilation.hooks.htmlWebpackPluginBeforeHtmlProcessing.tap('InsertScriptWebpackPlugin',htmlPluginData =https://www.isolves.com/it/cxkf/bk/2020-08-13/> {const {assets: { js }} = htmlPluginData;// 将传入的 js 以 script 标签形式插入到 html 中// 注意:需要将子项目的入口文件 main.js 放在主项目入口文件 app.js 之前,因为需要子项目提前将自己的 route list 注册到全局上js.unshift(...self.files);});});3.主项目的 html 要访问子项目里的编译后的 js / css 等资源,需要进行代理转发
  • 如果是本地开发时,可以通过 webpack 提供的 proxy,例如:
const PROXY = {'/app-a/': {target: 'http://localhost:10241/'}};