Vue的資料依賴實現原理簡析
先讓我們從最簡單的一個例項Vue
入手:
const app = new Vue({
// options 傳入一個選項obj.這個obj即對於這個vue例項的初始化
})
通過查閱文件,我們可以知道這個options
可以接受:
-
選項/資料
-
data
-
props
-
propsData(方便測試使用)
-
computed
-
methods
-
watch
-
-
選項 / DOM
-
選項 / 生命週期鉤子
-
選項 / 資源
-
選項 / 雜項
具體未展開的內容請自行查閱相關文件,接下來讓我們來看看傳入的選項/資料
是如何管理資料之間的相互依賴的。
const app = new Vue({ el: '#app', props: { a: { type: Object, default () { return { key1: 'a', key2: { a: 'b' } } } } }, data: { msg1: 'Hello world!', arr: { arr1: 1 } }, watch: { a (newVal, oldVal) { console.log(newVal, oldVal) } }, methods: { go () { console.log('This is simple demo') } } })
我們使用Vue
這個建構函式去例項化了一個vue
例項app
。傳入了props
, data
, watch
, methods
等屬性。在例項化的過程中,Vue
提供的建構函式就使用我們傳入的options
去完成資料的依賴管理,初始化的過程只有一次,但是在你自己的程式當中,資料的依賴管理的次數不止一次。
那Vue
的建構函式到底是怎麼實現的呢?Vue
// 建構函式 function Vue (options) { if (process.env.NODE_ENV !== 'production' && !(this instanceof Vue)) { warn('Vue is a constructor and should be called with the `new` keyword') } this._init(options) } // 對Vue這個class進行mixin,即在原型上新增方法 // Vue.prototype.* = function () {} initMixin(Vue) stateMixin(Vue) eventsMixin(Vue) lifecycleMixin(Vue) renderMixin(Vue)
當我們呼叫new Vue
的時候,事實上就呼叫的Vue
原型上的_init
方法.
// 原型上提供_init方法,新建一個vue例項並傳入options引數
Vue.prototype._init = function (options?: Object) {
const vm: Component = this
// a uid
vm._uid = uid++
let startTag, endTag
// a flag to avoid this being observed
vm._isVue = true
// merge options
if (options && options._isComponent) {
// optimize internal component instantiation
// since dynamic options merging is pretty slow, and none of the
// internal component options needs special treatment.
initInternalComponent(vm, options)
} else {
// 將傳入的這些options選項掛載到vm.$options屬性上
vm.$options = mergeOptions(
// components/filter/directive
resolveConstructorOptions(vm.constructor),
// this._init()傳入的options
options || {},
vm
)
}
/* istanbul ignore else */
if (process.env.NODE_ENV !== 'production') {
initProxy(vm)
} else {
vm._renderProxy = vm
}
// expose real self
vm._self = vm // 自身的例項
// 接下來所有的操作都是在這個例項上新增方法
initLifecycle(vm) // lifecycle初始化
initEvents(vm) // events初始化 vm._events, 主要是提供vm例項上的$on/$emit/$off/$off等方法
initRender(vm) // 初始化渲染函式,在vm上繫結$createElement方法
callHook(vm, 'beforeCreate') // 鉤子函式的執行, beforeCreate
initInjections(vm) // resolve injections before data/props
initState(vm) // Observe data新增對data的監聽, 將data轉化為getters/setters
initProvide(vm) // resolve provide after data/props
callHook(vm, 'created') // 鉤子函式的執行, created
// vm掛載的根元素
if (vm.$options.el) {
vm.$mount(vm.$options.el)
}
}
其中在this._init()
方法中呼叫initState(vm)
,完成對vm
這個例項的資料的監聽,也是本文所要展開說的具體內容。
export function initState (vm: Component) {
// 首先在vm上初始化一個_watchers陣列,快取這個vm上的所有watcher
vm._watchers = []
// 獲取options,包括在new Vue傳入的,同時還包括了Vue所繼承的options
const opts = vm.$options
// 初始化props屬性
if (opts.props) initProps(vm, opts.props)
// 初始化methods屬性
if (opts.methods) initMethods(vm, opts.methods)
// 初始化data屬性
if (opts.data) {
initData(vm)
} else {
observe(vm._data = {}, true /* asRootData */)
}
// 初始化computed屬性
if (opts.computed) initComputed(vm, opts.computed)
// 初始化watch屬性
if (opts.watch) initWatch(vm, opts.watch)
}
initProps
我們在例項化app
的時候,在建構函式裡面傳入的options
中有props
屬性:
props: {
a: {
type: Object,
default () {
return {
key1: 'a',
key2: {
a: 'b'
}
}
}
}
}
function initProps (vm: Component, propsOptions: Object) {
// propsData主要是為了方便測試使用
const propsData = vm.$options.propsData || {}
// 新建vm._props物件,可以通過app例項去訪問
const props = vm._props = {}
// cache prop keys so that future props updates can iterate using Array
// instead of dynamic object key enumeration.
// 快取的prop key
const keys = vm.$options._propKeys = []
const isRoot = !vm.$parent
// root instance props should be converted
observerState.shouldConvert = isRoot
for (const key in propsOptions) {
// this._init傳入的options中的props屬性
keys.push(key)
// 注意這個validateProp方法,不僅完成了prop屬性型別驗證的,同時將prop的值都轉化為了getter/setter,並返回一個observer
const value = validateProp(key, propsOptions, propsData, vm)
// 將這個key對應的值轉化為getter/setter
defineReactive(props, key, value)
// static props are already proxied on the component's prototype
// during Vue.extend(). We only need to proxy props defined at
// instantiation here.
// 如果在vm這個例項上沒有key屬性,那麼就通過proxy轉化為proxyGetter/proxySetter, 並掛載到vm例項上,可以通過app._props[key]這種形式去訪問
if (!(key in vm)) {
proxy(vm, `_props`, key)
}
}
observerState.shouldConvert = true
}
接下來看下validateProp(key, propsOptions, propsData, vm)
方法內部到底發生了什麼。
export function validateProp (
key: string,
propOptions: Object, // $options.props屬性
propsData: Object, // $options.propsData屬性
vm?: Component
): any {
const prop = propOptions[key]
// 如果在propsData測試props上沒有快取的key
const absent = !hasOwn(propsData, key)
let value = propsData[key]
// 處理boolean型別的資料
// handle boolean props
if (isType(Boolean, prop.type)) {
if (absent && !hasOwn(prop, 'default')) {
value = false
} else if (!isType(String, prop.type) && (value === '' || value === hyphenate(key))) {
value = true
}
}
// check default value
if (value === undefined) {
// default屬性值,是基本型別還是function
// getPropsDefaultValue見下面第一段程式碼
value = getPropDefaultValue(vm, prop, key)
// since the default value is a fresh copy,
// make sure to observe it.
const prevShouldConvert = observerState.shouldConvert
observerState.shouldConvert = true
// 將value的所有屬性轉化為getter/setter形式
// 並新增value的依賴
// observe方法的分析見下面第二段程式碼
observe(value)
observerState.shouldConvert = prevShouldConvert
}
if (process.env.NODE_ENV !== 'production') {
assertProp(prop, key, value, vm, absent)
}
return value
}
// 獲取prop的預設值
function getPropDefaultValue (vm: ?Component, prop: PropOptions, key: string): any {
// no default, return undefined
// 如果沒有default屬性的話,那麼就返回undefined
if (!hasOwn(prop, 'default')) {
return undefined
}
const def = prop.default
// the raw prop value was also undefined from previous render,
// return previous default value to avoid unnecessary watcher trigger
if (vm && vm.$options.propsData &&
vm.$options.propsData[key] === undefined &&
vm._props[key] !== undefined) {
return vm._props[key]
}
// call factory function for non-Function types
// a value is Function if its prototype is function even across different execution context
// 如果是function 則呼叫def.call(vm)
// 否則就返回default屬性對應的值
return typeof def === 'function' && getType(prop.type) !== 'Function'
? def.call(vm)
: def
}
Vue
提供了一個observe
方法,在其內部例項化了一個Observer
類,並返回Observer
的例項。每一個Observer
例項對應記錄了props
中這個的default value
的所有依賴(僅限object
型別),這個Observer
實際上就是一個觀察者,它維護了一個數組this.subs = []
用以收集相關的subs(訂閱者)
(即這個觀察者的依賴)。通過將default value
轉化為getter/setter
形式,同時新增一個自定義__ob__
屬性,這個屬性就對應Observer
例項。
說起來有點繞,還是讓我們看看我們給的demo
裡傳入的options
配置:
props: {
a: {
type: Object,
default () {
return {
key1: 'a',
key2: {
a: 'b'
}
}
}
}
}
在往上數的第二段程式碼裡面的方法obervse(value)
,即對{key1: 'a', key2: {a: 'b'}}
進行依賴的管理,同時將這個obj
所有的屬性值都轉化為getter/setter
形式。此外,Vue
還會將props
屬性都代理到vm
例項上,通過vm.key1
,vm.key2
就可以訪問到這個屬性。
此外,還需要了解下在Vue
中管理依賴的一個非常重要的類: Dep
export default class Dep {
constructor () {
this.id = uid++
this.subs = []
}
addSub () {...} // 新增訂閱者(依賴)
removeSub () {...} // 刪除訂閱者(依賴)
depend () {...} // 檢查當前Dep.target是否存在以及判斷這個watcher已經被新增到了相應的依賴當中,如果沒有則新增訂閱者(依賴),如果已經被添加了那麼就不做處理
notify () {...} // 通知訂閱者(依賴)更新
}
在Vue
的整個生命週期當中,你所定義的響應式的資料上都會繫結一個Dep
例項去管理其依賴。它實際上就是觀察者
和訂閱者
聯絡的一個橋樑。
剛才談到了對於依賴的管理,它的核心之一就是觀察者Observer
這個類:
export class Observer {
value: any;
dep: Dep;
vmCount: number; // number of vms that has this object as root $data
constructor (value: any) {
this.value = value
// dep記錄了和這個value值的相關依賴
this.dep = new Dep()
this.vmCount = 0
// value其實就是vm._data, 即在vm._data上新增__ob__屬性
def(value, '__ob__', this)
// 如果是陣列
if (Array.isArray(value)) {
// 首先判斷是否能使用__proto__屬性
const augment = hasProto
? protoAugment
: copyAugment
augment(value, arrayMethods, arrayKeys)
// 遍歷陣列,並將obj型別的屬性改為getter/setter實現
this.observeArray(value)
} else {
// 遍歷obj上的屬性,將每個屬性改為getter/setter實現
this.walk(value)
}
}
/**
* Walk through each property and convert them into
* getter/setters. This method should only be called when
* value type is Object.
*/
// 將每個property對應的屬性都轉化為getter/setters,只能是當這個value的型別為Object時
walk (obj: Object) {
const keys = Object.keys(obj)
for (let i = 0; i < keys.length; i++) {
defineReactive(obj, keys[i], obj[keys[i]])
}
}
/**
* Observe a list of Array items.
*/
// 監聽array中的item
observeArray (items: Array<any>) {
for (let i = 0, l = items.length; i < l; i++) {
observe(items[i])
}
}
}
walk
方法裡面呼叫defineReactive
方法:通過遍歷這個object
的key
,並將對應的value
轉化為getter/setter
形式,通過閉包維護一個dep
,在getter
方法當中定義了這個key
是如何進行依賴的收集,在setter
方法中定義了當這個key
對應的值改變後,如何完成相關依賴資料的更新。但是從原始碼當中,我們卻發現當getter
函式被呼叫的時候並非就一定會完成依賴的收集,其中還有一層判斷,就是Dep.target
是否存在。
/**
* Define a reactive property on an Object.
*/
export function defineReactive (
obj: Object,
key: string,
val: any,
customSetter?: Function
) {
// 每個屬性新建一個dep例項,管理這個屬性的依賴
const dep = new Dep()
// 或者屬性描述符
const property = Object.getOwnPropertyDescriptor(obj, key)
// 如果這個屬性是不可配的,即無法更改
if (property && property.configurable === false) {
return
}
// cater for pre-defined getter/setters
const getter = property && property.get
const setter = property && property.set
// 遞迴去將val轉化為getter/setter
// childOb將子屬性也轉化為Observer
let childOb = observe(val)
Object.defineProperty(obj, key, {
enumerable: true,
configurable: true,
// 定義getter -->> reactiveGetter
get: function reactiveGetter () {
const value = getter ? getter.call(obj) : val
// 定義相應的依賴
if (Dep.target) {
// Dep.target.addDep(this)
// 即新增watch函式
// dep.depend()及呼叫了dep.addSub()只不過中間需要判斷是否這個id的dep已經被包含在內了
dep.depend()
// childOb也新增依賴
if (childOb) {
childOb.dep.depend()
}
if (Array.isArray(value)) {
dependArray(value)
}
}
return value
},
// 定義setter -->> reactiveSetter
set: function reactiveSetter (newVal) {
const value = getter ? getter.call(obj) : val
/* eslint-disable no-self-compare */
if (newVal === value || (newVal !== newVal && value !== value)) {
return
}
if (setter) {
setter.call(obj, newVal)
} else {
val = newVal
}
// 對得到的新值進行observe
childOb = observe(newVal)
// 相應的依賴進行更新
dep.notify()
}
})
}
在上文中提到了Dep
類是連結觀察者
和訂閱者
的橋樑。同時在Dep
的實現當中還有一個非常重要的屬性就是Dep.target
,它事實就上就是一個訂閱者,只有當Dep.target
(訂閱者)存在的時候,呼叫屬性的getter
函式的時候才能完成依賴的收集工作。
Dep.target = null
const targetStack = []
export function pushTarget (_target: Watcher) {
if (Dep.target) targetStack.push(Dep.target)
Dep.target = _target
}
export function popTarget () {
Dep.target = targetStack.pop()
}
那麼Vue
是如何來實現訂閱者
的呢?Vue
裡面定義了一個類: Watcher
,在Vue
的整個生命週期當中,會有4類地方會例項化Watcher
:
-
Vue
例項化的過程中有watch
選項 -
Vue
例項化的過程中有computed
計算屬性選項 -
Vue
原型上有掛載$watch
方法: Vue.prototype.$watch,可以直接通過例項呼叫this.$watch
方法 -
Vue
生成了render
函式,更新檢視時
constructor (
vm: Component,
expOrFn: string | Function,
cb: Function,
options?: Object
) {
// 快取這個例項vm
this.vm = vm
// vm例項中的_watchers中新增這個watcher
vm._watchers.push(this)
// options
if (options) {
this.deep = !!options.deep
this.user = !!options.user
this.lazy = !!options.lazy
this.sync = !!options.sync
} else {
this.deep = this.user = this.lazy = this.sync = false
}
this.cb = cb
this.id = ++uid // uid for batching
this.active = true
this.dirty = this.lazy // for lazy watchers
....
// parse expression for getter
if (typeof expOrFn === 'function') {
this.getter = expOrFn
} else {
this.getter = parsePath(expOrFn)
if (!this.getter) {
this.getter = function () {}
}
}
// 通過get方法去獲取最新的值
// 如果lazy為true, 初始化的時候為undefined
this.value = this.lazy
? undefined
: this.get()
}
get () {...}
addDep () {...}
update () {...}
run () {...}
evaluate () {...}
run () {...}
Watcher
接收的引數當中expOrFn
定義了用以獲取watcher
的getter
函式。expOrFn
可以有2種類型:string
或function
.若為string
型別,首先會通過parsePath
方法去對string
進行分割(僅支援.
號形式的物件訪問)。在除了computed
選項外,其他幾種例項化watcher
的方式都是在例項化過程中完成求值及依賴的收集工作:this.value = this.lazy ? undefined : this.get()
.在Watcher
的get
方法中:
!!!前方高能
get () {
// pushTarget即設定當前的需要被執行的watcher
pushTarget(this)
let value
const vm = this.vm
if (this.user) {
try {
// $watch(function () {})
// 呼叫this.getter的時候,觸發了屬性的getter函式
// 在getter中進行了依賴的管理
value = this.getter.call(vm, vm)
console.log(value)
} catch (e) {
handleError(e, vm, `getter for watcher "${this.expression}"`)
}
} else {
// 如果是新建模板函式,則會動態計算模板與data中繫結的變數,這個時候就呼叫了getter函式,那麼就完成了dep的收集
// 呼叫getter函式,則同時會呼叫函式內部的getter的函式,進行dep收集工作
value = this.getter.call(vm, vm)
}
// "touch" every property so they are all tracked as
// dependencies for deep watching
// 讓每個屬性都被作為dependencies而tracked, 這樣是為了deep watching
if (this.deep) {
traverse(value)
}
popTarget()
this.cleanupDeps()
return value
}
一進入get
方法,首先進行pushTarget(this)
的操作,此時Vue
當中Dep.target = 當前這個watcher
,接下來進行value = this.getter.call(vm, vm)
操作,在這個操作中就完成了依賴的收集工作。還是拿文章一開始的demo
來說,在vue
例項化的時候傳入了watch
選項:
props: {
a: {
type: Object,
default () {
return {
key1: 'a',
key2: {
a: 'b'
}
}
}
}
},
watch: {
a (newVal, oldVal) {
console.log(newVal, oldVal)
}
},
在Vue
的initState()
開始執行後,首先會初始化props
的屬性為getter/setter
函式,然後在進行initWatch
初始化的時候,這個時候初始化watcher
例項,並呼叫get()
方法,設定Dep.target = 當前這個watcher例項
,進而到value = this.getter.call(vm, vm)
的操作。在呼叫this.getter.call(vm, vm)
的方法中,便會訪問props
選項中的a
屬性即其getter
函式。在a
屬性的getter
函式執行過程中,因為Dep.target
已經存在,那麼就進入了依賴收集
的過程:
if (Dep.target) {
// Dep.target.addDep(this)
// 即新增watch函式
// dep.depend()及呼叫了dep.addSub()只不過中間需要判斷是否這個id的dep已經被包含在內了
dep.depend()
// childOb也新增依賴
if (childOb) {
childOb.dep.depend()
}
if (Array.isArray(value)) {
dependArray(value)
}
}
dep
是一開始初始化的過程中,這個屬性上的dep
屬性。呼叫dep.depend()
函式:
depend () {
if (Dep.target) {
// Dep.target為一個watcher
Dep.target.addDep(this)
}
}
Dep.target
也就剛才的那個watcher
例項,這裡也就相當於呼叫了watcher
例項的addDep
方法: watcher.addDep(this)
,並將dep
觀察者傳入。在addDep
方法中完成依賴收集:
addDep (dep: Dep) {
const id = dep.id
if (!this.newDepIds.has(id)) {
this.newDepIds.add(id)
this.newDeps.push(dep)
if (!this.depIds.has(id)) {
dep.addSub(this)
}
}
}
這個時候依賴完成了收集,當你去修改a
屬性的值時,會呼叫a
屬性的setter
函式,裡面會執行dep.notify()
,它會遍歷所有的訂閱者,然後呼叫訂閱者上的update
函式。
initData
過程和initProps
類似,具體可參見原始碼。
initComputed
以上就是在initProps
過程中Vue
是如何進行依賴收集的,initData
的過程和initProps
類似,下來再來看看initComputed
的過程.
在computed
屬性初始化的過程當中,會為每個屬性例項化一個watcher
:
const computedWatcherOptions = { lazy: true }
function initComputed (vm: Component, computed: Object) {
// 新建_computedWatchers屬性
const watchers = vm._computedWatchers = Object.create(null)
for (const key in computed) {
const userDef = computed[key]
// 如果computed為funtion,即取這個function為getter函式
// 如果computed為非function.則可以單獨為這個屬性定義getter/setter屬性
let getter = typeof userDef === 'function' ? userDef : userDef.get
// create internal watcher for the computed property.
// lazy屬性為true
// 注意這個地方傳入的getter引數
// 例項化的過程當中不去完成依賴的收集工作
watchers[key] = new Watcher(vm, getter, noop, computedWatcherOptions)
// component-defined computed properties are already defined on the
// component prototype. We only need to define computed properties defined
// at instantiation here.
if (!(key in vm)) {
defineComputed(vm, key, userDef)
}
}
}
但是這個watcher
在例項化的過程中,由於傳入了{lazy: true}
的配置選項,那麼一開始是不會進行求值與依賴收集的: this.value = this.lazy ? undefined : this.get()
.在initComputed
的過程中,Vue
會將computed
屬性定義到vm
例項上,同時將這個屬性定義為getter/setter
。當你訪問computed
屬性的時候呼叫getter
函式:
function createComputedGetter (key) {
return function computedGetter () {
const watcher = this._computedWatchers && this._computedWatchers[key]
if (watcher) {
// 是否需要重新計算
if (watcher.dirty) {
watcher.evaluate()
}
// 管理依賴
if (Dep.target) {
watcher.depend()
}
return watcher.value
}
}
}
在watcher
存在的情況下,首先判斷watcher.dirty
屬性,這個屬性主要是用於判斷這個computed
屬性是否需要重新求值,因為在上一輪的依賴收集的過程當中,觀察者已經將這個watcher
新增到依賴陣列當中了,如果觀察者發生了變化,就會dep.notify()
,通知所有的watcher
,而對於computed
的watcher
接收到變化的請求後,會將watcher.dirty = true
即表明觀察者發生了變化,當再次呼叫computed
屬性的getter
函式的時候便會重新計算,否則還是使用之前快取的值。
initWatch
initWatch
的過程中其實就是例項化new Watcher
完成觀察者的依賴收集的過程,在內部的實現當中是呼叫了原型上的Vue.prototype.$watch
方法。這個方法也適用於vm
例項,即在vm
例項內部呼叫this.$watch
方法去例項化watcher
,完成依賴的收集,同時監聽expOrFn
的變化。
總結:
以上就是在Vue
例項初始化的過程中實現依賴管理的分析。大致的總結下就是:
-
initState
的過程中,將props
,computed
,data
等屬性通過Object.defineProperty
來改造其getter/setter
屬性,併為每一個響應式屬性例項化一個observer
觀察者。這個observer
內部dep
記錄了這個響應式屬性的所有依賴。 -
當響應式屬性呼叫
setter
函式時,通過dep.notify()
方法去遍歷所有的依賴,呼叫watcher.update()
去完成資料的動態響應。
這篇文章主要從初始化的資料層面上分析了Vue
是如何管理依賴來到達資料的動態響應。下一篇文章來分析下Vue
中模板中的指令和響應式資料是如何關聯來實現由資料驅動檢視,以及資料是如何響應檢視變化的。