vue3中使用全局事件总线通信

全局事件总线通信可以用于多个组件之前相互通信,包括但不限于父子、兄弟组件间通信。

注意1：emit分发和on接收需要在onMounted或之后的生命周期执行，否则无效。

注意2：刷新页面后，已更新的数据将回到初始值。

.emit('事件名', 参数) 触发总线上指定的事件
.on('事件名','回调函数') 接收总线上某个事件
.off('事件名') 清除总线上指定事件
.all.clear() 清除总线上绑定的所有事件

安装mitt：

打开终端 npm install mitt

我写文章时的版本号是"mitt": "^3.0.1",

main.ts文件代码：

import { createApp } from 'vue'
import App from '@/App.vue'
// 全局事件总线
import mitt from 'mitt'
const app: any = createApp(App)
app.config.globalProperties.$mittBus = mitt()
app.mount('#app')

父组件代码：

<template>
  <div style="font-size: 14px">
    <h3>测试vue3全局事件总线</h3>
    <div>{{ user }}</div>
    <!-- <ChildA /> -->
    <ChildB />
    <ChildA />
  </div>
</template>

<script lang="ts">
import {
  defineComponent,
  reactive,
  onMounted,
  toRefs,
  getCurrentInstance,
} from 'vue'
import ChildA from './ChildA.vue'
import ChildB from './ChildB.vue'
// vue3.0语法
export default defineComponent({
  name: '父组件名',
  components: {
    ChildA,
    ChildB
  },
  setup() {
    const { proxy } = getCurrentInstance()
    // const { $mittBus } = getCurrentInstance()?.appContext.config.globalProperties

    const state = reactive({
      id: '',
      user: {
        name: '',
        age: 0,
      },
    })
    onMounted(() => {
      // 注意不能再onMounted生命周期之前调用$mittBus.emit()
      // 模拟一个接口请求
      setTimeout(() => {
        state.id = '父组件请求接口得来的id'
        state.user = {
          name: '张三',
          age: 18,
        }
        proxy.$mittBus.emit('mittUser', state.user)
      }, 300)
    })

    return {
      ...toRefs(state),
    }
  },
})
</script>

子组件A代码：

<template>
  <div style="font-size: 14px;background: skyblue;">
    <!-- 子组件A内容 -->
    <h3>子组件A</h3>
    <p>子组件A接收到的state{{ state }}</p>
    <button @click="setState">点击emit修改全局总线state mittUser{{ state }}</button>
    <br>
    <!-- 点击不会又作用 -->
    <button @click="getState">点击on修改全局总线state mittUser{{ state }}</button>
    <br>
    <!-- 解除后 被解除的事件 不再生效 -->
    <button @click="clearEvent">解除全局事件总线上的mittUser事件</button>
    <br>
    <button @click="clearAllEvent">解除全局事件总线上的所有绑定的事件</button>
  </div>
  <!-- <Grandson /> -->
</template>

<script lang="ts">
import { defineComponent, onMounted, getCurrentInstance, ref } from 'vue'
// vue3.0语法
export default defineComponent({
  name: 'ChildA',
  setup() {
    const { proxy } = getCurrentInstance()
    // const { $mittBus } = getCurrentInstance()?.appContext.config.globalProperties
    const state = ref({})
    function getState() {
      console.log('$mittBus', proxy.$mittBus)
      proxy.$mittBus.on('mittUser', (data) => {
        console.log('mitt.on: data', data)
        data.name += '丰'
        data.age += 1
        state.value = data
      })
      proxy.$mittBus.emit('mittUserA', {
        name: '李四A',
        age: 6
      })
    }
    function setState() {
      proxy.$mittBus.emit('mittUser', {
        name: state.value.name + 'A',
        age: state.value.age + 1
      })
    }
    // 清除事件
    function clearEvent() {
      proxy.$mittBus.off('mittUser')
      // console.log('off', proxy.$mittBus)
    }
    // 清除所有事件
    function clearAllEvent() {
      proxy.$mittBus.all.clear()
      // console.log('all.clear', proxy.$mittBus)
    }
    onMounted(() => {
      // 二次调用也能生效 更新数据
      getState()
      // getState()
    })
    // 可以在页面销毁前清除事件
    // onUnmounted(() => {
    //   proxy.$mittBus.off('mittUserA')
    // })
    return {
      state, getState, setState, clearEvent, clearAllEvent
    }
  },
})
</script>

子组件B代码：

<template>
  <div style="font-size: 14px;background: pink;">
    <!-- 子组件B内容 -->
    <h3>子组件B</h3>
    <p>子组件B接收到的state{{ state }}</p>
    <p>子组件B接收到（来自子组件A）的userA{{ userA }}</p>
  </div>
  <!-- <Grandson /> -->
</template>

<script lang="ts">
import { defineComponent, onMounted, getCurrentInstance, ref } from 'vue'
// vue3.0语法
export default defineComponent({
  name: 'ChildB',
  setup() {
    const { proxy } = getCurrentInstance()
    // const { $mittBus } = getCurrentInstance()?.appContext.config.globalProperties
    const state = ref({})
    const userA = ref({})
    function getState() {
      // 接口来自父组件分发的事件
      proxy.$mittBus.on('mittUser', (data) => {
        state.value = data
      })
      // 接口来自兄弟组件分发的事件
      proxy.$mittBus.on('mittUserA', (val) => { userA.value = val })
    }
    onMounted(() => {
      getState()
    })
    return {
      state, userA, getState
    }
  },
})
</script>