文章目录
一、前提
本篇文章是全部采用的 这种组合式 API 写法,相当于选项式来说,组合式 API 这种写法更加*,具体可参考 vue文档 对两种方式的描述。
本篇文章将介绍如下七种组件通信方式:
● props
● emit
● v-model
● refs
● provide / inject
● eventBus
● vuex / pinia (状态管理工具)
二、举一个例子
上图中,列表和输入框分别是父子组件,根据不同传值方式,可能谁是父组件谁是子组件会有所调整
三、使用详情
1. Props 方式
Props
方式是 Vue 中最常见的一种 父传子 的一种方式
父组件代码如下:
<template>
<!--子组件标签-->
<child-components
:list="list"
></child-components>
<!-- 父组件代码 -->
<div class="child-wrap input-group">
<input
v-model="value"
type="text"
placeholder="请输入"
/>
</div>
<div class="input-group-append">
<button
@click="handleAdd"
type="button"
>添加</button>
</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>
<li
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>
2. emit 方式
emit
方式也是 Vue 中最常见的组件通信方式,该方式用于 子传父
子组件代码如下:
<template>
<div>
<input
v-model="value"
type="text"
placeholder="请输入"
/>
<div>
<button
@click="handleSubmit"
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>
<li
v-for="i in list"
:key="i"
>{{ i }}</li>
</ul>
<!-- 子组件 -->
<child-component
@add="handleAdd"
></child-component>
</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>
3. v-model 方式
v-model
是 vue 中一个比较出色的语法糖,就比如下面这段代码
<ChildComponent v-model:title="pageTitle" />
就是下面这段代码的简写形式
<ChildComponent
:title="pageTitle"
@update:title="pageTitle = $event"
/>
子组件代码如下:
<template>
<div>
<input
v-model="value"
type="text"
placeholder="请输入"
/>
<div>
<button
@click="handleAdd"
type="button"
>添加</button>
</div>
</div>
</template>
<script setup>
import { ref, defineProps, defineEmits } 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>
在子组件中我们首先定义 props
和 emits
,然后添加完成之后 emit
指定事件。
注: update: * 是 vue 中的固定写法.,* 表示 props 中的某个属性名
父组件代码如下:
<template>
<ul>
<li
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>
4. ref 方式
在使用选项式 API 时,我们可以通过 this.$refs.name
的方式获取指定元素或者组件,但是组合式 API 中就无法使用这种方式获取。如果我们想要通过 ref
的方式获取组件或者元素,需要定义一个同名的Ref对象,在组件挂载后就可以访问了。
父组件代码如下:
<template>
<ul>
<li
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>
<input v-model="value" type="text" placeholder="请输入" />
<div>
<button
type="button"
@click="handleAdd"
>添加</button>
</div>
</div>
</template>
<script setup>
// 注意这里的 defineExpose
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 或者 $parent 链获取到的组件的公开实例,不会暴露任何在 中声明的绑定。
为了在<script setup>
组件中明确要暴露出去的属性,使用defineExpose
编译器宏。
具体可查看 vue 文档
5. provide/inject 方式
provide
和inject
是 vue 中提供的一对 API,该 API 可以实现父组件向子组件传递数据,无论层级有多深,都可以通过这对 API 实现。
父组件代码如下:
<template>
<!--子组件-->
<child-components></child-components>
<!--父组件代码-->
<div>
<input v-model="value" type="text" placeholder="请输入" />
<div>
<button
type="button"
@click="handleAdd"
>添加</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 handleAddd = () => {
list.value.push(value.value)
value.value = ''
}
</script>
子组件代码如下:
<template>
<ul>
<li
v-for="i in list"
:key="i"
>{{ i }}</li>
</ul>
</template>
<script setup>
import { inject } from 'vue'
// 接收父组件提供的数据
const list = inject('list')
</script>
值得注意的是使用provide
进行数据传递时,尽量readonly
进行数据的包装,避免子组件修改父级传递过去的数据。
6. 事件总线
vue3 中移除了事件总线,但是可以借助于第三方工具来完成,vue 官方推荐 mitt 或 tiny-emitter
在大多数情况下不推荐使用全局事件总线的方式来实现组件通信,虽然比较简单粗暴,但是长久来说维护事件总线是一个大难题。具体可查看 vue 3.x 事件总线
7. 状态管理器工具
vuex
和 pinia
是 vue3.x 中的状态管理工具,使用这两个工具可以轻松实现组件通信,由于这两个工具功能比较强大,这里就不做展示了,具体可查阅文档
总结
参考文档: vue3.x的七种通信方式