Vue3全局组件通信之provide / inject
创始人
2024-06-02 16:39:13
0

1、前言

顾名思义,爷孙组件是比 父子组件通信 要更深层次的引用关系(也有称之为 “隔代组件”):

C组件引入到B组件里,B组件引入到A组件里渲染,此时A是C的爷爷级别(可能还有更多层级关系),如果你用 props ,只能一级一级传递下去,那就太繁琐了,因此我们需要更直接的通信方式。

他们之间的关系如下,Grandson.vue 并非直接挂载在 Grandfather.vue 下面,他们之间还隔着至少一个 Son.vue (可能有多个):

Grandfather.vue
└─Son.vue└─Grandson.vue

😜😜😜
因为上下级的关系的一致性,爷孙组件通信的方案也适用于 父子组件通信 ,只需要把爷孙关系换成父子关系即可。

2、provide / inject

这个特性有两个部分:Grandfather.vue 有一个 provide 选项来提供数据,Grandson.vue 有一个 inject 选项来开始使用这些数据。

  • Grandfather.vue 通过 provide 向 Grandson.vue 传值(可包含定义好的函数)
  • Grandson.vue 通过 inject 向 Grandfather.vue 触发爷爷组件的事件执行

😜😜😜
无论组件层次结构有多深,发起 provide 的组件都可以作为其所有下级组件的依赖提供者
这一部分的内容变化都特别大,但使用起来其实也很简单,不用慌,也有相同的地方:

  • 父组件不需要知道哪些子组件使用它 provide 的 property
  • 子组件不需要知道 inject property 来自哪里

另外,要切记一点就是:provide 和 inject 绑定并不是可响应的。这是刻意为之的,但如果传入了一个可监听的对象,那么其对象的 property 还是可响应的。

3、发起 provide

我们先来回顾一下 2.x 的用法:

export default {// 定义好数据data () {return {tags: [ '中餐', '粤菜', '烧腊' ]}},// provide出去provide () {return {tags: this.tags}}
}

旧版的 provide 用法和 data 类似,都是配置为一个返回对象的函数。
3.x 的新版 provide, 和 2.x 的用法区别比较大。

😜😜😜
在 3.x , provide 需要导入并在 setup 里启用,并且现在是一个全新的方法。
每次要 provide 一个数据的时候,就要单独调用一次。
每次调用的时候,都需要传入 2 个参数:

参数类型说明
keystring数据的名称
valueany数据的值

来看一下如何创建一个 provide:

// 记得导入provide
import { defineComponent, provide } from 'vue'export default defineComponent({// ...setup () {// 定义好数据const msg: string = 'Hello World!';// provide出去provide('msg', msg);}
})

操作非常简单对吧,但需要注意的是,provide 不是响应式的,如果你要使其具备响应性,你需要传入响应式数据

4、接收 inject

也是先来回顾一下 2.x 的用法:

export default {inject: ['tags'],mounted () {console.log(this.tags);}
}

旧版的 inject 用法和 props 类似,3.x 的新版 inject, 和 2.x 的用法区别也是比较大。

😜😜😜
在 3.x, inject 和 provide 一样,也是需要先导入然后在 setup 里启用,也是一个全新的方法。
每次要 inject 一个数据的时候,就要单独调用一次。
每次调用的时候,只需要传入 1 个参数:

参数类型说明
keystring与provide对应的数据名称
// 记得导入inject
import { defineComponent, inject } from 'vue'export default defineComponent({// ...setup () {const msg: string = inject('msg') || '';}
})

也是很简单(写 TS 的话,由于 inject 到的值可能是 undefined,所以要么加个 undefined 类型,要么给变量设置一个空的默认值)。

5、响应性数据的传递与接收

之所以要单独拿出来说, 是因为变化真的很大

在前面我们已经知道,provide 和 inject 本身不可响应,但是并非完全不能够拿到响应的结果,只需要我们传入的数据具备响应性,它依然能够提供响应支持。

我们以 ref 和 reactive 为例,来看看应该怎么发起 provide 和接收 inject。

先在 Grandfather.vue 里 provide 数据:

export default defineComponent({// ...setup () {// provide一个refconst msg = ref('Hello World!');provide('msg', msg);// provide一个reactiveconst userInfo: Member = reactive({id: 1,name: 'Petter'});provide('userInfo', userInfo);// 2s 后更新数据setTimeout(() => {// 修改消息内容msg.value = 'Hi World!';// 修改用户名userInfo.name = 'Tom';}, 2000);}
})

在 Grandsun.vue 里 inject 拿到数据:

export default defineComponent({setup () {// 获取数据const msg = inject('msg');const userInfo = inject('userInfo');// 打印刚刚拿到的数据console.log(msg);console.log(userInfo);// 因为 2s 后数据会变,我们 3s 后再看下,可以争取拿到新的数据setTimeout(() => {console.log(msg);console.log(userInfo);}, 3000);// 响应式数据还可以直接给 template 使用,会实时更新return {msg,userInfo}}
})

非常简单,非常方便!!!

😜😜😜
响应式的数据 provide 出去,在子孙组件拿到的也是响应式的,并且可以如同自身定义的响应式变量一样,直接 return 给 template 使用,一旦数据有变化,视图也会立即更新。

但上面这句话有效的前提是,不破坏数据的响应性,比如 ref 变量,你需要完整的传入,而不能只传入它的 value,对于 reactive 也是同理,不能直接解构去破坏原本的响应性

切记!切记!!!

6、引用类型的传递与接收 (针对非响应性数据的处理)

provide 和 inject 并不是可响应的,这是官方的故意设计,但是由于引用类型的特殊性,在子孙组件拿到了数据之后,他们的属性还是可以正常的响应变化。

先在 Grandfather.vue 里 provide 数据:

export default defineComponent({// ...setup () {// provide 一个数组const tags: string[] = [ '中餐', '粤菜', '烧腊' ];provide('tags', tags);// provide 一个对象const userInfo: Member = {id: 1,name: 'Petter'};provide('userInfo', userInfo);// 2s 后更新数据setTimeout(() => {// 增加tags的长度tags.push('叉烧');// 修改userInfo的属性值userInfo.name = 'Tom';}, 2000);}
})

在 Grandsun.vue 里 inject 拿到数据:

export default defineComponent({setup () {// 获取数据const tags: string[] = inject('tags') || [];const userInfo: Member = inject('userInfo') || {id: 0,name: ''};// 打印刚刚拿到的数据console.log(tags);console.log(tags.length);console.log(userInfo);// 因为 2s 后数据会变,我们 3s 后再看下,能够看到已经是更新后的数据了setTimeout(() => {console.log(tags);console.log(tags.length);console.log(userInfo);}, 3000);}
})

😜😜😜
引用类型的数据,拿到后可以直接用,属性的值更新后,子孙组件也会被更新。
但是!!!由于不具备真正的响应性,return 给模板使用依然不会更新视图,如果涉及到视图的数据,请依然使用 响应式 API 。

7、基本类型的传递与接收 (针对非响应性数据的处理)

基本数据类型被直接 provide 出去后,再怎么修改,都无法更新下去,子孙组件拿到的永远是第一次的那个值。

先在 Grandfather.vue 里 provide 数据:

export default defineComponent({// ...setup () {// provide 一个数组的长度const tags: string[] = [ '中餐', '粤菜', '烧腊' ];provide('tagsCount', tags.length);// provide 一个字符串let name: string = 'Petter';provide('name', name);// 2s 后更新数据setTimeout(() => {// tagsCount 在 Grandson 那边依然是 3tags.push('叉烧');// name 在 Grandson 那边依然是 Pettername = 'Tom';}, 2000);}
})

在 Grandsun.vue 里 inject 拿到数据:

export default defineComponent({setup () {// 获取数据const name: string = inject('name') || '';const tagsCount: number = inject('tagsCount') || 0;// 打印刚刚拿到的数据console.log(name);console.log(tagsCount);// 因为 2s 后数据会变,我们 3s 后再看下setTimeout(() => {// 依然是 Petterconsole.log(name);// 依然是 3console.log(tagsCount);}, 3000);}
})

很失望,并没有变化。

😜😜😜
那么是否一定要定义成响应式数据或者引用类型数据呢?

当然不是,我们在 provide 的时候,也可以稍作修改,让它能够同步更新下去。

先在 Grandfather.vue 里 provide 数据:

export default defineComponent({// ...setup () {// provide 一个数组的长度const tags: string[] = [ '中餐', '粤菜', '烧腊' ];provide('tagsCount', (): number => {return tags.length;});// provide 字符串let name: string = 'Petter';provide('name', (): string => {return name;});// 2s 后更新数据setTimeout(() => {// tagsCount 现在可以正常拿到 4 了tags.push('叉烧');// name 现在可以正常拿到 Tom 了name = 'Tom';}, 2000);}
})

再来 Grandsun.vue 里修改一下 inject 的方式,看看这次拿到的数据:

export default defineComponent({setup () {// 获取数据const tagsCount: any = inject('tagsCount');const name: any = inject('name');// 打印刚刚拿到的数据console.log(tagsCount());console.log(name());// 因为 2s 后数据会变,我们 3s 后再看下setTimeout(() => {// 现在可以正确得到 4console.log(tagsCount());// 现在可以正确得到 Tomconsole.log(name());}, 3000);}
})

这次可以正确拿到数据了,看出这2次的写法有什么区别了吗?

😜😜😜
基本数据类型,需要 provide 一个函数,将其 return 出去给子孙组件用,这样子孙组件每次拿到的数据才会是新的。
但由于不具备响应性,所以子孙组件每次都需要重新通过执行 inject 得到的函数才能拿到最新的数据。

按我个人习惯来说,使用起来挺别扭的,能不用就不用……

由于不具备真正的响应性,return 给模板使用依然不会更新视图,如果涉及到视图的数据,请依然使用 响应式 API 。

点赞加关注,永远不迷路

点赞加关注,永远不迷路

点赞加关注,永远不迷路

相关内容

热门资讯

喜欢穿一身黑的男生性格(喜欢穿... 今天百科达人给各位分享喜欢穿一身黑的男生性格的知识,其中也会对喜欢穿一身黑衣服的男人人好相处吗进行解...
发春是什么意思(思春和发春是什... 本篇文章极速百科给大家谈谈发春是什么意思,以及思春和发春是什么意思对应的知识点,希望对各位有所帮助,...
网络用语zl是什么意思(zl是... 今天给各位分享网络用语zl是什么意思的知识,其中也会对zl是啥意思是什么网络用语进行解释,如果能碰巧...
为什么酷狗音乐自己唱的歌不能下... 本篇文章极速百科小编给大家谈谈为什么酷狗音乐自己唱的歌不能下载到本地?,以及为什么酷狗下载的歌曲不是...
华为下载未安装的文件去哪找(华... 今天百科达人给各位分享华为下载未安装的文件去哪找的知识,其中也会对华为下载未安装的文件去哪找到进行解...
怎么往应用助手里添加应用(应用... 今天百科达人给各位分享怎么往应用助手里添加应用的知识,其中也会对应用助手怎么添加微信进行解释,如果能...
家里可以做假山养金鱼吗(假山能... 今天百科达人给各位分享家里可以做假山养金鱼吗的知识,其中也会对假山能放鱼缸里吗进行解释,如果能碰巧解...
一帆风顺二龙腾飞三阳开泰祝福语... 本篇文章极速百科给大家谈谈一帆风顺二龙腾飞三阳开泰祝福语,以及一帆风顺二龙腾飞三阳开泰祝福语结婚对应...
美团联名卡审核成功待激活(美团... 今天百科达人给各位分享美团联名卡审核成功待激活的知识,其中也会对美团联名卡审核未通过进行解释,如果能...
四分五裂是什么生肖什么动物(四... 本篇文章极速百科小编给大家谈谈四分五裂是什么生肖什么动物,以及四分五裂打一生肖是什么对应的知识点,希...