组合式 API：依赖注入 {#composition-api-brdependency-injection}

provide() {#provide}

供给一个值，可以被后代组件注入。

  • 类型

    1. function provide<T>(key: InjectionKey<T> | string, value: T): void

  • 详细信息

    provide() 接受两个参数：注入的 key 名称，可以是一个字符串或是一个 symbol，然后是要注入的值。

    当使用 TypeScript 时，key 可以是一个 symbol，类型可以转换为 InjectionKey，这是一个 Vue 提供的工具类型，继承自 Symbol，可以用来同步 provide() 和 inject() 之间值的类型。

    同生命周期钩子 API 一样，provide() 必须在组件的 setup() 阶段中同步调用。

  • 示例

    1. <script setup>
    2. import { ref, provide } from 'vue'
    3. import { fooSymbol } from './injectionSymbols'
    5. // 供给静态值
    6. provide('foo', 'bar')
    8. // 供给响应式的值
    9. const count = ref(0)
    10. provide('count', count)
    12. // 通过 Symbol 作为 key 作供给
    13. provide(fooSymbol, count)
    14. </script>

  • 相关内容:

inject() {#inject}

注入一个由祖先组件或整个应用（通过 app.provide()）供给的值。

  • 类型

    1. // 不带默认值
    2. function inject<T>(key: InjectionKey<T> | string): T | undefined
    4. // 带有默认值
    5. function inject<T>(key: InjectionKey<T> | string, defaultValue: T): T
    7. // 通过工厂函数
    8. function inject<T>(
    9.   key: InjectionKey<T> | string,
    10.   defaultValue: () => T,
    11.   treatDefaultAsFactory: true
    12. ): T

  • 详细信息

    第一个参数是注入目标的 key。Vue 会遍历父组件链，通过匹配 key 来确定所供给的值。如果父组件链上多个组件对同一个 key 供给了值，那么离得更近的组件将会“覆盖”住链上更远的组件所供给的值。如果没有能通过 key 匹配到值，inject() 会返回 undefined 除非提供了一个默认值。

    第二个参数是可选的，即在没匹配到时使用的默认值。它也可以是一个工厂函数，用来返回某些创建起来比较复杂的值。如果默认值本身就是一个函数，那么你必须传入第三个参数 false 以表明这个函数就是默认值，而不是将其视为一个工厂函数。

    与生命周期钩子注册函数类似，inject() 必须在组件的 setup() 阶段同步调用。

    当使用 TypeScript 时，key 可以是一个 symbol，类型可以转换为 InjectionKey，这是一个 Vue 提供的工具类型，继承自 Symbol，可以用来同步 provide() 和 inject() 之间值的类型。

  • 示例

    假设有一个父组件已经供给了一些值，如前面 provide() 的例子中所示：

    1. <script setup>
    2. import { inject } from 'vue'
    3. import { fooSymbol } from './injectionSymbols'
    5. // 注入值的默认方式
    6. const foo = inject('foo')
    8. // 注入响应式的值
    9. const count = inject('count')
    11. // 通过 Symbol 类型的 key 注入
    12. const foo2 = inject(fooSymbol)
    14. // 注入一个值，若为空则使用提供的默认值
    15. const bar = inject('foo', 'default value')
    17. // 注入一个值，若为空则使用提供的工厂函数
    18. const baz = inject('foo', () => new Map())
    20. // 注入时为了表明提供的默认值是个函数，需要传入第三个参数
    21. const fn = inject('function', () => {}, false)
    22. </script>

  • 相关内容: