provide 和 inject 通常成对一起使用,用于顶层组件向任意的底层组件传递数据和方法,实现跨层组件通信。
可以传递普通数据,也可以传递响应式数据。
provide() :接受两个参数:第一个参数是要注入的 key,可以是一个字符串或者一个 symbol,第二个参数是要注入的值。
inject():注入一个由祖先组件或整个应用 (通过 app.provide()) 提供的值。第一个参数是注入的 key。Vue 会遍历父组件链,通过匹配 key 来确定所提供的值。如果父组件链上多个组件对同一个 key 提供了值,那么离得更近的组件将会“覆盖”链上更远的组件所提供的值。如果没有能通过 key 匹配到值,inject() 将返回 undefined,除非提供了一个默认值。第二个参数是可选的,即在没有匹配到 key 时使用的默认值。
跨层传递数据的基本步骤:
- 顶层组件通过provide函数提供数据
- 底层组件通过inject函数获取数据
示例:
App.vue文件:
<script setup>
import RoomPage from './components/provide/room-page.vue'
</script>
<template>
<div>
<RoomPage></RoomPage>
</div>
</template>
<style scoped></style>
顶层组件room-page.vue:
<script setup>
import RoomMsgItem from './room-msg-item.vue'
import { provide, ref } from 'vue'
// 组件嵌套关系:
// RoomPage -> RommMsgItem -> RoomMsgComment
// 顶层组件提供数据
// 传递静态数据
provide('data-key', '这是room data')
// 传递响应式数据
const count = ref(100)
provide('count-key', count)
// 启动定时器,5秒钟以后修改响应数据
setTimeout(() => {
count.value = 500
}, 5000)
</script>
<template>
<div class="page">
顶层组件
<RoomMsgItem></RoomMsgItem>
</div>
</template>
<style scoped></style>
中间层组件room-msg-item.vue:
<script setup>
import RoomMsgComment from './room-msg-comment.vue'
</script>
<template>
<div>
中间组件
<RoomMsgComment></RoomMsgComment>
</div>
</template>
<style scoped></style>
底层组件room-msg-comment.vue:
<script setup>
import { inject } from 'vue'
// 接收静态数据
const roomData = inject('data-key')
// 接收响应式数据
const countData = inject('count-key')
</script>
<template>
<div class="comment">
底层组件
<div>
来自顶层组件的数据为---{{ roomData }}
</div>
<div>
来自顶层组件的响应式数据---{{ countData }}
</div>
</div>
</template>
<style scoped></style>
到浏览器中查看效果:
5秒钟以后响应式数据变化: