vue3中如何实现事件总线eventBus

本文介绍了在Vue3中,由于官方移除了$on、$off和$once方法,作者推荐使用mitt第三方库来实现代理事件。文章详细讲解了如何安装并全局挂载mitt,以及在组件间通过事件总线进行通信的方法和示例。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

使用插件

由于vue3中 “$ on”,$ off 和 $ once 实例方法已被移除,组件实例不再实现事件触发接口 所以我们可以使用官方推荐的这个第三方库实现同样的效果
mitt https://github.com/developit/mitt

安装

pnpm install mitt -S

挂载全局写法

main.ts 初始化
全局总线,vue 入口文件 main.js 中挂载全局属性

import './assets/main.css'

import { createApp } from 'vue'
import { createPinia } from 'pinia'

import App from './App.vue'
import router from './router'
import ElementPlus from 'element-plus'
import 'element-plus/dist/index.css'
// 引入animate动画
import 'animate.css';
//挂载事务总线
import mitt from 'mitt'
const app = createApp(App)
const miTT = mitt()
//TypeScript注册
// 由于必须要拓展ComponentCustomProperties类型才能获得类型提示
declare module "vue" {
  export interface ComponentCustomProperties {
      $bus: typeof miTT
  }
}

app.config.globalProperties.$bus = miTT

app.use(createPinia())
app.use(router)
app.use(ElementPlus)
app.mount('#app')

父组件

<template>
  <A></A>
  <B></B>
</template>

<script setup lang="ts">
import A from './components/A.vue'
import B from './components/B.vue'
</script>

<style scoped>

</style>

组件A

<template>
  <div style="margin-right: 30px;">
    <h1>派发组件</h1>
     <button @click="emitIndex">派发事件</button>
  </div>
</template>

<script setup lang="ts">
import { getCurrentInstance } from 'vue'
// vue实例
const vm = getCurrentInstance();
 const emitIndex = () => {
  // self.console.log(123,vm)
  vm?.proxy?.$bus.emit('on-click', 1)
 }
</script>

<style scoped>

</style>

组件B

<template>
  <div>
   <h1>接收组件</h1>
   <div>接收的值{{ bData }}</div>
  </div>
 </template>
 
 <script setup lang="ts">
 import { getCurrentInstance,ref } from 'vue'
  const vm = getCurrentInstance()
  let bData = ref<Number>(0)
  vm?.proxy?.$bus.on('on-click', (num) => {
      bData.value += num
      console.log(num,'===========>B')
  })
 </script>
 
 <style scoped>
 
 </style>
 

效果如下

点击 按钮 b组件中的数值增加

在这里插入图片描述
监听所有事件( on(“*”) )

vm?.proxy?.$bus.on('*', (num) => {
      bData.value += num
      console.log(num,'===========>B')
  })

移除监听事件(off)

vm?.proxy?.$Bus.on('on-click',Fn)//listen
vm?.proxy?.$Bus.off('on-click',Fn)//unListen

清空所有监听(clear)

vm?.proxy?.$Bus.all.clear() 
### 使用事件总线EventBus实现 Vue.js 组件间通信 在 Vue.js 中,通过创建一个独立的 `Vue` 实例作为中央事件中心——即所谓的 **事件总线** (EventBus),可以让任意组件之间相互通信。这特别适用于非父子关系的兄弟组件之间的消息传递。 #### 创建事件总线实例 为了使整个应用程序都能访问到这个共享的消息通道,在项目根目录下建立一个新的 JavaScript 文件用于定义并暴露该单例对象: ```javascript // src/event-bus.js import Vue from &#39;vue&#39;; export default new Vue(); ``` 此代码片段展示了如何在一个名为 `event-bus.js` 的文件中创建了一个新的 `Vue` 实例,并将其默认导出以便于后续导入使用[^1]。 #### 发送消息给其他组件 当某个特定条件满足时,源组件可以通过调用 `$emit()` 方法向 Event Bus 上发布自定义事件名及其携带的数据包: ```javascript // src/components/SenderComponent.vue <template> <!-- ... --> </template> <script> import EventBus from &#39;../event-bus&#39;; export default { name: "SenderComponent", methods: { triggerMessageSending() { const payload = { text: "Hello, world!" }; // 向所有订阅者广播消息 EventBus.$emit(&#39;message-sent&#39;, payload); } } } </script> ``` 上述例子中的 `triggerMessageSending` 函数会在适当时候被触发,从而发送一条带有字符串内容的对象至指定名称为 `&#39;message-sent&#39;` 的频道上[^2]。 #### 订阅来自其他组件的消息 目标接收方则需提前注册好相应的监听器来捕捉这些信号;一旦检测到匹配类型的活动发生,则立即执行回调函数处理接收到的信息: ```javascript // src/components/ReceiverComponent.vue <template> <div>{{ receivedText }}</div> </template> <script> import EventBus from &#39;../event-bus&#39;; export default { data () { return { receivedText: &#39;&#39; } }, mounted() { // 注册监听器等待消息到来 EventBus.$on(&#39;message-sent&#39;, ({text}) => { this.receivedText = text; }); // 移除监听防止内存泄漏 this.$once(&#39;hook:beforeDestroy&#39;, () => { EventBus.$off(&#39;message-sent&#39;); }) } }; </script> ``` 在这个示例里,每当有新数据到达时都会更新视图上的显示文字。同时注意到了生命周期钩子的应用以确保及时清理不再使用的侦听器,避免潜在的记忆泄露风险[^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值