Vue源碼探究之狀態初始化

// 定義并導出initState函數，接收參數vm
export function initState (vm: Component) {
 // 初始化實例的私有屬性_watchers
 // 這就是在觀察系統里會使用到的存儲所有顯式監視器的對象
 vm._watchers = []
 // 獲取實例的配置對象
 const opts = vm.$options
 // 如果定義了props，則初始化props
 if (opts.props) initProps(vm, opts.props)
 // 如果定義了methods，則初始化methods
 if (opts.methods) initMethods(vm, opts.methods)
 // 如果定義了data，則初始化data
 if (opts.data) {
 initData(vm)
 } else {
 // 否則初始化實例的私有屬性_data為空對象，并開啟觀察
 observe(vm._data = {}, true /* asRootData */)
 }
 // 如果定義了computed，則初始化計算屬性
 if (opts.computed) initComputed(vm, opts.computed)
 // 如果定義了watch并且不是nativeWatch，則初始化watch
 // nativeWatch是火狐瀏覽器下定義的對象的原型方法
 if (opts.watch && opts.watch !== nativeWatch) {
 initWatch(vm, opts.watch)
 }
}

// 定義共享屬性定義描述符對象sharedPropertyDefinition
// 描述符對象的枚舉和可配置屬性都設置為true
// get、set方法設置為空函數
const sharedPropertyDefinition = {
 enumerable: true,
 configurable: true,
 get: noop,
 set: noop
}

// 定義并導出proxy函數，該函數用來為在目標對象上定義并代理屬性
// 接收目標對象target，路徑鍵名sourceKey，屬性鍵名三個參數
export function proxy (target: Object, sourceKey: string, key: string) {
 // 設置屬性描述符對象的get方法
 sharedPropertyDefinition.get = function proxyGetter () {
 return this[sourceKey][key]
 }
 // 設置屬性描述性對象的set犯法
 sharedPropertyDefinition.set = function proxySetter (val) {
 this[sourceKey][key] = val
 }
 // 在目標對象上定義屬性
 Object.defineProperty(target, key, sharedPropertyDefinition)
}

// 定義initProps函數，接收vm，propsOptions兩個參數
function initProps (vm: Component, propsOptions: Object) {
 // 賦值propsData，propsData是全局擴展傳入的賦值對象
 // 在使用extend的時候會用到，實際開發里運用較少
 const propsData = vm.$options.propsData || {}
 // 定義實例的_props私有屬性，并賦值給props
 const props = vm._props = {}
 // 緩存prop鍵，以便將來props更新可以使用Array而不是動態對象鍵枚舉進行迭代。
 // cache prop keys so that future props updates can iterate using Array
 // instead of dynamic object key enumeration.
 const keys = vm.$options._propKeys = []
 // 是否是根實例
 const isRoot = !vm.$parent
 // 對于非根實例，關閉觀察標識
 // root instance props should be converted
 if (!isRoot) {
 toggleObserving(false)
 }
 // 遍歷props配置對象
 for (const key in propsOptions) {
 // 向緩存鍵值數組中添加鍵名
 keys.push(key)
 // 驗證prop的值，validateProp執行對初始化定義的props的類型檢查和默認賦值
 // 如果有定義類型檢查，布爾值沒有默認值時會被賦予false，字符串默認undefined
 // 對propsOptions的比較也是在使用extend擴展時才有意義
 // 具體實現可以參考 src/core/util/props.js，沒有難點這里不詳細解釋
 const value = validateProp(key, propsOptions, propsData, vm)

 // 非生產環境下進行檢查和提示
 /* istanbul ignore else */
 if (process.env.NODE_ENV !== 'production') {
 // 進行鍵名的轉換，將駝峰式轉換成連字符式的鍵名
 const hyphenatedKey = hyphenate(key)
 // 對與保留變量名沖突的鍵名給予提示
 if (isReservedAttribute(hyphenatedKey) ||
 config.isReservedAttr(hyphenatedKey)) {
 warn(
 `"${hyphenatedKey}" is a reserved attribute and cannot be used as component prop.`,
 vm
 )
 }
 // 對屬性建立觀察，并在直接使用屬性時給予警告
 defineReactive(props, key, value, () => {
 if (vm.$parent && !isUpdatingChildComponent) {
 warn(
 `Avoid mutating a prop directly since the value will be ` +
 `overwritten whenever the parent component re-renders. ` +
 `Instead, use a data or computed property based on the prop's ` +
 `value. Prop being mutated: "${key}"`,
 vm
 )
 }
 })
 } else {
 // 非生產環境下直接對屬性進行存取器包裝，建立依賴觀察
 defineReactive(props, key, value)
 }
 // 使用Vue.extend()方法擴展屬性時，已經對靜態屬性進行了代理
 // 這里只需要針對實例化時的屬性執行代理操作
 // static props are already proxied on the component's prototype
 // during Vue.extend(). We only need to proxy props defined at
 // instantiation here.
 // 當實例上沒有同名屬性時，對屬性進行代理操作
 // 將對鍵名的引用指向vm._props對象中
 if (!(key in vm)) {
 proxy(vm, `_props`, key)
 }
 }
 // 開啟觀察狀態標識
 toggleObserving(true)
}

// 定義initData函數
function initData (vm: Component) {
 // 獲取配置對象的data屬性
 let data = vm.$options.data
 // 判斷data是否是函數
 // 若是函數則將getData函數的返回賦值給data和實例私有屬性_data
 // 否則直接將data賦值給實例_data屬性，并在無data時賦值空對象
 data = vm._data = typeof data === 'function'
 ? getData(data, vm)
 : data || {}
 // 如果data不是對象則將data賦值為空對象
 // 進一步保證data是對象類型
 if (!isPlainObject(data)) {
 data = {}
 // 在非生產環境下給出警告提示
 process.env.NODE_ENV !== 'production' && warn(
 'data functions should return an object:\n' +
 'https://vuejs.org/v2/guide/components.html#data-Must-Be-a-Function',
 vm
 )
 }
 // 實例對象代理data
 // proxy data on instance
 // 獲取所有data鍵值
 const keys = Object.keys(data)
 // 獲取配置對象的props
 const props = vm.$options.props
 // 獲取配置對象的methods
 const methods = vm.$options.methods
 // 遍歷keys
 let i = keys.length
 while (i--) {
 const key = keys[i]
 // 非生產環境給出與methods定義的方法名沖突的警告
 if (process.env.NODE_ENV !== 'production') {
 if (methods && hasOwn(methods, key)) {
 warn(
 `Method "${key}" has already been defined as a data property.`,
 vm
 )
 }
 }
 // 檢測是否與props沖突
 if (props && hasOwn(props, key)) {
 // 非生產環境給出沖突警告
 process.env.NODE_ENV !== 'production' && warn(
 `The data property "${key}" is already declared as a prop. ` +
 `Use prop default value instead.`,
 vm
 )
 // 沒有與props沖突并且非保留字時，代理鍵名到實例的_data對象上
 } else if (!isReserved(key)) {
 proxy(vm, `_data`, key)
 }
 }
 // 觀察數據
 // observe data
 observe(data, true /* asRootData */)
}

// 定義并導出getData函數，接受函數類型的data對象，和Vue實例對象
export function getData (data: Function, vm: Component): any {
 // pushTarget和popTarget是為了解決Vue依賴性檢測的缺陷可能導致冗余依賴性的問題
 // 具體可參閱 https://github.com/vuejs/vue/issues/7573
 // 此操作會設置Dep.target為undefined，在初始化option時調用dep.depend()也不會建立依賴
 // #7573 調用數據getter時禁用dep集合
 // #7573 disable dep collection when invoking data getters
 pushTarget()
 // 嘗試在vm上調用data函數并返回執行結果
 try {
 return data.call(vm, vm)
 } catch (e) {
 // 如果捕獲到錯誤則處理錯誤，并返回空對象
 handleError(e, vm, `data()`)
 return {}
 } finally {
 popTarget()
 }
}

// 設置computedWatcherOptions對象
const computedWatcherOptions = { computed: true }

// 定義initComputed函數，接受實例vm，和computed對象
function initComputed (vm: Component, computed: Object) {
 // $flow-disable-line
 // 定義watchers和實例_computedWatchers屬性，初始賦值空對象
 const watchers = vm._computedWatchers = Object.create(null)
 // 是否是服務器渲染，computed屬性在服務器渲染期間只能是getter
 // computed properties are just getters during SSR
 const isSSR = isServerRendering()

 // 遍歷computed
 for (const key in computed) {
 // 獲取用戶定義的值
 const userDef = computed[key]
 // 如果用戶定義的是函數則賦值給getter否則j將userDef.get方法賦值給getter
 const getter = typeof userDef === 'function' ? userDef : userDef.get
 // 非生產環境拋出缺少計算屬性錯誤警告
 if (process.env.NODE_ENV !== 'production' && getter == null) {
 warn(
 `Getter is missing for computed property "${key}".`,
 vm
 )
 }

 // 非服務器渲染下
 if (!isSSR) {
 // 為計算屬性創建內部監視器
 // create internal watcher for the computed property.
 watchers[key] = new Watcher(
 vm,
 getter || noop,
 noop,
 computedWatcherOptions
 )
 }

 // 組件定義的內部計算屬性已經在組件的原型上定義好了
 // 所以這里只要關注實例初始化時用戶定義的計算屬性
 // component-defined computed properties are already defined on the
 // component prototype. We only need to define computed properties defined
 // at instantiation here.
 // 鍵名非實例根屬性時，定義計算屬性，具體參照defineComputed函數
 if (!(key in vm)) {
 defineComputed(vm, key, userDef)
 // 非生產環境下，檢測與data屬性名的沖突并給出警告
 } else if (process.env.NODE_ENV !== 'production') {
 if (key in vm.$data) {
 warn(`The computed property "${key}" is already defined in data.`, vm)
 } else if (vm.$options.props && key in vm.$options.props) {
 warn(`The computed property "${key}" is already defined as a prop.`, vm)
 }
 }
 }
}

// 定義并導出defineComputed哈數
// 接收實例target，計算屬性鍵名key，計算屬性值userDef參數
export function defineComputed (
 target: any,
 key: string,
 userDef: Object | Function
) {
 // 在非服務器渲染下設置緩存
 const shouldCache = !isServerRendering()
 // 計算屬性值是函數時
 if (typeof userDef === 'function') {
 // 設置計算屬性的getter，setter為空函數
 sharedPropertyDefinition.get = shouldCache
 ? createComputedGetter(key)
 : userDef
 sharedPropertyDefinition.set = noop
 } else {
 // 當計算屬性是對象時，設置計算屬性的getter和setter
 sharedPropertyDefinition.get = userDef.get
 ? shouldCache && userDef.cache !== false
 ? createComputedGetter(key)
 : userDef.get
 : noop
 sharedPropertyDefinition.set = userDef.set
 ? userDef.set
 : noop
 }
 // 非生產環境下，如果沒喲定義計算屬性的setter
 // 想設置計算屬性時給出警告
 if (process.env.NODE_ENV !== 'production' &&
 sharedPropertyDefinition.set === noop) {
 sharedPropertyDefinition.set = function () {
 warn(
 `Computed property "${key}" was assigned to but it has no setter.`,
 this
 )
 }
 }
 // 以重新設置的屬性描述符為基礎在實例對象上定義計算屬性
 Object.defineProperty(target, key, sharedPropertyDefinition)
}

// 定義createComputedGetter，創建計算屬性getter
// 目的是在非服務器渲染情況下建立計算屬性的觀察依賴，
// 并根據其依賴屬性返回計算后的值
function createComputedGetter (key) {
 return function computedGetter () {
 const watcher = this._computedWatchers && this._computedWatchers[key]
 if (watcher) {
 watcher.depend()
 return watcher.evaluate()
 }
 }
}

// 定義initMethods方法，接受實例vm，配置屬性methods
function initMethods (vm: Component, methods: Object) {
 // 獲取實例的props
 const props = vm.$options.props
 // 遍歷methods對象
 for (const key in methods) {
 // 非生產環境下給出警告
 if (process.env.NODE_ENV !== 'production') {
 // 未賦值方法警告
 if (methods[key] == null) {
 warn(
 `Method "${key}" has an undefined value in the component definition. ` +
 `Did you reference the function correctly?`,
 vm
 )
 }
 // 與props屬性名沖突警告
 if (props && hasOwn(props, key)) {
 warn(
 `Method "${key}" has already been defined as a prop.`,
 vm
 )
 }
 // 與保留字沖突警告
 if ((key in vm) && isReserved(key)) {
 warn(
 `Method "${key}" conflicts with an existing Vue instance method. ` +
 `Avoid defining component methods that start with _ or $.`
 )
 }
 }
 // 在實例上定義方法，賦值為用戶未定義函數或空函數
 vm[key] = methods[key] == null ? noop : bind(methods[key], vm)
 }
}

// 定義initWatch函數，接受實例vm和配置屬性watch
function initWatch (vm: Component, watch: Object) {
 // 遍歷watch
 for (const key in watch) {
 // 暫存屬性的值
 const handler = watch[key]
 // 如果handler是數組
 if (Array.isArray(handler)) {
 // 遍歷數組為每一個元素創建相應watcher
 for (let i = 0; i < handler.length; i++) {
 createWatcher(vm, key, handler[i])
 }
 } else {
 // 竇否則handler應該是函數，直接為key創建watcher
 createWatcher(vm, key, handler)
 }
 }
}

// 定義createWatcher函數
// 接受實例vm、表達式或函數expOrFn，處理器handler，可選的options
function createWatcher (
 vm: Component,
 expOrFn: string | Function,
 handler: any,
 options?: Object
) {
 // 如果handler是對象
 if (isPlainObject(handler)) {
 // 將handler賦值給options.
 options = handler
 // 重新賦值handler
 handler = handler.handler
 }
 // 如果handler是字符串，在實例上尋找handler并賦值給handler
 if (typeof handler === 'string') {
 handler = vm[handler]
 }
 // 創建觀察并返回
 return vm.$watch(expOrFn, handler, options)
}

// 定義并導出stateMixin函數，接收參數Vue
export function stateMixin (Vue: Class<Component>) {
 // 使用 Object.defineProperty 方法直接聲明定義對象時，flow會發生問題
 // 所以必須在此程序化定義對象
 // flow somehow has problems with directly declared definition object
 // when using Object.defineProperty, so we have to procedurally build up
 // the object here.
 // 定義dataDef對象
 const dataDef = {}
 // 定義dataDef的get方法，返回Vue實例私有屬性_data
 dataDef.get = function () { return this._data }
 // 定義propsDef對象
 const propsDef = {}
 // 定義propsDef的get方法，返回Vue實例私有屬性_props
 propsDef.get = function () { return this._props }
 // 非生產環境下，定義dataDef和propsDef的set方法
 if (process.env.NODE_ENV !== 'production') {
 // dataDef的set方法接收Object類型的newData形參
 dataDef.set = function (newData: Object) {
 // 提示避免傳入對象覆蓋屬性$data
 // 推薦使用嵌套的數據屬性代替
 warn(
 'Avoid replacing instance root $data. ' +
 'Use nested data properties instead.',
 this
 )
 }
 // 設置propsDef的set方法為只讀
 propsDef.set = function () {
 warn(`$props is readonly.`, this)
 }
 }
 // 定義Vue原型對象公共屬性$data，并賦值為dataDef
 Object.defineProperty(Vue.prototype, '$data', dataDef)
 // 定義Vue原型對象公共屬性$props，并賦值為propsDef
 Object.defineProperty(Vue.prototype, '$props', propsDef)

 // 定義Vue原型對象的$set方法，并賦值為從觀察者導入的set函數
 Vue.prototype.$set = set
 // 定義Vue原型對象的$delete方法，并賦值為從觀察者導入的del函數
 Vue.prototype.$delete = del

 // 定義Vue原型對象的$watch方法
 // 接收字符串或函數類型的expOrFn，從命名中可看出希望為表達式或函數
 // 接收任何類型的cb，這里希望為回調函數或者是一個對象
 // 接收對象類型的options
 // 要求返回函數類型
 Vue.prototype.$watch = function (
 expOrFn: string | Function,
 cb: any,
 options?: Object
 ): Function {
 // 把實例賦值給vm變量，類型需為Component
 const vm: Component = this
 // 如果cb是純粹的對象類型
 if (isPlainObject(cb)) {
 // 返回createWatcher函數
 return createWatcher(vm, expOrFn, cb, options)
 }
 // 定義觀察目標的options，大多數情況下為undefined
 options = options || {}
 // 定義options的user屬性值為true，標識為用戶定義
 options.user = true
 // 創建watcher實例
 const watcher = new Watcher(vm, expOrFn, cb, options)
 // 如果options的immediate為真
 if (options.immediate) {
 // 在vm上調用cb回調函數，并傳入watcher.value作為參數
 cb.call(vm, watcher.value)
 }
 // 返回unwatchFn函數
 return function unwatchFn () {
 // 執行watcher.teardown()方法清除觀察
 watcher.teardown()
 }
 }
}