添加链接
link管理
链接快照平台
  • 输入网页链接,自动生成快照
  • 标签化管理网页链接
直接跳到内容

依赖注入

此章节假设你已经看过了 组件基础 。若你还不了解组件是什么,请先阅读该章节。

Prop 逐级透传问题

通常情况下,当我们需要从父组件向子组件传递数据时,会使用 props 。想象一下这样的结构:有一些多层级嵌套的组件,形成了一棵巨大的组件树,而某个深层的子组件需要一个较远的祖先组件中的部分数据。在这种情况下,如果仅使用 props 则必须将其沿着组件链逐级传递下去,这会非常麻烦:

Prop 逐级透传的过程图示

注意,虽然这里的 <Footer> 组件可能根本不关心这些 props,但为了使 <DeepChild> 能访问到它们,仍然需要定义并向下传递。如果组件链路非常长,可能会影响到更多这条路上的组件。这一问题被称为“prop 逐级透传”,显然是我们希望尽量避免的情况。

provide inject 可以帮助我们解决这一问题 [1] 。一个父组件相对于其所有的后代组件,会作为 依赖提供者 。任何后代的组件树,无论层级有多深,都可以 注入 由父组件提供给整条链路的依赖。

Provide/inject 模式

Provide (提供)

要为组件后代提供数据,需要使用到 provide() 函数:

如果不使用 <script setup> ,请确保 provide() 是在 setup() 同步调用的:

provide() 函数接收两个参数。第一个参数被称为 注入名 ,可以是一个字符串或是一个 Symbol 。后代组件会用注入名来查找期望注入的值。一个组件可以多次调用 provide() ,使用不同的注入名,注入不同的依赖值。

第二个参数是提供的值,值可以是任意类型,包括响应式的状态,比如一个 ref:

提供的响应式状态使后代组件可以由此和提供者建立响应式的联系。

要为组件后代提供数据,需要使用到 provide 选项:

对于 provide 对象上的每一个属性,后代组件会用其 key 为注入名查找期望注入的值,属性的值就是要提供的数据。

如果我们需要提供依赖当前组件实例的状态 (比如那些由 data() 定义的数据属性),那么可以以函数形式使用 provide

然而,请注意这 不会 使注入保持响应性。我们会在后续小节中讨论如何 让注入转变为响应式

应用层 Provide

除了在一个组件中提供依赖,我们还可以在整个应用层面提供依赖:

在应用级别提供的数据在该应用内的所有组件中都可以注入。这在你编写 插件 时会特别有用,因为插件一般都不会使用组件形式来提供值。

Inject (注入)

要注入上层组件提供的数据,需使用 inject() 函数:

如果提供的值是一个 ref,注入进来的会是该 ref 对象,而 不会 自动解包为其内部的值。这使得注入方组件能够通过 ref 对象保持了和供给方的响应性链接。

带有响应性的 provide + inject 完整示例

同样的,如果没有使用 <script setup> inject() 需要在 setup() 内同步调用:

要注入上层组件提供的数据,需使用 inject 选项来声明:

注入会在组件自身的状态 之前 被解析,因此你可以在 data() 中访问到注入的属性:

完整的 provide + inject 示例

注入别名

当以数组形式使用 inject ,注入的属性会以同名的 key 暴露到组件实例上。在上面的例子中,提供的属性名为 "message" ,注入后以 this.message 的形式暴露。访问的本地属性名和注入名是相同的。

如果我们想要用一个不同的本地属性名注入该属性,我们需要在 inject 选项的属性上使用对象的形式:

这里,组件本地化了原注入名 "message" 所提供的属性,并将其暴露为 this.localMessage

注入默认值

默认情况下, inject 假设传入的注入名会被某个祖先链上的组件提供。如果该注入名的确没有任何组件提供,则会抛出一个运行时警告。

如果在注入一个值时不要求必须有提供者,那么我们应该声明一个默认值,和 props 类似:

在一些场景中,默认值可能需要通过调用一个函数或初始化一个类来取得。为了避免在用不到默认值的情况下进行不必要的计算或产生副作用,我们可以使用工厂函数来创建默认值:

第三个参数表示默认值应该被当作一个工厂函数。

和响应式数据配合使用

当提供 / 注入响应式的数据时, 建议尽可能将任何对响应式状态的变更都保持在供给方组件中 。这样可以确保所提供状态的声明和变更操作都内聚在同一个组件内,使其更容易维护。

有的时候,我们可能需要在注入方组件中更改数据。在这种情况下,我们推荐在供给方组件内声明并提供一个更改数据的方法函数:

最后,如果你想确保提供的数据不能被注入方的组件更改,你可以使用 readonly() 来包装提供的值。

为保证注入方和供给方之间的响应性链接,我们需要使用 computed() 函数提供一个计算属性:

带有响应性的 provide + inject 完整示例

computed() 函数常用于组合式 API 风格的组件中,但它同样还可以用于补充选项式 API 风格的某些用例。你可以通过阅读 响应式系统基础 计算属性 两个章节了解更多组合式的 API 风格。

使用 Symbol 作注入名

至此,我们已经了解了如何使用字符串作为注入名。但如果你正在构建大型的应用,包含非常多的依赖提供,或者你正在编写提供给其他开发者使用的组件库,建议最好使用 Symbol 来作为注入名以避免潜在的冲突。

我们通常推荐在一个单独的文件中导出这些注入名 Symbol:

TypeScript 用户请参考: 为 Provide / Inject 标注类型