前言
正如我们所知Vue中组件的通信场景很多, 什么跨多级父子通信, 兄弟通信等等。各种各样的解决方法网上方法都有以及多得飞起, 我就不复制黏贴, 省点ATP。在Vue生态中已经有很好的方案解决各种疑难杂症的通信问题, 针对中大型项目, 首选Vuex (用过都说好),但是如果是小型项目使用Vue的eventBus, 是一个不错的选择。我们接下来简单说下Vue的事件总线的使用和一些常见的问题。
使用方法
Vue的实例就是一个事件总线:
import Vue from 'vue';
var vm = new Vue({
mounted () {
## 此时就可以监听一个自定义事件event1
this.$on('event1', (data) => {
consolo.log(data);
});
},
methods: {
trigger () {
this.$emit('event1', '猴赛雷~');
}
}
});
vm.trigger(); ## 输出: 猴赛雷~
看得出eventBus的使用就是在一个组件内通过 o n 一 个 事 件 , 在 一 些 操 作 下 on一个事件, 在一些操作下 on一个事件,在一些操作下emit事件, 这个看起来跟订阅发布是一回事。
但是这里的eventBus是局部的, 只能在这个组件内用, 如果在一个父组件A监听了事件, 在B子组件去emit, 是没有反应的,
因为子组件B自己木有监听该事件。
A.vue文件:
export default {
created () {
this.$on('你是不是嘤嘤怪', (嘤) => {
if (嘤.length >= 3) {
console.log('你就是嘤嘤怪');
}
})
}
}
B.vue文件:
export default {
mounted () {
this.$emit('你是不是嘤嘤怪', '嘤嘤嘤嘤');
}
}
实现一个全局的eventBus
全局的eventBus简单理解为在一个文件创建一个新的vue实例然后暴露出去,
使用的时候import这个模块进来即可。我们来编写下这个文件:
在项目中新增一个文件eventBus.js, 代码实现如下:
在项目中新增一个文件eventBus.js, 代码实现如下:
import Vue from 'vue';
const Bus = new Vue();
const eventBus = {
TYPES: { // 'TYPES'
EVENT1: { // 'TYPES.EVENT1'
EDIT: { // 'TYPES.EVENT1.EDIT'
INVOKE: {},
CANCEL: {}, // 'TYPES.EVENT1.EDIT.CANCEL'
CONFIRM: {}
},
ADD: {
INVOKE: {},
CANCEL: {},
CONFIRM: {}
},
},
EVENT2: {
EDIT: {
INVOKE: {},
CANCEL: {},
CONFIRM: {}
},
DELETE: {
INVOKE: {},
CANCEL: {},
CONFIRM: {}
},
}
},
// 注册事件函数
on (eventType, cb = () => {}) {
Bus.$on(eventType.toString(), (...args) => {
cb(...args);
});
},
// 触发事件函数
emit (eventType, data) {
Bus.$emit(eventType.toString(), data);
},
// 销毁注册事件函数
off (eventType) {
Bus.$off(eventType.toString());
},
// 注册事件触发一次后销毁函数
once (eventType, cb = () => {}) {
Bus.$on(eventType.toString(), (...args) => {
cb(...args);
eventBus.off(eventType.toString());
});
}
};
(function (typeRoot) {
/**
* @param {*} source 要给每个节点添加链的对象
* @param {*} parentNode 当前节点的链 比如 EVENT1.EDIT.CANCEL
*/
function addNodeChain(source, parentNode = 'TYPES') {
const isObj = typeof source === 'object';
if (!isObj) return; // 支持传入默认的字符串方式
const separator = !!parentNode ? '.' : '';
const isObjEmpty = Object.keys(source).length === 0;
if (isObjEmpty) {
source['nodeChain'] = parentNode;
source.toString = function () {
return parentNode;
}
return;
}
for (const key in source) {
if (source.hasOwnProperty(key)) {
source['nodeChain'] = parentNode;
source.toString = function () {
return parentNode;
}
const nodeChain = parentNode + separator + key;
addNodeChain(source[key], nodeChain);
}
}
}
addNodeChain(typeRoot);
Object.freeze(eventBus);
window.eventBus = eventBus;
})(eventBus.TYPES);
export default eventBus;
上面的定义了一个eventBus对象,里面定义以下五个属性:
TYPES:
因为on方法第一个传入的参数是字符串, 也是事件名字, 如果订阅事件多了, 在项目中必然会存在不少的字符串,
如果不小心写错事件名(多写少些个字母啥的~), Vue并不会给你报错, 这对错误跟踪和定位都是比较困难的,
因此我们最好有一个专门的文件来管理和维护这些事件名。这里使用对象嵌套的方式来事先定义事件名称, 使用的时候比如
eventBus.on(eventBus.TYPES.EVENT1.UPDATE.INVOKE),
因为事先没有定义eventBus.TYPES.EVENT1.UPDATE, undefined没有INVOKE属性, 控制台直接报错,
这样做的好处在一定情况避免了上面所说的问题。
addNodeChain:
这个方法是遍历整个对象, 给每个节点添加nodeChain属性, 也是当前节点的到根节点的链。 并且重写了当前节点的toString方法,
返回当前节点的nodeChain, 我们来打印一下执行addNodeChain后eventBus.TYPES的结构。
{EVENT1: {…}, EVENT2: {…}, nodeChain: "TYPES", toString: ƒ}
EVENT1: {
ADD: {
CANCEL: {
nodeChain: "TYPES.EVENT1.ADD.CANCEL",
toString: ƒ (),
},
CONFIRM: {nodeChain: "TYPES.EVENT1.ADD.CONFIRM", toString: ƒ},
INVOKE: {nodeChain: "TYPES.EVENT1.ADD.INVOKE", toString: ƒ},
nodeChain: "TYPES.EVENT1.ADD",
toString: ƒ (),
},
EDIT: {INVOKE: {…}, CANCEL: {…}, CONFIRM: {…}, nodeChain: "TYPES.EVENT1.EDIT", toString: ƒ}
nodeChain: "TYPES.EVENT1",
toString: ƒ (),
},
EVENT2: {EDIT: {…}, ADD: {…}, nodeChain: "TYPES.EVENT2", toString: ƒ}
nodeChain: "TYPES",
toString: ƒ (),
__proto__: Object,
而在定义事件方法on时:
on (eventType, cb = () => {}) {
Bus.$on(eventType.toString(), (...args) => {
cb(...args);
});
},
上面会把接受进来的参数调用toString方法,传入给Bus.$on, 因此事件名称还是字符串。
至此, 我们的eventBus就可以用了。
验证我们的eventBus
我们验证常见的两个场景:
父子组件通信
兄弟组件通信
有以下父组件A, 和子组件B, C, 其中B, C是兄弟组件:
A.vue:
这个是父组件
--------------------------------------------------------------------------------------------
B.vue:
这个是子组件B
--------------------------------------------------------------------------------------------
C.vue:
这个是子组件C
我们在父组件A和子组件C都注册了事件, 在B组件中通过点击对应的按钮emit事件, 当点击按钮时控制台输出:
嗯, 预期符合结果~~~
eventBus的问题
当我们来回点击上面切换路由, 重新渲染 (父组件A会重新render), 然后再去点击B组件的按钮emit事件, 你会发现, 事件会被重复执行多次, 比如我切换了6次, 事件被触发了6次, emmm:
原因是因为在父组件A和子组件C被destory时候, eventBus.$on的事件是不会被销毁, 组件的每次重新render,
事件就会叠加注册, 而eventBus是全局的,它不会随着你页面切换而重新执行生命周期。
既然eventBus不会随着组件的销毁而注销事件, 那我们可以主动去注销掉事件,
具体的方法就是在eventBus.on的组件中,在beforeDestroy或者 destoryed生命周期中off事件,
我们来修改一下A.vue和C.vue;
**A.vue:
export default {
beforeDestroy () {
eventBus.off(eventBus.TYPES.EVENT1.ADD.CONFIRM);
}
}
-------------------------------------------------------------------------------------
C.vue:
export default {
beforeDestroy () {
eventBus.off(eventBus.TYPES.EVENT1.ADD.INVOKE);
}
}
**
修改后, 就不会出现渲染组件, 叠加注册事件的bug, 每次点击按钮只会被emit一次。
尤大建议到可以使用mixin注入来处理这个bug, 在mixin组件的钩子中off注册的事件
总结