百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术分类 > 正文

说说Vue3中provide、inject的源码和使用技巧

ztj100 2024-11-12 14:21 12 浏览 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

相关推荐

告别手动操作:一键多工作表合并的实用方法

通常情况下,我们需要将同一工作簿内不同工作表中的数据进行合并处理。如何快速有效地完成这些数据的整合呢?这主要取决于需要合并的源数据的结构。...

【MySQL技术专题】「优化技术系列」常用SQL的优化方案和技术思路

概述前面我们介绍了MySQL中怎么样通过索引来优化查询。日常开发中,除了使用查询外,我们还会使用一些其他的常用SQL,比如INSERT、GROUPBY等。对于这些SQL语句,我们该怎么样进行优化呢...

9.7寸视网膜屏原道M9i双系统安装教程

泡泡网平板电脑频道4月17日原道M9i采用Win8安卓双系统,对于喜欢折腾的朋友来说,刷机成了一件难事,那么原道M9i如何刷机呢?下面通过详细地图文,介绍原道M9i的刷机操作过程,在刷机的过程中,要...

如何做好分布式任务调度——Scheduler 的一些探索

作者:张宇轩,章逸,曾丹初识Scheduler找准定位:分布式任务调度平台...

mysqldump备份操作大全及相关参数详解

mysqldump简介mysqldump是用于转储MySQL数据库的实用程序,通常我们用来迁移和备份数据库;它自带的功能参数非常多,文中列举出几乎所有常用的导出操作方法,在文章末尾将所有的参数详细说明...

大厂面试冲刺,Java“实战”问题三连,你碰到了哪个?

推荐学习...

亿级分库分表,如何丝滑扩容、如何双写灰度

以下是基于亿级分库分表丝滑扩容与双写灰度设计方案,结合架构图与核心流程说明:一、总体设计目标...

MYSQL表设计规范(mysql表设计原则)

日常工作总结,不是通用规范一、表设计库名、表名、字段名必须使用小写字母,“_”分割。...

怎么解决MySQL中的Duplicate entry错误?

在使用MySQL数据库时,我们经常会遇到Duplicateentry错误,这是由于插入或更新数据时出现了重复的唯一键值。这种错误可能会导致数据的不一致性和完整性问题。为了解决这个问题,我们可以采取以...

高并发下如何防重?(高并发如何防止重复)

前言最近测试给我提了一个bug,说我之前提供的一个批量复制商品的接口,产生了重复的商品数据。...

性能压测数据告诉你MySQL和MariaDB该怎么选

1.压测环境为了尽可能的客观公正,本次选择同一物理机上的两台虚拟机,一台用作数据库服务器,一台用作运行压测工具mysqlslap,操作系统均为UbuntuServer22.04LTS。...

屠龙之技 --sql注入 不值得浪费超过十天 实战中sqlmap--lv 3通杀全国

MySQL小结发表于2020-09-21分类于知识整理阅读次数:本文字数:67k阅读时长≈1:01...

破防了,谁懂啊家人们:记一次 mysql 问题排查

作者:温粥一、前言谁懂啊家人们,作为一名java开发,原来以为mysql这东西,写写CRUD,不是有手就行吗;你说DDL啊,不就是设计个表结构,搞几个索引吗。...

SpringBoot系列Mybatis之批量插入的几种姿势

...

MySQL 之 Performance Schema(mysql安装及配置超详细教程)

MySQL之PerformanceSchema介绍PerformanceSchema提供了在数据库运行时实时检查MySQL服务器的内部执行情况的方法,通过监视MySQL服务器的事件来实现监视内...

取消回复欢迎 发表评论: