人人都能懂的Vue源碼系列(三)—resolveConstructorOptions函數

時間  2019-11-17
標籤 人人 懂的 vue 源碼 系列 resolveconstructoroptions 函數 简体版
原文   原文鏈接

上篇文章介紹了Vue構造函數的部分實現，若是當前Vue實例不是組件，則執行mergeOptions方法。vue

vm.$options = mergeOptions(
  resolveConstructorOptions(vm.constructor),
    options || {},
    vm
)
複製代碼

關於mergeOptions方法，咱們以後的博文會作詳細介紹。今天主要來研究resolveConstructorOptions,從字面意思來看，它是來解析constructor上options屬性的，具體來看源碼。webpack

export function resolveConstructorOptions (Ctor: Class<Component>) {
  let options = Ctor.options
  // 有super屬性，說明Ctor是Vue.extend構建的子類
  if (Ctor.super) {
    const superOptions = resolveConstructorOptions(Ctor.super)
    const cachedSuperOptions = Ctor.superOptions // Vue構造函數上的options,如directives,filters,....
    if (superOptions !== cachedSuperOptions) {
      // super option changed,
      // need to resolve new options.
      Ctor.superOptions = superOptions
      // check if there are any late-modified/attached options (#4976)
      const modifiedOptions = resolveModifiedOptions(Ctor)
      // update base extend options
      if (modifiedOptions) {
        extend(Ctor.extendOptions, modifiedOptions)
      }
      options = Ctor.options = mergeOptions(superOptions, Ctor.extendOptions)
      if (options.name) {
        options.components[options.name] = Ctor
      }
    }
  }
  return options
}
複製代碼

這個方法要分紅兩種狀況來講明，第一種是Ctor是基礎Vue構造器的狀況，另外一種是Ctor是經過Vue.extend方法擴展的狀況。web

Ctor是基礎Vue構造器

當Ctor(Ctor其實就是構造函數)是基礎Vue構造器時，如經過new關鍵字來新建Vue構造函數的實例npm

const vm = new Vue({
  el: '#app',
    data: {
      message: 'Hello Chris'
    }
})
複製代碼

這個時候options就是Vue構造函數上的options。以下圖 json

global options
那麼這個options是在哪裏定義的呢？在以前的代碼中好像沒有看到options的定義在哪裏？此時咱們應該怎麼去找這個options定義的地方呢？

這裏教你們一個方法，首先找到package.json，在這裏能夠找到咱們平時用到的一些npm腳本。以npm run dev爲例。實際上npm run dev是執行了下列的命令 "dev": "rollup -w -c scripts/config.js --environment TARGET:web-full-dev"api

rollup是相似於webpack的打包工具。咱們能夠看到這條命令指向了一個地址scripts/config，以後還指定了一個Target。找到script/config,發現這個文件裏有TARGET爲web-full-dev的配置。數組

// Runtime+compiler development build (Browser)
  'web-full-dev': {
    entry: resolve('web/entry-runtime-with-compiler.js'),
    dest: resolve('dist/vue.js'),
    format: 'umd',
    env: 'development',
    alias: { he: './entity-decoder' },
    banner
  }
複製代碼

來分析上面的代碼，入口文件的地址在web/entry-runtime-with-compiler.js。這個文件就是對Vue構造函數進行的第一層包裝了。因爲今天分析的是options相關的內容，而這層包裝裏沒有options相關的內容，因此這個文件咱們不展開講(以後有文章會詳細介紹)。可是注意這裏的代碼bash

...
import Vue from './runtime/index'
...
複製代碼

咱們Vue構造函數的第二層包裝，就在這個文件裏了。忽略其餘的代碼，咱們來看關於Vue.options的部分app

...
import Vue from 'core/index' // 第三層包裝
import platformDirectives from './directives/index'
import platformComponents from './components/index'
...
// install platform runtime directives & components
extend(Vue.options.directives, platformDirectives)
extend(Vue.options.components, platformComponents)
...

// platformDirectives相關
// 這裏導出Vue全局指令model,show
import model from './model'
import show from './show'
export default {
  model,
  show
}

// platformComponents相關
// 這裏導出Vue全局組件Transition，TransitionGroup
import Transition from './transition'
import TransitionGroup from './transition-group'
export default {
  Transition,
  TransitionGroup
}
複製代碼

上面的代碼主要是給Vue.options.directives添加model,show屬性，給Vue.options.components添加Transition,TransitionGroup屬性。那麼還有filters，_base屬性，以及components中的KeepAlive又是怎麼來的呢？函數

這就要看Vue的第三層包裝裏都作了些什麼？找到core/index,一樣咱們只看Vue.options相關代碼。

mport Vue from './instance/index'
import { initGlobalAPI } from './global-api/index'
...
initGlobalAPI(Vue)
...
複製代碼

instance/index 就是咱們第二篇文章——構造函數定義的那個文件。這個文件咱們以前看過，沒有和Vue構造函數options相關的代碼。那麼咱們剩下的沒有配置的options必定是在initGlobalAPI上配置了。接來下看看/global-api/index的代碼。

/* @flow */

import { ASSET_TYPES } from 'shared/constants'
...
export function initGlobalAPI (Vue: GlobalAPI) {
  ...
  Vue.options = Object.create(null)
  ASSET_TYPES.forEach(type => {
    Vue.options[type + 's'] = Object.create(null)
  })
  Vue.options._base = Vue
  extend(Vue.options.components, builtInComponents)
  ...
}

// shared/constants.js
export const ASSET_TYPES = [
  'component',
  'directive',
  'filter'
]

// core/components/index
import KeepAlive from './keep-alive'
export default {
  KeepAlive
}
複製代碼

至此，filters,_base和components中的KeepAlive就都有了。經過這三層包裝，Vue構造函數的options對象就油然而生，看這些文字可能有點繞，咱們直接上圖。

包裝options的過程
回到resolveConstructorOptions的源碼中，當Ctor.super不存在時，直接返回基礎構造器的options。即上圖通過兩次包裝的options。那麼Ctor.super是什麼呢？

Ctor.super是經過Vue.extend構造子類的時候。Vue.extend方法會爲Ctor添加一個super屬性，指向其父類構造器。

Vue.extend = function (extendOptions: Object): Function {
  ...
  Sub['super'] = Super
  ...
}
複製代碼

因此當Ctor時基礎構造器的時候，resolveConstructorOptions方法返回基礎構造器的options。

Ctor是Vue.extend建立的"子類"

Vue.extend方法咱們以後的博文再進行詳細介紹，這裏你們能夠先把Vue.extend的功能籠統的理解爲繼承。咱們接下來看resolveConstructorOptions相關的代碼，若是Ctor是Vue.extend建立的"子類"，那麼在extend的過程當中，Ctor對象上就會有super屬性。

Vue.extend = function (extendOptions: Object): Function {
  ...
  Sub['super'] = Super
  ...
}
複製代碼

若是有super屬性，就會去執行if塊內的代碼

...
const superOptions = resolveConstructorOptions(Ctor.super)
const cachedSuperOptions = Ctor.superOptions
...
// Vue.extend相關代碼
Vue.extend = function (extendOptions: Object): Function {
  ...
  Sub.superOptions = Super.options // Sub.superOptions指向基礎構造器的options
  ...
}
複製代碼

首先遞歸調用resolveConstructorOptions方法，返回"父類"上的options並賦值給superOptions變量。而後把"自身"的options賦值給cachedSuperOptions變量。

而後比較這兩個變量的值,當這兩個變量值不等時，說明"父類"的options改變過了。例如執行了Vue.mixin方法，這時候就須要把"自身"的superOptions屬性替換成最新的,以後檢查是否"自身"的options是否發生變化？resolveModifiedOptions的功能就是這個。

if (superOptions !== cachedSuperOptions) {
      // super option changed,
      // need to resolve new options.
      Ctor.superOptions = superOptions
      // check if there are any late-modified/attached options (#4976)
      const modifiedOptions = resolveModifiedOptions(Ctor)
      ....
    }
複製代碼

說了這麼多，你們可能仍是有點陌生，咱們直接舉個例子來講明一下。

var Profile = Vue.extend({
     template: '<p>{{firstName}} {{lastName}} aka {{alias}}</p>'
  })
  Vue.mixin({ data: function () {
    return {
      firstName: 'Walter',
      lastName: 'White',
      alias: 'Heisenberg'
    }
   }})
   new Profile().$mount('#example')
複製代碼

因爲Vue.mixin改變了"父類"options，源碼中superOptions和cachedSuperOptions就不相等了,你們能夠去jsfiddle試試效果。 接下來看看resolveModifiedOptions都幹了哪些事情？

function resolveModifiedOptions (Ctor: Class<Component>): ?Object {
  let modified // 定義modified變量
  const latest = Ctor.options // 自身的options
  const extended = Ctor.extendOptions // 構造"自身"時傳入的options
  const sealed = Ctor.sealedOptions // 執行Vue.extend時封裝的"自身"options，這個屬性就是方便檢查"自身"的options有沒有變化
 // 遍歷當前構造器上的options屬性，若是在"自身"封裝的options裏沒有，則證實是新添加的。執行if內的語句。調用dedupe方法，最終返回modified變量(即」自身新添加的options「)
  for (const key in latest) {
    if (latest[key] !== sealed[key]) {
      if (!modified) modified = {}
      modified[key] = dedupe(latest[key], extended[key], sealed[key])
    }
  }
  return modified
}
複製代碼

那麼dedupe方法又是怎麼處理的呢？

function dedupe (latest, extended, sealed) {
  // compare latest and sealed to ensure lifecycle hooks won't be duplicated
  // between merges
  if (Array.isArray(latest)) {
    const res = []
    sealed = Array.isArray(sealed) ? sealed : [sealed]
    extended = Array.isArray(extended) ? extended : [extended]
    for (let i = 0; i < latest.length; i++) {
      // push original options and not sealed options to exclude duplicated options
      if (extended.indexOf(latest[i]) >= 0 || sealed.indexOf(latest[i]) < 0) {
        res.push(latest[i])
      }
    }
    return res
  } else {
    return latest
  }
}
複製代碼

從做者的註釋能夠看到這個方法主要就是防止生命週期構造函數重複。咱們來看該方法傳入的3個參數: latest，extended，sealed

  1. lateset表示的是"自身"新增的options。
  2. extended表示的是當前構造器上新增的extended
  3. options，sealed表示的是當前構造器上新增的封裝options。

回到源碼，若是latest不是數組的話(lateset是"自身"新增的options)，這裏不須要去重，直接返回latest。

若是傳入的latest是數組（若是latest是數組，通常這個新增的options就是生命週期鉤子函數），則遍歷該數組，若是該數組的某項在extended數組中有或者在sealed數組中沒有，則推送到返回數組中從而實現去重。(這個去重邏輯目前本身還不是特別明白，以後若是明白了會在這裏更新，有明白的同窗們請在評論區留言)

如今咱們瞭解了resolveModifiedOptions和dedupe方法的做用，接下來回到resolveConstructorOptions源碼。

if (modifiedOptions) {
    extend(Ctor.extendOptions, modifiedOptions)
  }
  options = Ctor.options = mergeOptions(superOptions, Ctor.extendOptions)
  if (options.name) {
    options.components[options.name] = Ctor
  }
複製代碼

若是」自身「有新添加的options，則把新添加的options屬性添加到Ctor.extendOptions屬性上，再調用mergeOptions方法合併"父類"構造器上的options和」自身「上的extendOptions(mergeOptions在下一篇博文中介紹)，最後返回合併後的options。

看到這裏，可能會感受到頭暈，爲了讓你們更好的理解。我畫了下面的流程圖。

resolveConstructorOptions流程圖
關於resolveConstructorOptions的內容咱們已經解析完了，下篇博客主要講mergeOptions方法，它在整個Vue中屬於比較核心的一個方法。敬請期待！

若是您以爲個人文章還不錯，請不要吝惜大家的點贊！謝謝！

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程