组合式 API:依赖注入 {#composition-api-dependency-injection}
provide() {#provide}
提供一个值,可以被后代组件注入。
- 类型
ts
function provide<T>(key: InjectionKey<T> | string, value: T): void
- 详细信息
provide() 接受两个参数:第一个参数是要注入的 key,可以是一个字符串或者一个 symbol,第二个参数是要注入的值。
当使用 TypeScript 时,key 可以是一个被类型断言为 InjectionKey 的 symbol。InjectionKey 是一个 Vue 提供的工具类型,继承自 Symbol,可以用来同步 provide() 和 inject() 之间值的类型。
与注册生命周期钩子的 API 类似,provide() 必须在组件的 setup() 阶段同步调用。
- 示例
```vue
```
inject() {#inject}
注入一个由祖先组件或整个应用 (通过 app.provide()) 提供的值。
- 类型
```ts
// 没有默认值
function inject
// 带有默认值
function inject
// 使用工厂函数
function inject
- 详细信息
第一个参数是注入的 key。Vue 会遍历父组件链,通过匹配 key 来确定所提供的值。如果父组件链上多个组件对同一个 key 提供了值,则会应用离得更近的组件所提供的值,链上更远的组件所提供的值将会被“覆盖”。如果没有能通过 key 匹配到值,inject() 将返回 undefined,除非提供了一个默认值。
第二个参数是可选的,即在没有匹配到 key 时使用的默认值。
第二个参数也可以是一个工厂函数,用来返回某些创建起来比较复杂的值。在这种情况下,你必须将 true 作为第三个参数传入,表明这个函数将作为工厂函数使用,而非值本身。
与注册生命周期钩子的 API 类似,inject() 必须在组件的 setup() 阶段同步调用。
当使用 TypeScript 时,key 可以是一个类型为 InjectionKey 的 symbol。InjectionKey 是一个 Vue 提供的工具类型,继承自 Symbol,可以用来同步 provide() 和 inject() 之间值的类型。
- 示例
假设有一个父组件已经提供了一些值,如前面 provide() 的例子中所示:
```vue
```
hasInjectionContext() {#has-injection-context}
- 仅在 3.3+ 中支持
如果 inject() 可以在错误的地方 (例如 setup() 之外) 被调用而不触发警告,则返回 true。此方法适用于希望在内部使用 inject() 而不向用户发出警告的库。
- 类型
ts
function hasInjectionContext(): boolean