【转载】总结 Vue3 的七种组件通信方式

本篇文章是全部采用的 <script setup> 这种组合式API写法,相对于选项式来说,组合式API这种写法更加自由,具体可以参考Vue文档[1]对两种方式的描述。

图片

本篇文章将介绍如下七种组件通信方式:

  • props
  • emit
  • v-model
  • refs
  • provide/inject
  • eventBus
  • vuex/pinia(状态管理工具)

举一个栗子

俗话说的好,学习不写demo,那就是耍流氓~

本篇文章将围绕下面这个demo,如下图所示:

image-20220817202716127

上图中,列表输入框分别是父子组件,根据不同传值方式,可能谁是父组件谁是子组件会有所调整。

Props方式

Props方式是Vue中最常见的一种父传子的一种方式,使用也比较简单。

根据上面的demo,我们将数据以及对数据的操作定义在父组件,子组件仅做列表的一个渲染;

父组件代码如下:

 <template>
   <!-- 子组件 -->
   <child-components :list="list"></child-components>
   <!-- 父组件 -->
   <div class="child-wrap input-group">
     <input
       v-model="value"
       type="text"
       class="form-control"
       placeholder="请输入"
     />
     <div class="input-group-append">
       <button @click="handleAdd" class="btn btn-primary" type="button">
         添加
       </button>
     </div>
   </div>
 </template>
 <script setup>
 import { ref } from 'vue'
 import ChildComponents from './child.vue'
 const list = ref(['JavaScript', 'HTML', 'CSS'])
 const value = ref('')
 // add 触发后的事件处理函数
 const handleAdd = () => {
   list.value.push(value.value)
   value.value = ''
 }
 </script>

子组件只需要对父组件传递的值进行渲染即可,代码如下:

 <template>
   <ul class="parent list-group">
     <li class="list-group-item" v-for="i in props.list" :key="i">{{ i }}</li>
   </ul>
 </template>
 <script setup>
 import { defineProps } from 'vue'
 const props = defineProps({
   list: {
     type: Array,
     default: () => [],
   },
 })
 </script>

emit方式

emit方式也是Vue中最常见的组件通信方式,该方式用于子传父

根据上面的demo,我们将列表定义在父组件,子组件只需要传递添加的值即可。另外,搜索公众号顶级科技后台回复“API接口”,获取一份惊喜礼包。

子组件代码如下:

<template>
   <div class="child-wrap input-group">
     <input
       v-model="value"
       type="text"
       class="form-control"
       placeholder="请输入"
     />
     <div class="input-group-append">
       <button @click="handleSubmit" class="btn btn-primary" type="button">
         添加
       </button>
     </div>
   </div>
 </template>
 <script setup>
 import { ref, defineEmits } from 'vue'
 const value = ref('')
 const emits = defineEmits(['add'])
 const handleSubmit = () => {
   emits('add', value.value)
   value.value = ''
 }
 </script>

在子组件中点击【添加】按钮后,emit一个自定义事件,并将添加的值作为参数传递。

父组件代码如下:

<template>
   <!-- 父组件 -->
   <ul class="parent list-group">
     <li class="list-group-item" v-for="i in list" :key="i">{{ i }}</li>
   </ul>
   <!-- 子组件 -->
   <child-components @add="handleAdd"></child-components>
 </template>
 <script setup>
 import { ref } from 'vue'
 import ChildComponents from './child.vue'
 const list = ref(['JavaScript', 'HTML', 'CSS'])
 // add 触发后的事件处理函数
 const handleAdd = value => {
   list.value.push(value)
 }
 </script>

在父组件中只需要监听子组件自定义的事件,然后执行对应的添加操作。

v-model是Vue中一个比较出色的语法糖,就比如下面这段代码

 <ChildComponent v-model:title="pageTitle" />

就是下面这段代码的简写形势

 <ChildComponent :title="pageTitle" @update:title="pageTitle = $event" />

v-model确实简便了不少,现在我们就来看一下上面那个demo,如何用v-model实现。

子组件

 <template>
   <div class="child-wrap input-group">
     <input
       v-model="value"
       type="text"
       class="form-control"
       placeholder="请输入"
     />
     <div class="input-group-append">
       <button @click="handleAdd" class="btn btn-primary" type="button">
         添加
       </button>
     </div>
   </div>
 </template>
 <script setup>
 import { ref, defineEmits, defineProps } from 'vue'
 const value = ref('')
 const props = defineProps({
   list: {
     type: Array,
     default: () => [],
   },
 })
 const emits = defineEmits(['update:list'])
 // 添加操作
 const handleAdd = () => {
   const arr = props.list
   arr.push(value.value)
   emits('update:list', arr)
   value.value = ''
 }
 </script>

在子组件中我们首先定义propsemits,然后添加完成之后emit指定事件。

注:update:*是Vue中的固定写法,*表示props中的某个属性名。

父组件中使用就比较简单,代码如下:

 <template>
   <!-- 父组件 -->
   <ul class="parent list-group">
     <li class="list-group-item" v-for="i in list" :key="i">{{ i }}</li>
   </ul>
   <!-- 子组件 -->
   <child-components v-model:list="list"></child-components>
 </template>
 <script setup>
 import { ref } from 'vue'
 import ChildComponents from './child.vue'
 const list = ref(['JavaScript', 'HTML', 'CSS'])
 </script>

refs方式

在使用选项式API时,我们可以通过this.$refs.name的方式获取指定元素或者组件,但是组合式API中就无法使用哪种方式获取。如果我们想要通过ref的方式获取组件或者元素,需要定义一个同名的Ref对象,在组件挂载后就可以访问了。

示例代码如下:

 <template>
   <ul class="parent list-group">
     <li class="list-group-item" v-for="i in childRefs?.list" :key="i">
       {{ i }}
     </li>
   </ul>
   <!-- 子组件 ref的值与<script>中的保持一致 -->
   <child-components ref="childRefs"></child-components>
   <!-- 父组件 -->
 </template>
 <script setup>
 import { ref } from 'vue'
 import ChildComponents from './child.vue'
 const childRefs = ref(null)
 </script>

子组件代码如下:

 <template>
   <div class="child-wrap input-group">
     <input
       v-model="value"
       type="text"
       class="form-control"
       placeholder="请输入"
     />
     <div class="input-group-append">
       <button @click="handleAdd" class="btn btn-primary" type="button">
         添加
       </button>
     </div>
   </div>
 </template>
 <script setup>
 import { ref, defineExpose } from 'vue'
 const list = ref(['JavaScript', 'HTML', 'CSS'])
 const value = ref('')
 // add 触发后的事件处理函数
 const handleAdd = () => {
   list.value.push(value.value)
   value.value = ''
 }
 defineExpose({ list })
 </script>

setup组件默认是关闭的,也即通过模板ref获取到的组件的公开实例,不会暴露任何在 <script setup>中声明的绑定。如果需要公开需要通过defineExpose** API暴露。

provide/inject方式

provideinject是Vue中提供的一对API,该API可以实现父组件向子组件传递数据,无论层级有多深,都可以通过这对API实现。示例代码如下所示:

父组件

 <template>
   <!-- 子组件 -->
   <child-components></child-components>
   <!-- 父组件 -->
   <div class="child-wrap input-group">
     <input
       v-model="value"
       type="text"
       class="form-control"
       placeholder="请输入"
     />
     <div class="input-group-append">
       <button @click="handleAdd" class="btn btn-primary" type="button">
         添加
       </button>
     </div>
   </div>
 </template>
 <script setup>
 import { ref, provide } from 'vue'
 import ChildComponents from './child.vue'
 const list = ref(['JavaScript', 'HTML', 'CSS'])
 const value = ref('')
 // 向子组件提供数据
 provide('list', list.value)
 // add 触发后的事件处理函数
 const handleAdd = () => {
   list.value.push(value.value)
   value.value = ''
 }
 </script>

子组件

 template>
   <ul class="parent list-group">
     <li class="list-group-item" v-for="i in list" :key="i">{{ i }}</li>
   </ul>
 </template>
 <script setup>
 import { inject } from 'vue'
 // 接受父组件提供的数据
 const list = inject('list')
 </script>

值得注意的是使用provide进行数据传递时,尽量readonly进行数据的包装,避免子组件修改父级传递过去的数据

事件总线

Vue3中移除了事件总线,但是可以借助于第三方工具来完成,Vue官方推荐mitttiny-emitter

在大多数情况下不推荐使用全局事件总线的方式来实现组件通信,虽然比较简单粗暴,但是长久来说维护事件总线是一个大难题,所以这里就不展开讲解了,具体可以阅读具体工具的文档

状态管理工具

VuexPinia是Vue3中的状态管理工具,使用这两个工具可以轻松实现组件通信,由于这两个工具功能比较强大,这里就不做展示了,具体可以查阅文档

链接:juejin.cn/post/7062740057018335245

版权申明:内容来源网络,版权归原创者所有。除非无法确认,我们都会标明作者及出处,如有侵权烦请告知,我们会立即删除并表示歉意。谢谢!

© 版权声明
THE END
喜欢就支持一下吧
点赞15 分享
评论 抢沙发

请登录后发表评论

    暂无评论内容