vue的原始碼學習之七——1.響應式物件
1 介紹
版本：2.5.17。
我們使用vue-vli建立基於Runtime+Compiler的vue腳手架。
學習文件：https://ustbhuangyi.github.io/vue-analysis/reactive/reactive-object.html
2 響應式物件
我們瞭解過由於Vue.js 實現響應式的核心是利用了 ES5 的 Object.defineProperty
2.1 Object.defineProperty
Object.defineProperty 方法會直接在一個物件上定義一個新屬性，或者修改一個物件的現有屬性， 並返回這個物件，先來看一下它的語法：
Object.defineProperty(obj, prop, descriptor)obj：要在其上定義屬性的物件。prop：要定義或修改的屬性的名稱。descriptor：將被定義或修改的屬性描述符。
比較核心的是 descriptor，它有很多可選鍵值，具體的可以去參閱它的get 和 set，get 是一個給屬性提供的 getter 方法，當我們訪問了該屬性的時候會觸發 getter 方法；set 是一個給屬性提供的 setter 方法，當我們對該屬性做修改的時候會觸發 setter 方法。
2.1.1 getter 和 setter
下面的例子展示瞭如何實現一個自存檔物件。 當設定temperature 屬性時，archive 陣列會獲取日誌條目。
function Archiver() { var temperature = null; var archive = []; Object.defineProperty(this, 'temperature', { get: function() { console.log('get!'); return temperature; }, set: function(value) { temperature = value; archive.push({ val: temperature }); } }); this.getArchive = function() { return archive; }; } var arc = new Archiver(); arc.temperature; // 'get!' arc.temperature = 11; arc.temperature = 13; arc.getArchive(); // [{ val: 11 }, { val: 13 }]
2.2 vue的響應式物件
一旦物件擁有了 getter 和 setter，我們可以簡單地把這個物件稱為響應式物件。那麼 Vue.js 把哪些物件變成了響應式物件了呢，接下來我們從原始碼層面分析。
2.2.1 initState
在 Vue 的初始化階段，_init 方法執行的時候，會執行 initState(vm) 方法
Vue.prototype._init = function (options?: Object) {
...
//主要就是操作資料了，props、methods、data、computed、watch，從這裡開始就涉及到了Observer、Dep和Watcher
initState(vm)
... initState定義在 src/core/instance/state.js 中：
export function initState (vm: Component) {
vm._watchers = []
const opts = vm.$options
if (opts.props) initProps(vm, opts.props)
if (opts.methods) initMethods(vm, opts.methods)
if (opts.data) {
initData(vm)
} else {
observe(vm._data = {}, true /* asRootData */)
}
if (opts.computed) initComputed(vm, opts.computed)
if (opts.watch && opts.watch !== nativeWatch) {
initWatch(vm, opts.watch)
}
}initState 方法主要是對 props、methods、data、computed 和 wathcer 等屬性做了初始化操作。這裡我們重點分析 props 和 data，對於其它屬性的初始化我們之後再詳細分析。
2.2.2 initProps
定義在src/core/instance/state.js：
function initProps (vm: Component, propsOptions: Object) {
const propsData = vm.$options.propsData || {}
const props = vm._props = {}
// 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)
}
for (const key in propsOptions) {
keys.push(key)
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)
}
// static props are already proxied on the component's prototype
// during Vue.extend(). We only need to proxy props defined at
// instantiation here.
if (!(key in vm)) {
proxy(vm, `_props`, key)
}
}
toggleObserving(true)
}props 的初始化主要過程，就是遍歷定義的 props 配置。遍歷的過程主要做兩件事情：一個是呼叫 defineReactive 方法把每個 prop 對應的值變成響應式，可以通過 vm._props.xxx 訪問到定義 props 中對應的屬性。
2.2.3 initData
定義在src/core/instance/state.js：
function initData (vm: Component) {
let data = vm.$options.data
data = vm._data = typeof data === 'function'
? getData(data, vm)
: 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
)
}
// proxy data on instance
const keys = Object.keys(data)
const props = vm.$options.props
const methods = vm.$options.methods
let i = keys.length
while (i--) {
const key = keys[i]
if (process.env.NODE_ENV !== 'production') {
if (methods && hasOwn(methods, key)) {
warn(
`Method "${key}" has already been defined as a data property.`,
vm
)
}
}
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
)
} else if (!isReserved(key)) {
proxy(vm, `_data`, key)
}
}
// observe data
observe(data, true /* asRootData */)
}data 的初始化主要過程也是做兩件事，一個是對定義 data 函式返回物件的遍歷，通過 proxy 把每一個值 vm._data.xxx 都代理到 vm.xxx 上；另一個是呼叫 observe 方法觀測整個 data 的變化，把 data 也變成響應式，可以通過 vm._data.xxx 訪問到定義 data 返回函式中對應的屬性。
2.2.4 proxy
代理的作用是把 props 和 data 上的屬性代理到 vm 例項上，這也就是為什麼比如我們定義瞭如下 props，卻可以通過 vm 例項訪問到它。
let comP = {
props: {
msg: 'hello'
},
methods: {
say() {
console.log(this.msg)
}
}
} 我們可以在 say 函式中通過 this.msg 訪問到我們定義在 props 中的 msg，這個過程發生在 proxy 階段：
const sharedPropertyDefinition = {
enumerable: true,
configurable: true,
get: noop,
set: noop
}
export function proxy (target: Object, sourceKey: string, key: string) {
sharedPropertyDefinition.get = function proxyGetter () {
return this[sourceKey][key]
}
sharedPropertyDefinition.set = function proxySetter (val) {
this[sourceKey][key] = val
}
Object.defineProperty(target, key, sharedPropertyDefinition)
}proxy 方法的實現很簡單，通過 Object.defineProperty 把 target[sourceKey][key] 的讀寫變成了對 target[key] 的讀寫。所以對於 props 而言，對 vm._props.xxx 的讀寫變成了 vm.xxx 的讀寫，而對於 vm._props.xxx 我們可以訪問到定義在 props 中的屬性，所以我們就可以通過 vm.xxx 訪問到定義在 props 中的 xxx 屬性了。同理，對於 data 而言，對 vm._data.xxxx 的讀寫變成了對 vm.xxxx 的讀寫，而對於 vm._data.xxxx 我們可以訪問到定義在 data 函式返回物件中的屬性，所以我們就可以通過 vm.xxxx 訪問到定義在 data 函式返回物件中的 xxxx 屬性了。
2.2.5 observe
observe 的功能就是用來監測資料的變化，它的定義在 src/core/observer/index.js 中：
export function observe (value: any, asRootData: ?boolean): Observer | void {
if (!isObject(value) || value instanceof VNode) {
return
}
let ob: Observer | void
if (hasOwn(value, '__ob__') && value.__ob__ instanceof Observer) {
ob = value.__ob__
} else if (
shouldObserve &&
!isServerRendering() &&
(Array.isArray(value) || isPlainObject(value)) &&
Object.isExtensible(value) &&
!value._isVue
) {
ob = new Observer(value)
}
if (asRootData && ob) {
ob.vmCount++
}
return ob
}observe 方法的作用就是給非 VNode 的物件型別資料新增一個 Observer，如果已經新增過則直接返回，否則在滿足一定條件下去例項化一個 Observer 物件例項。
2.2.6 Observer
Observer 是一個類，它的作用是給物件的屬性新增 getter 和 setter，用於依賴收集和派發更新：
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
this.dep = new Dep()
this.vmCount = 0
def(value, '__ob__', this)
if (Array.isArray(value)) {
const augment = hasProto
? protoAugment
: copyAugment
augment(value, arrayMethods, arrayKeys)
this.observeArray(value)
} else {
this.walk(value)
}
}
/**
* Walk through each property and convert them into
* getter/setters. This method should only be called when
* value type is Object.
*/
walk (obj: Object) {
const keys = Object.keys(obj)
for (let i = 0; i < keys.length; i++) {
defineReactive(obj, keys[i])
}
}
/**
* Observe a list of Array items.
*/
observeArray (items: Array<any>) {
for (let i = 0, l = items.length; i < l; i++) {
observe(items[i])
}
}
}Observer 的建構函式邏輯很簡單，首先例項化 Dep 物件，這塊稍後會介紹，接著通過執行 def 函式把自身例項新增到資料物件 value 的 __ob__ 屬性上，def 的定義在 src/core/util/lang.js 中：
/**
* Define a property.
*/
export function def (obj: Object, key: string, val: any, enumerable?: boolean) {
Object.defineProperty(obj, key, {
value: val,
enumerable: !!enumerable,
writable: true,
configurable: true
})
}def 函式是一個非常簡單的Object.defineProperty 的封裝，這就是為什麼我在開發中輸出 data 上物件型別的資料，會發現該物件多了一個 __ob__ 的屬性。
回到 Observer 的建構函式，接下來會對 value 做判斷，對於陣列會呼叫 observeArray 方法，否則對純物件呼叫 walk 方法。可以看到 observeArray 是遍歷陣列再次呼叫 observe 方法，而 walk 方法是遍歷物件的 key 呼叫 defineReactive 方法。
2.2.7 defineReactive
defineReactive 的功能就是定義一個響應式物件，給物件動態新增 getter 和 setter，它的定義在 src/core/observer/index.js 中：
/**
* Define a reactive property on an Object.
*/
export function defineReactive (
obj: Object,
key: string,
val: any,
customSetter?: ?Function,
shallow?: boolean
) {
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
if ((!getter || setter) && arguments.length === 2) {
val = obj[key]
}
let childOb = !shallow && observe(val)
Object.defineProperty(obj, key, {
enumerable: true,
configurable: true,
get: function reactiveGetter () {
const value = getter ? getter.call(obj) : val
if (Dep.target) {
dep.depend()
if (childOb) {
childOb.dep.depend()
if (Array.isArray(value)) {
dependArray(value)
}
}
}
return value
},
set: function reactiveSetter (newVal) {
const value = getter ? getter.call(obj) : val
/* eslint-disable no-self-compare */
if (newVal === value || (newVal !== newVal && value !== value)) {
return
}
/* eslint-enable no-self-compare */
if (process.env.NODE_ENV !== 'production' && customSetter) {
customSetter()
}
if (setter) {
setter.call(obj, newVal)
} else {
val = newVal
}
childOb = !shallow && observe(newVal)
dep.notify()
}
})
}defineReactive 函式最開始初始化 Dep 物件的例項，接著拿到 obj 的屬性描述符，然後對子物件遞迴呼叫 observe 方法，這樣就保證了無論 obj 的結構多複雜，它的所有子屬性也能變成響應式的物件，這樣我們訪問或修改 obj 中一個巢狀較深的屬性，也能觸發 getter 和 setter。最後利用 Object.defineProperty 去給 obj 的屬性 key 新增 getter 和 setter
2.2.8 總結
我們介紹了響應式物件，核心就是利用 Object.defineProperty 給資料添加了 getter 和 setter，目的就是為了在我們訪問資料以及寫資料的時候能自動執行一些邏輯：getter 做的事情是依賴收集，setter 做的事情是派發更新，那麼在接下來的章節我們會重點對這兩個過程分析。