项目准备知识---vue3组件通信方式总结

硅谷甄选运营平台

本项目技术栈包含：vue3+TypeScript+vue-router+pinia+element-plus+axios+echarts等。

项目顺序	地址
Vue3组件通信方式	https://blog.csdn.net/m0_55644132/article/details/130711542

一、 vue3组件通信方式

vue2组件通信方式：

props：可以实现父子组件、子父组件、甚至兄弟组件通信

自定义事件：可以实现子父组件通信

全局事件总线$bus：可以实现任意组件通信

pubsub：发布订阅模式实现任意组件通信

vuex：集中式状态管理容器，实现任意组件通信

ref：父组件获取子组件实例VC，获取子组件的响应式数据以及方法

slot：插槽(默认插槽、具名插槽、作用域插槽)实现父子组件通信…

1.1 props

props可以实现父子组件通信，在vue3中我们可以通过defineProps获取父组件传递的数据。且在组件内部不需要引入defineProps方法可以直接使用！

父组件给子组件传递数据

// 父组件中给子组件 Child 传数据--静态/动态数据
<Child info="我爱祖国" :money="money"></Child>

子组件获取父组件传递数据:方式1：对象写法

let props = defineProps({
    
    
  info:{
    
    
   type:String,//接受的数据类型
   default:'默认参数',//接受默认数据
  },
  money:{
    
    
   type:Number,
   default:0
}})

子组件获取父组件传递数据:方式2：数组写法

let props = defineProps(["info",'money']);

子组件获取到props数据就可以在模板中使用了，但是切记props是只读的(只能读取，不能修改)

1.2 自定义事件

在vue框架中事件分为两种：一种是原生的DOM事件，另外一种自定义事件。（vue2中需要添加 .native）

原生DOM事件可以让用户与网页进行交互，比如click、dbclick、change、mouseenter、mouseleave…

自定义事件可以实现子组件给父组件传递数据

1.2.1 原生DOM事件

代码如下：

 <pre @click="handler">
      我是祖国的老花骨朵
 </pre>

当前代码级给pre标签绑定原生DOM事件点击事件，默认会给事件回调注入event事件对象。当然点击事件想注入多个参数可以按照下图操作。但是切记注入的事件对象务必叫做$event

  <div @click="handler1(1,2,3,$event)">我要传递多个参数</div>

在vue3框架click、dbclick、change(这类原生DOM事件)，不管是在标签、自定义标签上(组件标签)都是原生DOM事件。

vue2中却不是这样的，在vue2中组件标签需要通过native修饰符才能变为原生DOM事件

1.2.2 自定义事件

自定义事件可以实现子组件给父组件传递数据，在项目中是比较常用的。

比如在父组件内部给子组件(Event2)绑定一个自定义事件

<Event2  @xxx="handler3"></Event2>

在Event2子组件内部触发这个自定义事件

<template>
  <div>
    <h1>我是子组件2</h1>
    <button @click="handler">点击我触发xxx自定义事件</button>
  </div>
</template>

<script setup lang="ts">
let $emit = defineEmits(["xxx"]);
const handler = () => {
    
    
  $emit("xxx", "法拉利", "茅台");
};
</script>
<style scoped>
</style>

我们会发现在script标签内部，使用了defineEmits方法，此方法是vue3提供的方法，不需要引入直接使用。defineEmits方法执行，传递一个数组，数组元素即为将来组件需要触发的自定义事件类型，此方执行会返回一个$emit方法用于触发自定义事件。

当点击按钮的时候，事件回调内部调用$emit方法去触发自定义事件，第一个参数为触发事件类型，第二个、三个、N个参数即为传递给父组件的数据。

需要注意的是：代码如下

<Event2  @xxx="handler3" @click="handler"></Event2>

注意：正常说组件标签书写@click应该为原生DOM事件，但是如果子组件内部通过defineEmits定义就变为自定义事件了

let $emit = defineEmits(["xxx",'click']);

1.3 全局事件总线

全局事件总线可以实现任意组件通信，在vue2中可以根据VM与VC关系推出全局事件总线。但是在vue3中没有Vue构造函数，也就没有Vue.prototype.以及组合式API写法没有this，那么在Vue3想实现全局事件的总线功能就有点不现实啦，如果想在Vue3中使用全局事件总线功能可以使用插件mitt实现。

mitt:官网地址：https://www.npmjs.com/package/mitt

src/bus/index.ts

//引入mitt插件:mitt一个方法,方法执行会返回bus对象
import mitt from 'mitt';
const $bus = mitt();
export default $bus;

子组件1中—收数据

import $bus from "../../bus";
//组合式API函数
import {
    
     onMounted } from "vue";
//组件挂载完毕的时候,当前组件绑定一个事件,接受将来兄弟组件传递的数据
onMounted(() => {
    
    
  //第一个参数:即为事件类型  第二个参数:即为事件回调
  $bus.on("car", (car) => {
    
    
    console.log(car);
  });

子组件2中—发数据（兄弟组件通信）

<button @click="handler">点击我给兄弟送一台法拉利</button>

//引入$bus对象
import $bus from '../../bus';
//点击按钮回调
const handler = ()=>{
    
    
  $bus.emit('car',{
    
    car:"法拉利"});
}

1.4 v-model

v-model指令可是收集表单数据(数据双向绑定)，除此之外它也可以实现父子组件数据同步。

而v-model实指利用props[modelValue]与自定义事件[update:modelValue]实现的。

下方代码：相当于给组件Child传递一个props(modelValue)与绑定一个自定义事件update:modelValue

实现父子组件数据同步

// 父组件中
<Child v-model="msg"></Child>

在vue3中一个组件可以通过使用多个v-model，让父子组件多个数据同步，下方代码相当于给组件Child传递两个props分别是pageNo与pageSize，以及绑定两个自定义事件update:pageNo与update:pageSize实现父子数据同步

<Child v-model:pageNo="msg" v-model:pageSize="msg1"></Child>

注意：父组件中如果不用到子组件的参数，可以不用准备回调函数（子组件不用传数据给父组件），子组件直接触发就可以

而使用v-model的话，相当于父组件准备了一个回调函数（其实没写，子组件接收时的名字我们自己定，如update:pageNo），然后传给子组件，子组件触发即可（注意是相当于！）

1.5 useAttrs

在Vue3中可以利用useAttrs方法获取组件的属性与事件(包含:原生DOM事件或者自定义事件)，次函数功能类似于Vue2框架中$attrs属性与$listeners方法。

比如:在父组件内部使用一个子组件my-button

<my-button type="success" size="small" title='标题' @click="handler"></my-button>

子组件内部可以通过useAttrs方法获取组件属性与事件。因此你也发现了，它**类似于props，可以接受父组件传递过来的属性与属性值。**需要注意如果defineProps接受了某一个属性，useAttrs方法返回的对象身上就没有相应属性与属性值。

// 子组件使用useAttrs接收父组件传的东西
<script setup lang="ts">
import {
    
    useAttrs} from 'vue';
let $attrs = useAttrs();
</script>

useAttrs属于兜底的操作。如果props接收了，那么useAttrs身上就没有了。props的优先级更高

1.6 ref与$parent

ref，提及到ref可能会想到它可以获取元素的DOM或者获取子组件实例的VC。既然可以在父组件内部通过ref获取子组件实例VC，那么子组件内部的方法与响应式数据父组件可以使用的。

比如：在父组件挂载完毕获取组件实例

父组件内部代码:

<template>
  <div>
    <h1>ref与$parent</h1>
    <Son ref="son"></Son>
  </div>
</template>
<script setup lang="ts">
import Son from "./Son.vue";
import {
    
     onMounted, ref } from "vue";
const son = ref();
onMounted(() => {
    
    
  console.log(son.value);
});
</script>

但是需要注意，如果想让父组件获取子组件的数据或者方法需要通过defineExpose对外暴露,因为vue3中组件内部的数据对外“关闭的”，外部不能访问。（拿到组件实例，但拿不到组件数据）

<script setup lang="ts">
import {
    
     ref } from "vue";
//数据
let money = ref(1000);
//方法
const handler = ()=>{
    
    
}
defineExpose({
    
    
  money,
   handler
})
</script>

$parent可以获取某一个组件的父组件实例VC，因此可以使用父组件内部的数据与方法。必须子组件内部拥有一个按钮点击时候获取父组件实例，当然父组件的数据与方法需要通过defineExpose方法对外暴露

// 子组件中---注入$parent，必须叫这个；同时父组件的数据也要对外暴露
<button @click="handler($parent)">点击我获取父组件实例</button>

1.7 provide与inject

provide[提供]

inject[注入]

vue3提供两个方法provide与inject，可以实现隔辈组件传递参数。祖先组件给后代组件传数据。

祖先组件提供数据：

provide方法用于提供数据，此方法执需要传递两个参数，分别提供数据的key与提供数据value

<script setup lang="ts">
import {
    
    provide} from 'vue'
provide('token','admin_token');// 后代都可以通过inject方法去使用这个数据
</script>

后代组件可以通过inject方法获取数据,通过key获取存储的数值

<script setup lang="ts">
import {
    
    inject} from 'vue'
let token = inject('token');
</script>

注意：后代组件可以修改数据，祖先组件里的也会跟着改。这是与props的区别之一

1.8pinia

pinia官网：https://pinia.web3doc.top/

pinia也是集中式管理状态容器，类似于vuex。但是核心概念没有mutation、modules，使用方式参照官网

缺点：与vuex一样，存储的数据并非持久化

pinia选项式API写法

src/store/index.ts

//创建大仓库
import {
    
     createPinia } from 'pinia';
//createPinia方法可以用于创建大仓库
let store = createPinia();
//对外暴露,安装仓库
export default store;

入口文件 main.ts

//引入仓库
import store from './store'
app.use(store)

创建小仓库

src/store/modules/info.ts

//定义info小仓库
import {
    
     defineStore } from "pinia";
//第一个仓库:小仓库名字  第二个参数:小仓库配置对象
//defineStore方法执行会返回一个函数,函数作用就是让组件可以获取到仓库数据
let useInfoStore = defineStore("info", {
    
    
    //存储数据:state
    state: () => {
    
    
        return {
    
    
            count: 99,
            arr: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
        }
    },
    actions: {
    
    
        //注意:函数没有context上下文对象
        //没有commit、没有mutations去修改数据
        updateNum(a: number, b: number) {
    
    
            this.count += a;
        }
    },
    getters: {
    
    
        total() {
    
    
            let result:any = this.arr.reduce((prev: number, next: number) => {
    
    
                return prev + next;
            }, 0);
            return result;
        }
    }
});
//对外暴露方法
export default useInfoStore;

组件想使用数据，Child组件（其他组件也可以使用）

import useInfoStore from "../../store/modules/info";
//获取小仓库对象
let infoStore = useInfoStore();

// 使用
<h1>{
    
    {
    
     infoStore.count }}---{
    
    {
    
    infoStore.total}}</h1>

组件中直接修改仓库的数据，或者使用**$patch**到仓库中修改，还可以使用类似vuex的写法（在action中写好修改仓库数据的方法，那么组件就可以调用仓库身上的修改方法）

注意：函数没有context上下文对象，没有commit、没有mutations去修改数据；通过this去修改

// 组件中
//1 直接修改
const updateCount = ()=> {
    
    
    infoStore.count++;
}

//2 通过 仓库方法$patch 修改
const updateCount = ()=> {
    
    
    infoStore.$patch({
    
    
        count:1111;//新数据替换旧的
    })
}

//3 actions中修改，组件中可以传参数过来的
updateNum(a: number, b: number) {
    
    
    this.count += a;
}

仓库中getter的使用

getters: {
    
    
    total() {
    
    
        let result:any = this.arr.reduce((prev: number, next: number) => {
    
    
            return prev + next;
        }, 0);
        return result;
    }
}

pinia组合式API的写法

//定义组合式API仓库
import {
    
     defineStore } from "pinia";
import {
    
     ref, computed,watch} from 'vue';
//创建小仓库，第二个参数是箭头函数
let useTodoStore = defineStore('todo', () => {
    
    
    let todos = ref([{
    
     id: 1, title: '吃饭' }, {
    
     id: 2, title: '睡觉' }, {
    
     id: 3, title: '打豆豆' }]);
    let arr = ref([1,2,3,4,5]);

    // 实现getters
    const total = computed(() => {
    
    
        return arr.value.reduce((prev, next) => {
    
    
            return prev + next;
        }, 0)
    })
    //务必要返回一个对象:属性与方法可以提供给组件使用
    return {
    
    
        todos,
        arr,
        total,
        updateTodo() {
    
    
            todos.value.push({
    
     id: 4, title: '组合式API方法' });
        }
    }
});

export default useTodoStore;

组合式API中的getters可以通过计算属性实现，甚至可以使用vue的监视等

1.9 slot

插槽：默认插槽、具名插槽、作用域插槽可以实现父子组件通信。

默认插槽:

在子组件内部的模板中书写slot全局组件标签

// 子组件
<template>
  <div>
    <slot></slot>
  </div>
</template>
<script setup lang="ts">
</script>
<style scoped>
</style>

在父组件内部提供结构：Todo即为子组件,在父组件内部使用的时候，在双标签内部书写结构传递给子组件

注意开发项目的时候默认插槽一般只有一个

<Todo>
  <h1>我是默认插槽填充的结构</h1>
</Todo>

具名插槽：

顾名思义，此插槽带有名字在组件内部留多个指定名字的插槽。

下面是一个子组件内部，模板中留两个插槽

<template>
  <div>
    <h1>todo</h1>
    <slot name="a"></slot>
    <slot name="b"></slot>
  </div>
</template>
<script setup lang="ts">
</script>

<style scoped>
</style>

父组件内部向指定的具名插槽传递结构。需要注意v-slot：可以替换为#

<template>
  <div>
    <h1>slot</h1>
    <Todo>
      <template v-slot:a>  //可以用#a替换
        <div>填入组件A部分的结构</div>
      </template>
      <template v-slot:b>//可以用#b替换
        <div>填入组件B部分的结构</div>
      </template>
    </Todo>
  </div>
</template>

<script setup lang="ts">
import Todo from "./Todo.vue";
</script>
<style scoped>
</style>

作用域插槽

作用域插槽：可以理解为，子组件数据由父组件提供，但是子组件内部决定不了自身结构与外观(样式)

子组件Todo代码如下:

<template>
  <div>
    <h1>todo</h1>
    <ul>
     <!--组件内部遍历数组-->
      <li v-for="(item,index) in todos" :key="item.id">
         <!--作用域插槽将数据回传给父组件-->
         <slot :$row="item" :$index="index"></slot>
      </li>
    </ul>
  </div>
</template>
<script setup lang="ts">
defineProps(['todos']);//接受父组件传递过来的数据
</script>
<style scoped>
</style>

父组件内部代码如下:

<template>
  <div>
    <h1>slot</h1>
    <Todo :todos="todos">
      <template v-slot="{$row,$index}">
         <!--父组件决定子组件的结构与外观-->
         <span :style="{color:$row.done?'green':'red'}">{
   
   {$row.title}}</span>
      </template>
    </Todo>
  </div>
</template>

<script setup lang="ts">
import Todo from "./Todo.vue";
import {
      
       ref } from "vue";
//父组件内部数据
let todos = ref([
  {
      
       id: 1, title: "吃饭", done: true },
  {
      
       id: 2, title: "睡觉", done: false },
  {
      
       id: 3, title: "打豆豆", done: true },
]);
</script>
<style scoped>
</style>