快捷導(dǎo)航

Vue3中事件總線的具體使用

更新時間：2023年04月11日 14:28:57 作者：zerotower

本文主要介紹了Vue3中事件總線的具體使用，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

導(dǎo)讀

在Vue2中，我們遇到復(fù)雜的組件通信時，經(jīng)常采用事件總線的方式來通信。其具體的思路就是實例化一個空白的Vue，并通過其提供的$on、$once、$emit方法來進行通信。而在Vue3中，上述三個API已經(jīng)被移除了，那么我們又如何使用事件總線呢？

事件總線的本質(zhì)

Vue2中的$on、$once、$emit本質(zhì)上就是其內(nèi)部實現(xiàn)了一個EventEmitter(事件派發(fā)器)，每一個事件都和若干回調(diào)相對應(yīng)，只要事件被觸發(fā)，那么就將執(zhí)行此事件所有對應(yīng)的回調(diào)。同時，在JavaScript中，該思想被廣泛地使用，尤其在Node.js的事件機制中，就是創(chuàng)建了一個EventEmitter實例，具體請自行查閱相關(guān)資料。因此，我們只需要實現(xiàn)一個簡單的EventEmitter，并全局傳遞到每一個組件中，就可以實現(xiàn)一個事件總線了。而全局傳遞，我們可以使用config.globalProperties綁定到每一個組件，也可以在根組件（main）中，通過provide提供總線，需要使用的組件使用inject注入。下面就讓我們來實現(xiàn)一下吧。

構(gòu)建一個EventEmitter

由于我們可能會有多條總線，我們還是把EventEmitter寫成類的方式，每一條總線都將是一個EventEmitter實例。以下是EventEmitter的簡單實現(xiàn)，其只實現(xiàn)了on、once、emit三個API。

class EventEmitter{
    constructor(){
        this.callbacks={};
    }
    on(envetName,callback){
        if(!Array.isArray(this.callbacks[envetName])){
            this.callbacks[envetName]=[];
        }
        this.callbacks[envetName].push(callback);
    }
    emit(eventName,...args){
        if(Array.isArray(this.callbacks[eventName])){
            this.callbacks[eventName].forEach(callback=>callback(...args));
        }
    }
    off(eventName,callback){
        if(!Array.isArray(this.callbacks[eventName])){
            return
        }
        if(callback){
            this.callbacks[eventName].forEach(cb=>{
                if(callback===cb){
                    this.callbacks[eventName].splice(this.callbacks[eventName].indexOf(callback),1);
                }
            });
        } else{
            this.callbacks[eventName]=[];
        }
    }
    once(eventName,callback){
        const that=this;
        const fn=function(){
            callback.apply(that,[...arguments]);
            that.off(eventName,fn);
        }
        that.on(eventName,fn);
    }
}

具體的代碼基本上還是很好理解的，就不在本文解釋了，具體請自行查閱相關(guān)的資料。

將EventEmitter實例化并全局引入

上文已經(jīng)說了有兩種引入EventEmitter的方法，這里簡單地給個參考實例吧。

config.globalProperties方法

在main.js中

import { createApp } from 'vue'
import './style.css'
import App from './App.vue'
const app=createApp(App);
app.config.globalProperties.$event=new EventEmitter();
app.mount('#app')

在組件中：

//Comp1
<script setup>
import {getCurrentInstance} from "vue"
const vm=getCurrentInstance();
vm.proxy.$event.on('test',()=>{
    console.log('test event emit!')
})
</script>

//Comp2
<script setup>
import {getCurrentInstance} from "vue"
const vm=getCurrentInstance();
vm.proxy.$event.emit('test',"a","b")
</script>

但這種方法不太優(yōu)雅，不方便定義多條總線，建議使用下述的方法。

provide/inject

在main.js中

provide("eventBus1",new EventEmitter());
provide("eventBus2",new EventEmitter());

在組件中

//Comp1
<script setup>
import {inject} from "vue";
const bus1=inject("eventBus1")
bus1.on("bus1-on-event",()=>{
    console.log('eventBus1 on event emit!')
})
</script>
//Comp2
<script setup>
import {inject} from "vue";
const bus1=inject("eventBus1")
const bus2=inject("eventBus2")
bus2.on("bus2-on-event",()=>{
    console.log('eventBus2 on event emit!')
})
bus1.emit("bus1-on-event")
</script>
//Comp3
<script setup>
import {inject} from "vue";
const bus2=inject("eventBus2")
bus2.emit("bus2-on-event")
</script>

此方法中，使用inject也比使用getCurrentInstance再.proxy更優(yōu)雅一些，且不使用就不必使用inject注入。