qiankun框架中基于actions机制实现主应用与子应用间的双向通信

2024-04-11 11:28

本文主要是介绍qiankun框架中基于actions机制实现主应用与子应用间的双向通信,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

文章目录

      • 一、原理
        • 1、setGlobalState:
        • 2、onGlobalStateChange:
        • 3、offGlobalStateChange:
        • 4、图解
      • 二、示例
        • 主应用
          • 1、在父应用中使用initGlobalState设置全局状态actions并导出供其他组件使用。
          • 2、在main.js中引入actions实例并在注册子应用时通过props传递全局状态actions:
          • 3、主应用中的组件要修改全局状态actions,就在此组件中引入actions实例
        • 子应用
          • 1、在子应用中配置一个空的actions实例为以后重新赋值从主应用中传递过来的actions:
          • 2、然后在mounted的生命周期里注入actions实例:
          • 3、子应用向主应用发送数据(子应用中修改数据,可以在主应用中监听到)
          • 4、子应用在mounted钩子函数中注册qiankun的观察者函数
      • 三、效果图

一、原理

qiankun 内部提供了 initGlobalState 方法用于注册 MicroAppStateActions 实例用于通信,该实例有三个方法,分别是onGlobalStateChange、setGlobalState、offGlobalStateChange。

1、setGlobalState:

设置 globalState - 设置新的值时,内部将执行 浅检查,如果检查到 globalState 发生改变则触发通知,通知到所有的 观察者 函数。

  • 语法:

setGlobalState: (state) => boolean, //按一级属性设置全局状态,微应用中只能修改已存在的一级属性(就是用来修改全局状态的

2、onGlobalStateChange:

注册 观察者 函数 - 响应 globalState 变化,在 globalState 发生改变时触发该 观察者 函数。

  • 语法:

onGlobalStateChange: (callback) => void //在当前应用监听全局状态,有变更触发 callback,fireImmediately = true 立即触发 callback

3、offGlobalStateChange:

取消 观察者 函数 - 该实例不再响应 globalState 变化。

  • 语法:

offGlobalStateChange: () => boolean //移除当前应用的状态监听,微应用 umount 时会默认调用

4、图解

在这里插入图片描述

我们从上图可以看出,我们可以先注册 观察者 到观察者池中,然后通过修改 globalState 可以触发所有的观察者函数,从而达到组件间通信的效果。

二、示例

本示例介绍的是子应用中通过路由守卫,把当前的路由面包屑名称传到主应用中,主应用展示面包屑功能。

主应用
1、在父应用中使用initGlobalState设置全局状态actions并导出供其他组件使用。

actions.js

// 此action文件为定义微应用之间全局状态
// 引入qiankun的应用间通信方法initGlobalStateimport { initGlobalState } from 'qiankun';const initalState = {// 这里可以写初始化数据
}//初始化state
const actions = initGlobalState(initalState)export default actions;
2、在main.js中引入actions实例并在注册子应用时通过props传递全局状态actions:

main.js

import actions from './micro/actions'
// 注册的应用列表
registerMicroApps([{name: 'sub2',//应用名字entry: '//localhost:8082', //子应用的启用地址container: '#app-vue', //子应用所展示的地址 在App.vue中设置id为app-vueactiveRule: '/sub2', //路由地址// 通过props实现通信传递值props: {actions}},{name: 'sub1',//应用名字entry: '//localhost:8081', //子应用的启用地址container: '#app-vue', //子应用所展示的地址 在App.vue中设置id为app-vueactiveRule: '/sub1', //路由地址},
]);
3、主应用中的组件要修改全局状态actions,就在此组件中引入actions实例

app.vue

<template><div id="app"><div class="top"></div><div class="box"><div class="left"><el-menu :default-active="$route.path" router class="el-menu-vertical-demo" @open="handleOpen"@close="handleClose"><MenuItem :menu-list="menuList"></MenuItem></el-menu></div><div class="right"><div class="bread"><el-breadcrumb separator-class="el-icon-arrow-right"><el-breadcrumb-item v-for="(item,index) in crumb" :key="index">{{item.name}}</el-breadcrumb-item></el-breadcrumb></div><div class="main"><router-view></router-view><div id="app-vue"></div></div></div></div></div>
</template><script>
import actions from '@/micro/actions'
export default {components: {MenuItem},name: "App",data() {return {menuList:[],crumb:[]};},
mounted() {//修改全局的actionslet crumb=[]actions.setGlobalState({ crumb })console.log("主应用app的actions:",actions)//主应用监听参数变化,接受参数,展示面包屑功能actions.onGlobalStateChange((state, prevState) => {console.log("主应用app观察者,改变前的state为:", prevState);console.log("主应用app观察者,改变后的state为:", state);if(state?.crumb){this.crumb=state.crumb}else{this.crumb=[]}})}
</script>
子应用

配置子应用的全局状态Actions,子应用中的全局状态必须要跟主应用中的全局状态变量属性名相同,比如主应用中全局状态变量为{token: “main”},则子应用中也需要保证在setGloabalState时也需要设定相同的变量名。

1、在子应用中配置一个空的actions实例为以后重新赋值从主应用中传递过来的actions:

actions.js

function emptyAction() {// 警告:提示当前使用的是空 Actionconsole.warn("Current execute action is empty!");
}class Actions {// 默认值为空 Actionactions = {onGlobalStateChange: emptyAction,setGlobalState: emptyAction};constructor() {}/*** 设置 actions*/setActions(actions) {this.actions = actions;}/*** 映射*/onGlobalStateChange(...args) {return this.actions.onGlobalStateChange(...args);}/*** 映射*/setGlobalState(...args) {return this.actions.setGlobalState(...args);}
}const actions = new Actions();
export default actions;
2、然后在mounted的生命周期里注入actions实例:

main.js

import actions from './actions'function render(props = {}) {const { container } = props;if(props){actions.setActions(props)}instance = new Vue({router,render: (h) => h(App),}).$mount(container ? container.querySelector('#app') : '#app');//主应用中设置的id
}
3、子应用向主应用发送数据(子应用中修改数据,可以在主应用中监听到)

router/index.js

import Vue from 'vue'
import VueRouter from 'vue-router'
import HomeView from '../views/HomeView.vue'import actions from '@/actions'Vue.use(VueRouter)const routes = [{path: "/",redirect: "home"},{path: '/home',name: 'home',component: HomeView,meta:{fullPath:[{name:'首页'}]}},{path: '/about',name: 'about',component: () => import( /* webpackChunkName: "about" */ '../views/AboutView.vue'),meta:{fullPath:[{name:'首页'},{name:'关于'}]}}
]const router = new VueRouter({mode: 'history',base: window.__POWERED_BY_QIANKUN__ ? '/sub2/' : '/',routes
})// 通过路由守卫,把当前的路由面包屑名称传到主应用中
router.afterEach(to => {console.log("to:", to.meta.fullPath)actions.setGlobalState({ crumb: to.meta.fullPath });
})export default router
4、子应用在mounted钩子函数中注册qiankun的观察者函数

这里也可以监听主应用的参数

mounted(){actions.onGlobalStateChange((state) => {console.log("我是子应用,我检测到数据了:", state);}, true); //onGlobalStateChange的第二个参数设置为true,则会立即触发一次观察者函数}

三、效果图

在这里插入图片描述

在这里插入图片描述

这篇关于qiankun框架中基于actions机制实现主应用与子应用间的双向通信的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/893946

相关文章

基于Python实现一个图片拆分工具

《基于Python实现一个图片拆分工具》这篇文章主要为大家详细介绍了如何基于Python实现一个图片拆分工具,可以根据需要的行数和列数进行拆分,感兴趣的小伙伴可以跟随小编一起学习一下... 简单介绍先自己选择输入的图片,默认是输出到项目文件夹中,可以自己选择其他的文件夹,选择需要拆分的行数和列数,可以通过

Python中将嵌套列表扁平化的多种实现方法

《Python中将嵌套列表扁平化的多种实现方法》在Python编程中,我们常常会遇到需要将嵌套列表(即列表中包含列表)转换为一个一维的扁平列表的需求,本文将给大家介绍了多种实现这一目标的方法,需要的朋... 目录python中将嵌套列表扁平化的方法技术背景实现步骤1. 使用嵌套列表推导式2. 使用itert

Python使用pip工具实现包自动更新的多种方法

《Python使用pip工具实现包自动更新的多种方法》本文深入探讨了使用Python的pip工具实现包自动更新的各种方法和技术,我们将从基础概念开始,逐步介绍手动更新方法、自动化脚本编写、结合CI/C... 目录1. 背景介绍1.1 目的和范围1.2 预期读者1.3 文档结构概述1.4 术语表1.4.1 核

在Linux中改变echo输出颜色的实现方法

《在Linux中改变echo输出颜色的实现方法》在Linux系统的命令行环境下,为了使输出信息更加清晰、突出,便于用户快速识别和区分不同类型的信息,常常需要改变echo命令的输出颜色,所以本文给大家介... 目python录在linux中改变echo输出颜色的方法技术背景实现步骤使用ANSI转义码使用tpu

Python使用python-can实现合并BLF文件

《Python使用python-can实现合并BLF文件》python-can库是Python生态中专注于CAN总线通信与数据处理的强大工具,本文将使用python-can为BLF文件合并提供高效灵活... 目录一、python-can 库:CAN 数据处理的利器二、BLF 文件合并核心代码解析1. 基础合

Python使用OpenCV实现获取视频时长的小工具

《Python使用OpenCV实现获取视频时长的小工具》在处理视频数据时,获取视频的时长是一项常见且基础的需求,本文将详细介绍如何使用Python和OpenCV获取视频时长,并对每一行代码进行深入解析... 目录一、代码实现二、代码解析1. 导入 OpenCV 库2. 定义获取视频时长的函数3. 打开视频文

golang版本升级如何实现

《golang版本升级如何实现》:本文主要介绍golang版本升级如何实现问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录golanwww.chinasem.cng版本升级linux上golang版本升级删除golang旧版本安装golang最新版本总结gola

PostgreSQL的扩展dict_int应用案例解析

《PostgreSQL的扩展dict_int应用案例解析》dict_int扩展为PostgreSQL提供了专业的整数文本处理能力,特别适合需要精确处理数字内容的搜索场景,本文给大家介绍PostgreS... 目录PostgreSQL的扩展dict_int一、扩展概述二、核心功能三、安装与启用四、字典配置方法

SpringBoot中SM2公钥加密、私钥解密的实现示例详解

《SpringBoot中SM2公钥加密、私钥解密的实现示例详解》本文介绍了如何在SpringBoot项目中实现SM2公钥加密和私钥解密的功能,通过使用Hutool库和BouncyCastle依赖,简化... 目录一、前言1、加密信息(示例)2、加密结果(示例)二、实现代码1、yml文件配置2、创建SM2工具

Mysql实现范围分区表(新增、删除、重组、查看)

《Mysql实现范围分区表(新增、删除、重组、查看)》MySQL分区表的四种类型(范围、哈希、列表、键值),主要介绍了范围分区的创建、查询、添加、删除及重组织操作,具有一定的参考价值,感兴趣的可以了解... 目录一、mysql分区表分类二、范围分区(Range Partitioning1、新建分区表:2、分