vue项目中eventBus总线机制

本文介绍了在Vue项目中如何利用EventBus进行组件间的通信。首先,通过创建eventBus.js文件并封装事件监听、触发、取消和清除功能。然后,将eventBus挂载到Vue原型或Window上。在实际使用中,可以方便地进行事件监听和触发,实现参数传递。在不再需要事件时,推荐使用off()方法取消监听。这种通信方式在某些特殊场景下非常实用。
  1. 使用场景
    vue项目中,某些特殊情况下,我们需要不相关的组件之间通信,这种情况我们可以通过eventBus来解决问题,通过事件的监听和触发来实现通信和参数传递
  2. 封装
    新建eventBus.js文件
let events = {}
export default {
  //事件监听
  on(eventName,handler){
    if (typeof handler === 'function') {
      if (!events[eventName]) {
        events[eventName] = new Set()
      }
      events[eventName].add(handler)
    }
  },
  //事件触发
  emit(eventName,payload){
     if (!events[eventName]) {
        return console.warn(`已触发${eventName}事件,但没有事件监听者,未发生任何改变`)
      }
      for(let func of events[eventName].values()) {
         func(payload)
      }
  },
  //事件取消
  off(eventName,handler){
    if (!handler) {
      return console.warn('取消事件监听必须传入已监听的事件函数')
    }
    events[eventName].delete(handler)
  },
  //所有事件清空
  clear(){
    events = {}
  }
}

挂载到原型或Windows上

import eventBus  from './eventBus.js'
//两种方式二选一

//挂载正在原型上
Vue.prototype.$eventBus = eventBus  
//挂载正在windows上
windows.$eventBus = eventBus  
  1. 使用
//以挂载在Windows上为例
//监听事件
$eventBus.on('testEvent', testFunc)
testFunc(data){
  console.log(data)
  //具体操作...
}
//触发事件
$eventBus.emit('testEvent', {a:1,b:2})

在eventBus中定义的事件如不再使用,最好使用off()方法取消该事件

<think>根据用户的问题,用户想了解在Vue项目中如何使用EventBus的$on方法进行事件监听。结合提供的引用内容,我将整理一个清晰的回答。 引用中提到了EventBus的创建、事件发送、事件监听和移除监听的方法。其中,事件监听使用$on方法。 回答步骤: 1. 创建EventBus实例(引用[1][2][4][5]提到) 2. 在需要监听的组件中使用EventBus.$on监听事件(引用[1][3][5]提到) 3. 注意在组件销毁前移除监听(引用[1]提到) 4. 可以创建全局EventBus(引用[2][4]提到) 根据这些信息,我将组织一个结构清晰的回答,并按照要求生成相关问题。</think>在 Vue 项目中使用 `EventBus.$on()` 进行事件监听的完整步骤如下: ### 1. **创建 EventBus 实例** 在项目中新建一个文件(如 `event-bus.js`)并导出实例: ```javascript // event-bus.js import Vue from 'vue'; export const EventBus = new Vue(); // 创建全局事件总线 [^1][^2] ``` ### 2. **在组件中监听事件** 在需要接收事件的组件中: ```javascript import { EventBus } from './event-bus.js'; // 导入 EventBus export default { mounted() { // 使用 $on 监听事件 EventBus.$on('customEvent', (payload) => { console.log('收到事件数据:', payload); // 处理事件数据 this.value = payload; // 更新组件数据 }); } } ``` ### 3. **发送事件(触发端示例)** 在另一个组件中发送事件: ```javascript import { EventBus } from './event-bus.js'; export default { methods: { triggerEvent() { // 发送事件并传递数据 EventBus.$emit('customEvent', { data: 'Hello EventBus!' }); // [^1][^3] } } } ``` ### 4. **移除事件监听(关键步骤)** 避免内存泄漏,需在组件销毁前移除监听: ```javascript export default { beforeDestroy() { // 移除指定事件的监听 EventBus.$off('customEvent'); // [^1][^3] // 或移除所有监听(慎用) // EventBus.$off(); } } ``` ### 🌟 全局 EventBus 配置(推荐) 在 `main.js` 中全局挂载,避免重复导入: ```javascript // main.js import Vue from 'vue'; Vue.prototype.$EventBus = new Vue(); // 全局可用 this.$EventBus [^4] ``` 使用方式: ```javascript // 任意组件中直接调用 this.$EventBus.$on('eventName', callback); this.$EventBus.$emit('eventName', data); ``` ### ⚠️ 注意事项 1. **事件命名冲突**:建议使用模块化前缀(如 `userModule:update`) 2. **内存管理**:组件销毁时必须移除监听,否则会导致重复触发 [^1] 3. **替代方案**:复杂场景建议使用 Vuex,EventBus 适合简单组件通信 [^1] 4. **TS 支持**:使用 TypeScript 时可定义事件类型增强安全性 > 示例场景:跨层级组件(如孙子组件 → 祖父组件)传递数据,或非父子关系的兄弟组件通信。 --- ### 相关问题 1. EventBus 在什么场景下可能导致内存泄漏?如何避免? 2. 如何在 TypeScript 中为 EventBus 的事件添加类型校验? 3. Vue 3 的 Composition API 中如何使用 EventBus? 4. EventBusVuex 的核心区别是什么?如何选择? 5. 如何实现 EventBus 的「一次性事件监听」功能? [^1]: 需在组件销毁时移除监听避免内存问题 [^2]: 全局 EventBus 可减少重复导入 [^3]: `$on` 监听事件,`$emit` 触发事件 [^4]: 通过 Vue 原型链实现全局访问
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值