说说Vue3中provide、inject的源码和使用技巧
ztj100 2024-11-12 14:21 44 浏览 0 评论
使用Vue从父组件传递数据到子组件,一般使用defineProps就能满足大部分场景,但如果要跨多层级组件传递数据,则可使用provide和inject。从provide和inject组合字面理解,类似于依赖注入模式,本篇内容将从provide、inject的实现原理来分析使用中的一些技巧。
provide、inject简介
来自官网的介绍:一个父组件相对于其所有的后代组件,会作为依赖提供者。任何后代的组件树,无论层级有多深,都可以注入由父组件提供给整条链路的依赖。
provide组件内提供方式:
仅需调用provide提供key、value即可,需要注意的是:key建议使用Symbol形式提供,避免冲突;value可为任意类型,也可提供Ref类型,并且子组件使用时不会解构,依然保持响应式。
provide应用层提供方式:
部分全局配置,例如用户信息,希望在应用层级内所有组件都能获取配置,则可使用app.provide方法注入配置信息。
不管provide是组件内提供还是应用层提供,获取方式都是一样:
使用inject获取信息时,建议传递第二个参数作为缺省时默认值。
provide、inject使用技巧: provide提供的value虽然可以为响应式类型,但如果需要更新value值,则强烈建议把修改权交给父组件,父组件可在value中提供update方法给子组件,如下demo所示:
provide、inject源码本身不复杂,再加上上述demo的说明,接下来的源码理解起来就更加轻车熟路。
知因知果
provide源码
provide函数签名:
不要被这一串TypeScript类型给唬住了,反正提供key、value就行,key可以为Symbol类型,value没限制。其实这个签名存在bug: K可以为一个对象,例如provide({}, { a: 10}),也不会报TypeScript错误,但实际使用时却会有警告:
provide函数体被if、else包裹,先判断currentInstance是否为空,currentInstance为组件实体,provide只有包含在setup中才能生效,否则会给出warn提示。
正常使用的逻辑包含在else中,先从currentInstance.provides获取provides对象,如果组件注入任何数据,则currentInstance上的provides缺省为父组件的provides。
parentProvides为父组件provides,判断当前组件的provides是否等于父组件的provides,如果相等,则当前组件就得创建自己的provides了,Object.create方法为何意?以parentProvides作为原型(prototype)创建一个新对象,这样不管组件嵌套多少层,通过原型链方式可访问到链路上注入的所有数据。
问题:上文中currentInstance从何而来?这个话题得从东土大唐说到西天取经,这里就咱不介绍,但在外部也可以通过getCurrentInstance()方法一探当前组件的所有上下文。
inject源码
inject函数签名:
需要强调的是,defaultValue可以为function,例如() => value,此时treeDefaultAsFactory需要设置为true。
inject函数的主体代码如下,同样先获取组件intance,currentRenderingInstance代表SSR渲染的组件实体。
如果instance和currentApp都没有赋值,即表示未在setup下使用inject,此时会提示警告warn信息。currentApp是什么?通过createApp()创建的应用实体,上文有提到可通过app.provide(key, value)形式在应用层级注入配置信息。
接下来看instance或currentApp不为空的情况,这两者同时有且仅有一个不为空。什么情况下currentApp不为空,我们稍后再讨论,假如在组件中使用inject,则instance不为空。
instace.parent == null表示当前为root节点,例如App.vue对应的实体,则此时需要通过路径instance.vnode.appContext.provides(也即是应用层级上的provides)获取注入信息。否则,直接获取parent.provides即可。
什么情况下currentApp不为空?需要在非setup场景下获取应用的provides信息时,则需要通过以下方式使用inject:
在调用runWithContext时,其内部会将currentApp设置为app实体,以便在回调中使用inject能拿到应用层依赖注入信息。当在setup上下文时,直接调用inject函数就行。
最后一步,根据key从provides获取值, 但如果key不存在怎么办?根据第二个参数获取缺省值, 需要注意的是:如果缺省值为function,则需要执行defaultValue.call(instance.proxy)动态获取值。
使用中的问题和技巧
provide key使用硬编码,导致冲突
例如有这样的组件关系child.vue -> parent.vue->root.vue,如下所示,root和parent组件都定义有key为name的注入,child组件内只能获取到parent中provide,原因是root.vue的相同key被parent.vue覆盖掉。
为了避免key冲突,使用Symbol保证全局唯一性,为每一个key单独定义Smybol,改造如下:
inject使用时无TypeScript提示, 使用InjectionKey限制类型
如上文demo中所示,child.vue组件内感知不到parent或root组件具体提供了哪些provide,因此只能通过查阅父组件代码知晓。但在TypeScript代码中,开发者期望在使用inject时能够感知到提供的注入信息。
Vue为我们提供了范型Injection<T>来定义key的类型,例如为应用层级定义类型:
在App.vue中注入时,如果提供的value和AppConfigContext不匹配,则会报ts错误:
组件中使用时,也能感知到具体类型:
总结
通过provide、inject源码分析,了解到可通过getCurrentInstance函数获取当前组件的上下文,其中包含了组件的attrs、data等信息,这为我们在使用Vue过程中提供了更灵活的信息获取方式。
使用中,避免遍地开花式地滥用provide,到后期更本就没人知道到底提供了哪些依赖注入。好的使用方式: 注入时尽量通过Smybol方式定义key,避免冲突。更好的使用方式:通过Vue提供的InjectionKey范型提前定义好需要使用的属性,在child中使用时能感知到提供的具体属性。
原文链接:https://juejin.cn/post/7412672643633561663
相关推荐
- sharding-jdbc实现`分库分表`与`读写分离`
-
一、前言本文将基于以下环境整合...
- 三分钟了解mysql中主键、外键、非空、唯一、默认约束是什么
-
在数据库中,数据表是数据库中最重要、最基本的操作对象,是数据存储的基本单位。数据表被定义为列的集合,数据在表中是按照行和列的格式来存储的。每一行代表一条唯一的记录,每一列代表记录中的一个域。...
- MySQL8行级锁_mysql如何加行级锁
-
MySQL8行级锁版本:8.0.34基本概念...
- mysql使用小技巧_mysql使用入门
-
1、MySQL中有许多很实用的函数,好好利用它们可以省去很多时间:group_concat()将取到的值用逗号连接,可以这么用:selectgroup_concat(distinctid)fr...
- MySQL/MariaDB中如何支持全部的Unicode?
-
永远不要在MySQL中使用utf8,并且始终使用utf8mb4。utf8mb4介绍MySQL/MariaDB中,utf8字符集并不是对Unicode的真正实现,即不是真正的UTF-8编码,因...
- 聊聊 MySQL Server 可执行注释,你懂了吗?
-
前言MySQLServer当前支持如下3种注释风格:...
- MySQL系列-源码编译安装(v5.7.34)
-
一、系统环境要求...
- MySQL的锁就锁住我啦!与腾讯大佬的技术交谈,是我小看它了
-
对酒当歌,人生几何!朝朝暮暮,唯有己脱。苦苦寻觅找工作之间,殊不知今日之事乃我心之痛,难道是我不配拥有工作嘛。自面试后他所谓的等待都过去一段时日,可惜在下京东上的小金库都要见低啦。每每想到不由心中一...
- MySQL字符问题_mysql中字符串的位置
-
中文写入乱码问题:我输入的中文编码是urf8的,建的库是urf8的,但是插入mysql总是乱码,一堆"???????????????????????"我用的是ibatis,终于找到原因了,我是这么解决...
- 深圳尚学堂:mysql基本sql语句大全(三)
-
数据开发-经典1.按姓氏笔画排序:Select*FromTableNameOrderByCustomerNameCollateChinese_PRC_Stroke_ci_as//从少...
- MySQL进行行级锁的?一会next-key锁,一会间隙锁,一会记录锁?
-
大家好,是不是很多人都对MySQL加行级锁的规则搞的迷迷糊糊,一会是next-key锁,一会是间隙锁,一会又是记录锁。坦白说,确实还挺复杂的,但是好在我找点了点规律,也知道如何如何用命令分析加...
- 一文讲清怎么利用Python Django实现Excel数据表的导入导出功能
-
摘要:Python作为一门简单易学且功能强大的编程语言,广受程序员、数据分析师和AI工程师的青睐。本文系统讲解了如何使用Python的Django框架结合openpyxl库实现Excel...
- 用DataX实现两个MySQL实例间的数据同步
-
DataXDataX使用Java实现。如果可以实现数据库实例之间准实时的...
- MySQL数据库知识_mysql数据库基础知识
-
MySQL是一种关系型数据库管理系统;那废话不多说,直接上自己以前学习整理文档:查看数据库命令:(1).查看存储过程状态:showprocedurestatus;(2).显示系统变量:show...
- 如何为MySQL中的JSON字段设置索引
-
背景MySQL在2015年中发布的5.7.8版本中首次引入了JSON数据类型。自此,它成了一种逃离严格列定义的方式,可以存储各种形状和大小的JSON文档,例如审计日志、配置信息、第三方数据包、用户自定...
欢迎 你 发表评论:
- 一周热门
-
-
MySQL中这14个小玩意,让人眼前一亮!
-
旗舰机新标杆 OPPO Find X2系列正式发布 售价5499元起
-
【VueTorrent】一款吊炸天的qBittorrent主题,人人都可用
-
面试官:使用int类型做加减操作,是线程安全吗
-
C++编程知识:ToString()字符串转换你用正确了吗?
-
【Spring Boot】WebSocket 的 6 种集成方式
-
PyTorch 深度学习实战(26):多目标强化学习Multi-Objective RL
-
pytorch中的 scatter_()函数使用和详解
-
与 Java 17 相比,Java 21 究竟有多快?
-
基于TensorRT_LLM的大模型推理加速与OpenAI兼容服务优化
-
- 最近发表
- 标签列表
-
- idea eval reset (50)
- vue dispatch (70)
- update canceled (42)
- order by asc (53)
- spring gateway (67)
- 简单代码编程 贪吃蛇 (40)
- transforms.resize (33)
- redisson trylock (35)
- 卸载node (35)
- np.reshape (33)
- torch.arange (34)
- npm 源 (35)
- vue3 deep (35)
- win10 ssh (35)
- vue foreach (34)
- idea设置编码为utf8 (35)
- vue 数组添加元素 (34)
- std find (34)
- tablefield注解用途 (35)
- python str转json (34)
- java websocket客户端 (34)
- tensor.view (34)
- java jackson (34)
- vmware17pro最新密钥 (34)
- mysql单表最大数据量 (35)
