Vue.js实现响应式的核心是利用了ES5的Object.defineProperty,这也是Vue.js不能兼容IE8以下的原因
Object.defineProperty
在一个对象上定义一个新属性,或者修改一个对象的现有属性, 并返回这个对象
Object.defineProperty(obj, prop, descriptor)
obj 是要在其上定义属性的对象;prop 是要定义或修改的属性的名称;descriptor 是将被定义或修改的属性描述符
initState
在Vue的初始化阶段,_init方法执行的时候会执行initState(vm)方法
定义在src/core/instance/state.js中
export function initState (vm: Component) {
vm._watchers = []
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 && opts.watch !== nativeWatch) {
initWatch(vm, opts.watch)
}
}
initProps
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)
}
// 遍历定义的props配置
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方法把每个prop对应的值变成响应式,可以通过vm._props.xxx访问到定义props中对应的属性
defineReactive(props, key, value, () => {
if (!isRoot && !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._proxy.xxx的访问代理到vm.xxx上
proxy(vm, `_props`, key)
}
}
toggleObserving(true)
}
initData
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)) {
// 定义data函数返回对象的遍历,通过proxy把每一个值vm._data.xxx都代理到vm.xxx上
proxy(vm, `_data`, key)
}
}
// observe data
// 调用observe方法观测整个data的变化,把data也变成响应式,可以通过vm._data.xxx访问到定义data返回函数中对应的属性
observe(data, true /* asRootData */)
}
无论是 props 或是 data 的初始化都是把它们变成响应式对象
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
}
// 把target[sourceKey][key]的读写变成了对target[key]的读写
Object.defineProperty(target, key, sharedPropertyDefinition)
}
对于 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 属性了
observe
observe 的功能就是用来监测数据的变化
定义在 src/core/observer/index.js 中
/**
* Attempt to create an observer instance for a value,
* returns the new observer if successfully observed,
* or the existing observer if the value already has one.
*/
export function observe (value: any, asRootData: ?boolean): Observer | void {
if (!isObject(value) || value instanceof VNode) {
return
}
let ob: Observer | void
// 给非VNode的对象类型数据添加一个Observer
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) // 实例化一个Observer对象实例
}
if (asRootData && ob) {
ob.vmCount++
}
return ob
}
Observer
Observer是一个类,作用是给对象的属性添加getter和setter,用于依赖收集和派发更新
/**
* Observer class that is attached to each observed
* object. Once attached, the observer converts the target
* object's property keys into getter/setters that
* collect dependencies and dispatch updates.
*/
export class Observer {
value: any;
dep: Dep;
vmCount: number; // number of vms that have this object as root $data
constructor (value: any) {
this.value = value
this.dep = new Dep() // 实例化Dep对象
this.vmCount = 0
def(value, '__ob__', this) //把自身实例添加到数据对象value的_ob_属性上
if (Array.isArray(value)) {
if (hasProto) {
protoAugment(value, arrayMethods)
} else {
copyAugment(value, arrayMethods, arrayKeys)
}
this.observeArray(value) // 数组调用方法
} else {
this.walk(value) // 纯对象调用方法
}
}
/**
* Walk through all properties and convert them into
* getter/setters. This method should only be called when
* value type is Object.
*/
walk (obj: Object) {
// 遍历对象的key 调用defineReactive方法
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>) {
// 遍历数组再次调用observe方法
for (let i = 0, l = items.length; i < l; i++) {
observe(items[i])
}
}
}
def方法定义在src/core/util/lang.js中
/**
* Define a property.
* 对Object.defineProperty的封装
*/
export function def (obj: Object, key: string, val: any, enumerable?: boolean) {
Object.defineProperty(obj, key, {
value: val,
enumerable: !!enumerable,
writable: true,
configurable: true
})
}
在开发中输出data上对象类型的数据会发现该对象多了一个ob的属性
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
) {
// 初始化Dep对象实例
const dep = new Dep()
// 拿到obj的属性描述符
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]
}
// 对子对象递归调用observe方法,这样就保证了无论obj的结构多复杂,它的子属性也能变成响应式对象,这样访问和修改obj中一个嵌套较深的属性也能触发getter和setter
let childOb = !shallow && observe(val)
// 利用Object.defineProperty去给obj的属性key添加getter和setter
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()
}
// #7981: for accessor properties without setter
if (getter && !setter) return
if (setter) {
setter.call(obj, newVal)
} else {
val = newVal
}
childOb = !shallow && observe(newVal)
dep.notify()
}
})
}