微前端qiankun项目实践

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

[[324743]]

导语

最近在做微前端的项目 , 过程中真是踩了不少坑 , 在有限的资料中不断试错 , 默默无语两行泪 哈哈.  在此次将踩坑部分都记录下来, 让更多的人少走点弯路 ,   此项目使用 蚂蚁金服qiankun 为基础作为开发 . 话不多说 开讲 !!!

那什么是 qiankun 呢

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

什么是微前端

微前端架构具备以下几个核心价值:

  •  技术栈无关

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

  •  独立开发、独立部署

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

  •  增量升级

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

  •  独立运行时

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

摘自 qiankun官方文档

主应用配置

此次项目 主应用与 子应用均为 vue ,

下载 qiankun 

  1. npm install qiankun 

在主应用中注册微应用

// 导入乾坤函数 

  1. import { 
  2.   registerMicroApps,  
  3.   setDefaultMountApp,  
  4.   start  
  5. } from "qiankun"; 

封装 render 方法

此方法在main.js 中要初始调用一次, 主要用来挂载主应用 , 之后子应用分别依次调用 ,所以故作判断. 传入的参数分别为 子应用 的 HTML 和 加载状态 content 字段 我们用 vuex 存储 起来,方便使用 

  1. let app = null 
  2. function render({ appContent, loading }) {  
  3.   if (!app) {  
  4.     app = new Vue({  
  5.       router,  
  6.       store,  
  7.       render: h => h(App),  
  8.     }).$mount('#app');  
  9.   } else {  
  10.     store.commit('microApp/changeCenter', appContent);  
  11.     store.commit('microApp/changeLoading', loading);  
  12.   }  

微应用注册

下文中的apps 可以为获取后数据 , 注册微应用 本文案例比较简单,方便大家理解 ,

在注册自应用的参数 ** container 与 render** 踩坑比较多,下边会着重讲解. 

  1. function genActiveRule(routerPrefix) {  
  2.   return location => location.pathname.startsWith(routerPrefix);  
  3.  
  4. //传递给子应用的数据  
  5. let msg = { 
  6.  ![](https://user-gold-cdn.xitu.io/2020/4/27/171bbc5de042ec98?w=1811&h=959&f=gif&s=4951066 
  7.   data:'修炼爱情的辛酸,学会放好以前的渴望'  
  8. let apps = [  
  9.   {  
  10.     name: 'linjunjie',   
  11.     entry: '//localhost:215',  // 改成自己子应用的端口号  
  12.     container:'#subView', //节点 id   //  沙盒模式   
  13.     // render:render,  // 普通模式     
  14.     activeRule: genActiveRule('/star'),  
  15.     props:msg  
  16.   }  
  17.  
  18.    //注册的子应用 参数为数组  
  19. registerMicroApps(apps,{  
  20.   beforeLoad: [  
  21.     app => {  
  22.       console.log(app)  
  23.       console.log('[LifeCycle] before load %c%s', 'color: green;', app.name);  
  24.     },  
  25.   ],  
  26.   beforeMount: [  
  27.     app => {  
  28.       console.log('[LifeCycle] before mount %c%s', 'color: green;', app.name);  
  29.     },  
  30.   ],  
  31.   afterUnmount: [  
  32.     app => {  
  33.       console.log('[LifeCycle] after unmount %c%s', 'color: green;', app.name);  
  34.     },  
  35.   ],  
  36. });  
  37. setDefaultMountApp('/star/linjunjie')  
  38. //开启沙盒模式  
  39. start({   
  40.    sandbox :{strictStyleIsolation: true}  
  41. }) 

当微应用信息注册完之后,一旦浏览器的 url 发生变化,便会自动触发 qiankun 的匹配逻辑,所有 activeRule 规则匹配上的微应用就会被插入到指定的 container 中,同时依次调用微应用暴露出的生命周期钩子。

主应用为子应用准备的 展示元素 

  1. <template>  
  2.   <div id="app">  
  3.     <div id="nav">  
  4.       <!--//主应用 为子应用的跳转dom-->  
  5.       <div @click="onChangePage('/star/linjunjie')" >林俊杰</div>  
  6.       <div @click="onChangePage('/star/zhangyixin')" >张艺兴</div>   
  7.     </div>  
  8. <!--//用来展子应用的 内容区-->  
  9.      <div id="subView" class="sub-content-wrap" v-html="content"></div>  
  10.   </div>  
  11. </template>  
  12. <script>  
  13.   import { mapState } from 'vuex';  
  14.   export default{  
  15.     data(){  
  16.       return {     
  17.       }  
  18.     },  
  19.     computed:{  
  20.     //获取子应用HTML 数据  
  21.        ...mapState('microApp', ['content']),  
  22.        ...mapState('microApp', ['mircoAppLoading']),  
  23.     },  
  24.     methods:{    
  25.       //定义跳转方法  
  26.       onChangePage(url){  
  27.         console.log(url)       
  28.         this.routerGo(url, '我喜爱的男明星')  
  29.       },  
  30.       routerGo(href = '/'title = nullstateObj = {}) {  
  31.         window.history.pushState(stateObj, title, href);   
  32.       },  
  33.     }  
  34.  }  
  35. </script> 

子应用配置

关于子应用的配置相对较简单 , 不需要额外下载qiankun 主要将生命钩子 导出即可

导出响应的生命钩子

导出 bootstrap、mount、unmount 三个生命周期钩子,以供主应用在适当的时机调用。注意,实例化路由时,判断当运行在qiankun环境时,路由要添加前缀,前缀与主应用注册子应用函数genActiveRule("/subdemo")内的参数一致

'star' 值需要与主应用的值对应 genActiveRule("/star") 中的值需要商定好 主应用与微应用都要使用

如果 new VueRouter 不在main.js  中 配置 ,请将此配置移动到 main.js  方便管理 

  1. import routes from './router' //将路由信息导出方便使用   
  2. let router = null 
  3. let instance = null 
  4. function render(props = {}) {  
  5.   const { container } = props;  
  6.   router = new VueRouter({  
  7.     base: window.__POWERED_BY_QIANKUN__ ? '/star' : '/',    
  8.     mode: 'history',  
  9.     routes,  
  10.   });  
  11.   instance = new Vue({  
  12.     router,  
  13.     store,  
  14.     render: h => h(App),  
  15.   }).$mount(container ? container.querySelector('#app') : '#app');  
  16.  
  17. if (!window.__POWERED_BY_QIANKUN__) {  
  18.   render();  
  19.  
  20. export async function bootstrap() {  
  21.   console.log('[vue] vue app bootstraped');  
  22.  
  23. export async function mount(props) {  
  24.  //props 包含主应用传递的参数  也包括为子应用 创建的节点信息  
  25.   console.log(props)  
  26.   render(props);  
  27.  
  28. export async function unmount() {  
  29.   instance.$destroy();  
  30.   instance = null 
  31.   router = null 

配置微应用的打包工具

除了代码中暴露出相应的生命周期钩子之外,为了让主应用能正确识别微应用暴露出来的一些信息,微应用的打包工具需要在vue.config.js 中 增加如下配置: 

  1. const packageName = require('./package.json').name;  
  2. module.exports = {  
  3.   output: {  
  4.     library: `${packageName}-[name]`,  
  5.     libraryTarget: 'umd',  
  6.     jsonpFunction: `webpackJsonp_${packageName}`,  
  7.   },  
  8. }; 

子应用判断

子应用中新建 publicPath.js  在main.js 引入 

  1. if (window.__POWERED_BY_QIANKUN__) {   
  2. //处理资源  
  3.  __webpack_public_path__ = window.__INJECTED_PUBLIC_PATH_BY_QIANKUN__;   

处理 资源加载问题

配置 vue.config.js 

  1. module.exports = {  
  2.   publicPath:`//localhost:${port}`,  

vue.config.js 完整配置 

  1. const path = require('path');  
  2. const packageName = require('./package').name;  
  3. function resolve(dir) {  
  4.   return path.join(__dirname, dir);  
  5.  
  6. const port = 7101; // dev port  
  7. module.exports = {  
  8.   publicPath:`//localhost:${port}`,  
  9.   outputDir: 'dist',  
  10.   assetsDir: 'static',  
  11.   filenameHashing: true,  
  12.   devServer: {  
  13.     // host: '0.0.0.0',  
  14.     hot: true,  
  15.     historyApiFallback: true,//添加 重点  
  16.     port,  
  17.     overlay: {  
  18.       warnings: false, 
  19.       errors: true,  
  20.     },  
  21.     headers: {  
  22.       'Access-Control-Allow-Origin': '*',  
  23.     }, 
  24.   },  
  25.   configureWebpack: {  
  26.     resolve: {  
  27.       alias: {  
  28.         '@': resolve('src'),  
  29.       },  
  30.     },  
  31.     output: {  
  32.       library: `${packageName}-[name]`,  
  33.       libraryTarget: 'umd',  
  34.       jsonpFunction: `webpackJsonp_${packageName}`,  
  35.     },  
  36.   },  
  37. }; 

踩坑记录

当前页面为子应用时, 刷新页面404

以下方式均为主应用配置

  •  方式一 删除 mode 配置项   
  1. mode: 'history', //   将此配置代码删除 
  •  方式二 配置404  页面

如果没有注释掉mode: 'history'  此参数 将404 页面重新导向  home首页 

  1.  
  2.     path: '*',  
  3.     name: 'indexNotFound',  
  4.     component: resolve => require(['@/components/home'], resolve),  
  5.     children: HomeChild,  
  6. }, 

子应用 样式隔离 开始沙箱模式 遇到的问题

  •  主应用配置sandbox :{strictStyleIsolation: true}渲染模式由 render 模式 改为 containercontainer:'#subView', 此时 子应用的 挂载 dom  为 <div id="subView"> </div>   谨记主 container :#+id
  •  子应用配置 上文有提到  主要代码 截取 
  1. instance = new Vue({  
  2.    router,  
  3.    store,  
  4.    render: h => h(App),  
  5.  }).$mount(container ? container.querySelector('#app') : '#app'); //重点 

遇到的问题: 开启沙箱模式,如果是 采用 render 模式会报错 ,故选择container 模式

效果图

写到这里,项目已经构建完成了 让我们来看看效果吧

这里是完整代码 方便大家学习 代码github地址:https://github.com/zxh1307/qiankun-vue

项目问题

  •  为啥我项目启动后看不到子应用的效果

           将master 主应用 main.js 中 注册的 子应用的端口号 改成自己项目的端口号即可

结语

开发中还有其他坑 忘记记录了, 千万记得项目部署子应用资源跨域的问题 , 需要Nginx配置跨域问题 

 

责任编辑:庞桂玉 来源: 前端大全
相关推荐

2022-07-27 22:56:45

前端应用缓存qiankun

2022-02-13 23:00:48

前端微前端qiankun

2022-10-09 14:05:24

前端single-spa

2022-08-10 10:32:47

编程实践

2022-01-24 12:38:58

Vite插件开发

2022-05-09 09:28:04

Vite前端开发

2022-09-07 21:31:19

微前端架构iframe

2022-06-02 08:30:55

项目React重构

2022-01-17 11:41:50

前端Vite组件

2022-10-17 15:21:18

2023-09-07 20:04:06

前后端趋势Node.js

2023-11-22 19:10:42

前端父应用文案

2021-04-21 19:20:53

前端 容器应用

2016-03-04 10:29:51

微信支付源码

2021-04-15 08:08:48

微前端Web开发

2020-10-10 07:14:08

前端项目断点

2022-05-23 08:34:08

微前端微服务开发

2022-04-02 17:20:00

微前端应用技术

2022-10-20 10:02:16

前端测试开发
点赞
收藏

51CTO技术栈公众号