Vue.js 源碼學習五 —— provide 和 inject 學習

早上好！繼續(xù)開始學習Vue源碼吧~

在 Vue.js 的 2.2.0+ 版本中添加加了 provide 和 inject 選項。他們成對出現(xiàn)，用于父級組件向下傳遞數(shù)據(jù)。
下面我們來看看源碼~

源碼位置

和之前一樣，初始化的方法都是在 Vue 的 _init 方法中的。

  // src/core/instance/init.js
  Vue.prototype._init = function (options?: Object) {
    ……
    vm._self = vm
    initLifecycle(vm)
    initEvents(vm)
    initRender(vm)
    callHook(vm, 'beforeCreate')
    initInjections(vm) // resolve injections before data/props
    initState(vm)
    initProvide(vm) // resolve provide after data/props
    callHook(vm, 'created')
  }

這里找到 initInjections 和 initProvide 方法，這就是 provide 和 inject 的初始化方法了。這兩個方法都是在 src/core/instance/inject.js 中。

provide

provide 選項應該是一個對象或返回一個對象的函數(shù)。該對象包含可注入其子孫的屬性。在該對象中你可以使用 ES2015 Symbols 作為 key，但是只在原生支持 Symbol 和 Reflect.ownKeys 的環(huán)境下可工作。

先看源碼：

// src/core/instance/inject.js
export function initProvide (vm: Component) {
  const provide = vm.$options.provide
  if (provide) {
    vm._provided = typeof provide === 'function'
      ? provide.call(vm)
      : provide
  }
}

provide 是向下傳遞數(shù)據(jù)的選項。這里先拿到 provide 選項中的內(nèi)容，如果有 provide 選項，將 provide 選項傳遞給 vm._provided 變?yōu)?Vue 實例全局數(shù)據(jù)。
這里看一下例子更清楚，下例中傳入數(shù)據(jù) foo，數(shù)據(jù)內(nèi)容為 bar。

var Provider = {
  provide: {
    foo: 'bar'
  },
  // ...
}

inject

inject 選項應該是一個字符串數(shù)組或一個對象，該對象的 key 代表了本地綁定的名稱，value 為其 key (字符串或 Symbol) 以在可用的注入中搜索。

源碼

// src/core/instance/inject.js
export function initInjections (vm: Component) {
  const result = resolveInject(vm.$options.inject, vm)
  if (result) {
    observerState.shouldConvert = false
    Object.keys(result).forEach(key => {
      defineReactive(vm, key, result[key])
    })
    observerState.shouldConvert = true
  }
}

簡化后的源碼可以看到，首先通過 resolveInject 方法獲取 inject 選項搜索結(jié)果，如果有搜索結(jié)果，遍歷搜索結(jié)果并為其中的數(shù)據(jù)添加 setter 和 getter。
接著來看下 resolveInject 方法：

export function resolveInject (inject: any, vm: Component): ?Object {
  if (inject) {
    // inject 是 :any 類型因為流沒有智能到能夠指出緩存
    const result = Object.create(null)
    // 獲取 inject 選項的 key 數(shù)組
    const keys = hasSymbol
      ? Reflect.ownKeys(inject).filter(key => {
        /* istanbul ignore next */
        return Object.getOwnPropertyDescriptor(inject, key).enumerable
      })
      : Object.keys(inject)

    for (let i = 0; i < keys.length; i++) {
      const key = keys[i]
      const provideKey = inject[key].from
      let source = vm
      while (source) {
        if (source._provided && provideKey in source._provided) {
          result[key] = source._provided[provideKey]
          break
        }
        source = source.$parent
      }
      if (!source) {
        if ('default' in inject[key]) {
          const provideDefault = inject[key].default
          result[key] = typeof provideDefault === 'function'
            ? provideDefault.call(vm)
            : provideDefault
        } else if (process.env.NODE_ENV !== 'production') {
          warn(`Injection "${key}" not found`, vm)
        }
      }
    }
    return result
  }
}

獲取 inject 選項的 key 數(shù)組，遍歷 key 數(shù)組，通過向上冒泡來查找 provide 中是否有 key 與 inject 選項中 from 屬性同名的，如果有，則將這個數(shù)據(jù)傳遞給 result；如果沒有，檢查 inject 是否有 default 選項設定默認值或者默認方法，如果有則將默認值返傳給 result，最終返回 result 對象。
所以，inject 的寫法應該是有 default 默認值的：

const Child = {
  inject: {
    foo: { default: 'foo' }
  }
}

或者是有 from 查找鍵和 default 默認值的：

const Child = {
  inject: {
    foo: {
      from: 'bar',
      default: 'foo'
    }
  }
}

或者為 default 默認值設定一個工廠方法：

const Child = {
  inject: {
    foo: {
      from: 'bar',
      default: () => [1, 2, 3]
    }
  }
}

好吧，我承認這就是引用的官網(wǎng)的三個例子~ 不過意思到就好啦。
這里我有個疑問，既然在源碼中主動去識別了 from 和 default，官網(wǎng)上說是

在 2.5.0+ 的注入可以通過設置默認值使其變成可選項：

那么如下寫法還可用嗎？

var Child = {
  inject: ['foo'],
  created () {
    console.log(this.foo) // => "bar"
  }
  // ...
}

為此，我們?nèi)ゲ椴?2.2.0 版本的Vue是怎么寫的？

export function initInjections (vm: Component) {
  const provide = vm.$options.provide
  const inject: any = vm.$options.inject
  if (provide) {
    vm._provided = typeof provide === 'function'
      ? provide.call(vm)
      : provide
  }
  if (inject) {
    // inject is :any because flow is not smart enough to figure out cached
    // isArray here
    const isArray = Array.isArray(inject)
    const keys = isArray
      ? inject
      : hasSymbol
        ? Reflect.ownKeys(inject)
        : Object.keys(inject)

    for (let i = 0; i < keys.length; i++) {
      const key = keys[i]
      const provideKey = isArray ? key : inject[key]
      let source = vm
      while (source) {
        if (source._provided && source._provided[provideKey]) {
          vm[key] = source._provided[provideKey]
          break
        }
        source = source.$parent
      }
    }
  }
}

從中可以看到，在這個版本 provide 和 inject 是一起初始化的。之后，將 provide 傳給 vm._provide ，在獲取 inject 選項的時候代碼判斷了 inject 是否為數(shù)組，如果是數(shù)組直接遍歷數(shù)組，之后查找 provide 的代碼差不多。
所以我推測： 在 2.5.0+ 之后不能再使用數(shù)組形式的 inject 來搜索 provide 了。
PS：這里沒有去代碼驗證，如有問題，歡迎指出，謝謝！

最后

至此，provide 和 inject 的源碼學習完畢啦~ 如果有任何問題和建議，歡迎聯(lián)系我！謝謝！
預告：明天學習 Vue 的 VDOM、VNode 相關知識。歡迎繼續(xù)關注~

Vue.js學習系列

鑒于前端知識碎片化嚴重，我希望能夠系統(tǒng)化的整理出一套關于Vue的學習系列博客。

Vue.js學習系列項目地址

本文源碼已收入到GitHub中，以供參考，當然能留下一個star更好啦-。
https://github.com/violetjack/VueStudyDemos

關于作者

VioletJack，高效學習前端工程師，喜歡研究提高效率的方法，也專注于Vue前端相關知識的學習、整理。
歡迎關注、點贊、評論留言~我將持續(xù)產(chǎn)出Vue相關優(yōu)質(zhì)內(nèi)容。

新浪微博： http://weibo.com/u/2640909603
掘金：https://gold.xitu.io/user/571d953d39b0570068145cd1
CSDN: http://blog.csdn.net/violetjack0808
簡書： http://www.itdecent.cn/users/54ae4af3a98d/latest_articles
Github： https://github.com/violetjack

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點，簡書系信息發(fā)布平臺，僅提供信息存儲服務。

相關閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容