provide / inject

2.2.0 新增

  • 类型

    • provideObject | () => Object
    • injectArray<string> | { [key: string]: string | Symbol | Object }
  • 详细

provideinject 主要为高阶插件/组件库提供用例。并不推荐直接用于应用程序代码中。

这对选项需要一起使用,以允许一个祖先组件向其所有子孙后代注入一个依赖,不论组件层次有多深,并在起上下游关系成立的时间里始终生效。如果你熟悉 React,这与 React 的上下文特性很相似。

provide 选项应该是一个对象或返回一个对象的函数。该对象包含可注入其子孙的属性。在该对象中你可以使用 ES2015 Symbols 作为 key,但是只在原生支持 SymbolReflect.ownKeys 的环境下可工作。

inject 选项应该是:

  • 一个字符串数组,或
  • 一个对象,对象的 key 是本地的绑定名,value 是:
    • 在可用的注入内容中搜索用的 key (字符串或 Symbol),或
    • 一个对象,该对象的:
      • from 属性是在可用的注入内容中搜索用的 key (字符串或 Symbol)
      • default 属性是降级情况下使用的 value

提示:provideinject 绑定并不是可响应的。这是刻意为之的。然而,如果你传入了一个可监听的对象,那么其对象的属性还是可响应的。

  • 示例
  1. // 父级组件提供 'foo'
  2. var Provider = {
  3. provide: {
  4. foo: 'bar'
  5. },
  6. // ...
  7. }
  8. // 子组件注入 'foo'
  9. var Child = {
  10. inject: ['foo'],
  11. created () {
  12. console.log(this.foo) // => "bar"
  13. }
  14. // ...
  15. }

利用 ES2015 Symbols、函数 provide 和对象 inject

  1. const s = Symbol()
  2. const Provider = {
  3. provide () {
  4. return {
  5. [s]: 'foo'
  6. }
  7. }
  8. }
  9. const Child = {
  10. inject: { s },
  11. // ...
  12. }

接下来 2 个例子只工作在 Vue 2.2.1 或更高版本。低于这个版本时,注入的值会在 propsdata 初始化之后得到。

使用一个注入的值作为一个属性的默认值:

  1. const Child = {
  2. inject: ['foo'],
  3. props: {
  4. bar: {
  5. default () {
  6. return this.foo
  7. }
  8. }
  9. }
  10. }

使用一个注入的值作为数据入口:

  1. const Child = {
  2. inject: ['foo'],
  3. data () {
  4. return {
  5. bar: this.foo
  6. }
  7. }
  8. }

在 2.5.0+ 的注入可以通过设置默认值使其变成可选项:

  1. const Child = {
  2. inject: {
  3. foo: { default: 'foo' }
  4. }
  5. }

如果它需要从一个不同名字的属性注入,则使用 from 来表示其源属性:

  1. const Child = {
  2. inject: {
  3. foo: {
  4. from: 'bar',
  5. default: 'foo'
  6. }
  7. }
  8. }

与 prop 的默认值类似,你需要对非原始值使用一个工厂方法:

  1. const Child = {
  2. inject: {
  3. foo: {
  4. from: 'bar',
  5. default: () => [1, 2, 3]
  6. }
  7. }
  8. }