当前位置:   article > 正文

Vue依赖注入,详细解析

Vue依赖注入,详细解析

Prop 逐级透传问题

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

Prop 逐级透传的过程图示

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

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

Provide/inject 模式

Provide (提供)

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

  1. export default {
  2. provide: {
  3. message: 'hello!'
  4. }
  5. }

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

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

  1. export default {
  2. data() {
  3. return {
  4. message: 'hello!'
  5. }
  6. },
  7. provide() {
  8. // 使用函数的形式,可以访问到 `this`
  9. return {
  10. message: this.message
  11. }
  12. }
  13. }

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

应用层 Provide

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

  1. import { createApp } from 'vue'
  2. const app = createApp({})
  3. app.provide(/* 注入名 */ 'message', /**/ 'hello!')

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

Inject (注入)

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

  1. export default {
  2. inject: ['message'],
  3. created() {
  4. console.log(this.message) // injected value
  5. }
  6. }

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

  1. export default {
  2. inject: ['message'],
  3. data() {
  4. return {
  5. // 基于注入值的初始数据
  6. fullMessage: this.message
  7. }
  8. }
  9. }

注入别名

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

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

  1. export default {
  2. inject: {
  3. /* 本地属性名 */ localMessage: {
  4. from: /* 注入来源名 */ 'message'
  5. }
  6. }
  7. }

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

注入默认值

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

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

  1. export default {
  2. // 当声明注入的默认值时
  3. // 必须使用对象形式
  4. inject: {
  5. message: {
  6. from: 'message', // 当与原注入名同名时,这个属性是可选的
  7. default: 'default value'
  8. },
  9. user: {
  10. // 对于非基础类型数据,如果创建开销比较大,或是需要确保每个组件实例
  11. // 需要独立数据的,请使用工厂函数
  12. default: () => ({ name: 'John' })
  13. }
  14. }
  15. }

和响应式数据配合使用

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

  1. import { computed } from 'vue'
  2. export default {
  3. data() {
  4. return {
  5. message: 'hello!'
  6. }
  7. },
  8. provide() {
  9. return {
  10. // 显式提供一个计算属性
  11. message: computed(() => this.message)
  12. }
  13. }
  14. }

computed() 函数常用于组合式 API 风格的组件中,但它同样还可以用于补充选项式 API 风格的某些用例

使用 Symbol 作注入名

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

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

  1. // keys.js
  2. export const myInjectionKey = Symbol()
  1. // 在供给方组件中
  2. import { myInjectionKey } from './keys.js'
  3. export default {
  4. provide() {
  5. return {
  6. [myInjectionKey]: {
  7. /* 要提供的数据 */
  8. }
  9. }
  10. }
  11. }
  1. // 注入方组件
  2. import { myInjectionKey } from './keys.js'
  3. export default {
  4. inject: {
  5. injected: { from: myInjectionKey }
  6. }
  7. }
声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/我家小花儿/article/detail/377623?site
推荐阅读
相关标签
  

闽ICP备14008679号