Vue事件总线(EventBus)使用指南:详细解析与实战应用
Vue事件总线(EventBus)使用指南:详细解析与实战应用
Vue.js中的EventBus是一种基于订阅/发布模式的事件总线机制,能够帮助开发者实现组件间的解耦通信。本文将详细介绍EventBus的工作原理、使用方法以及注意事项,通过具体的代码示例帮助读者快速掌握这一实用技术。
EventBus的简介
EventBus又称为事件总线。在Vue中可以使用EventBus来作为沟通桥梁的概念,就像是所有组件共用相同的事件中心,可以向该中心注册发送事件或接收事件,所以组件都可以上下平行地通知其他组件,但也就是太方便所以若使用不慎,就会造成难以维护的“灾难”,因此才需要更完善的Vuex作为状态管理中心,将通知的概念上升到共享状态层次。
EventBus是基于订阅/发布模式实现的基于事件的异步分发处理系统。好处就是能够解耦订阅者和发布者,简化代码。
发布者通过EventBus发布事件,订阅者通过EventBus订阅事件,当发布者发送事件时,订阅该事件的订阅者的事件处理方法将被调用。从图中看出,发布者发送一个事件时,则该事件将会同时传递给一个或多个该事件的订阅者。
订阅者(Subscriber)把自己想订阅的事件(Event)注册(register)到调度中心(EventBus),当发布者(Publisher)发布该事件到调度中心时,也就是该事件触发时,由调度中心统一调度订阅者注册到调度中心的处理代码(onEvent())。
EventBus的优点
- 简化了组件间间的通信;
- 对事件通信双方进行解耦 ;
- 避免了复杂且容易出错的依赖性和生命周期问题;
- 速度快,性能好,代码简单优雅;
- 分离了事件的发送者和接受者;
如何使用EventBus
一、初始化
首先需要创建事件总线并将其导出,以便其它模块可以使用或者监听它。我们可以通过两种方式来处理。先来看第一种,新创建一个 .js 文件,比如 event-bus.js
// event-bus.js
import Vue from 'vue'
export const EventBus = new Vue()
实质上EventBus是一个不具备 DOM 的组件,它具有的仅仅只是它实例方法而已,因此它非常的轻便。
另外一种方式,可以直接在项目中的 main.js 初始化 EventBus:
// main.js
Vue.prototype.$EventBus = new Vue()
注意,这种方式初始化的EventBus是一个全局的事件总线。稍后再来聊一聊全局的事件总线。
现在我们已经创建了EventBus,接下来你需要做到的就是在你的组件中加载它,并且调用同一个方法,就如你在父子组件中互相传递消息一样。
二、发送事件
假设你有两个Vue页面需要通信:A和B,A页面在按钮上面绑定了点击事件,发送一则消息,想通知B页面。
<!-- A.vue -->
<template>
<button @click="sendMsg()">-</button>
</template>
<script>
import { EventBus } from "../event-bus.js";
export default {
methods: {
sendMsg() {
EventBus.$emit("aMsg", '来自A页面的消息');
}
}
};
</script>
接下来,我们需要在B页面接收这则消息。
三、接收事件
<!-- IncrementCount.vue -->
<template>
<p>{{msg}}</p>
</template>
<script>
import {
EventBus
} from "../event-bus.js";
export default {
data(){
return {
msg: ''
}
},
mounted() {
EventBus.$on("aMsg", (msg) => {
// A发送来的消息
this.msg = msg;
});
}
};
</script>
同理我们也可以在B页面向A页面发送消息。这里主要用到的两个方法:
// 发送消息
EventBus.$emit(channel: string, callback(payload1,…))
// 监听接收消息
EventBus.$on(channel: string, callback(payload1,…))
前面提到过,如果使用不善,EventBus会是一种灾难,到底是什么样的“灾难”了?大家都知道vue是单页应用,如果你在某一个页面刷新了之后,与之相关的EventBus会被移除,这样就导致业务走不下去。还要就是如果业务有反复操作的页面,EventBus在监听的时候就会触发很多次,也是一个非常大的隐患。这时候我们就需要好好处理EventBus在项目中的关系。通常会用到,在vue页面销毁时,同时移除EventBus事件监听。
四、移除事件监听者
如果想移除事件的监听,可以像下面这样操作:
import {
eventBus
} from './event-bus.js'
EventBus.$off('aMsg', {})
你也可以使用EventBus.$off(‘aMsg’)来移除应用内所有对此某个事件的监听。或者直接调用EventBus.$off()来移除所有事件频道,不需要添加任何参数。
上面就是EventBus的使用方法,是不是很简单。上面的示例中我们也看到了,每次使用EventBus时都需要在各组件中引入event-bus.js。事实上,我们还可以通过别的方式,让事情变得简单一些。那就是创建一个全局的EventBus。接下来的示例向大家演示如何在Vue项目中创建一个全局的EventBus。
五、创建全局EventBus
var EventBus = new Vue();
Object.defineProperties(Vue.prototype, {
$bus: {
get: function () {
return EventBus
}
}
})
在这个特定的总线中使用两个方法$on和$emit。一个用于创建发出的事件,它就是$emit;另一个用于订阅$on:
var EventBus = new Vue();
this.$bus.$emit('nameOfEvent', { ... pass some event data ...});
this.$bus.$on('nameOfEvent',($event) => {
// ...
})
然后我们可以在某个Vue页面使用this.$bus.$emit(“sendMsg”, ‘我是web’);,另一个Vue页面使用
this.$bus.$on('sendMsg', function(value) {
console.log(value);
})
同时也可以使用this.$bus.$off(‘sendMsg’)来移除事件监听。
总结
本文主要通过简单的实例学习了Vue中有关于EventBus相关的知识点。主要涉及了EventBus如何实例化,又是如何通过$emit发送频道信号,又是如何通过$on来接收频道信号。最后简单介绍了如何创建全局的EventBus。从实例中我们可以了解到,EventBus可以较好的实现兄弟组件之间的数据通讯。