前言
最近公司项目从vue2
迁移到vue3
,感觉自己对Object.defineProperty和Proxy的了解还是在浅尝辄止的地步,所以今天抽空整体对二者进行了深入(基础)的了解,主要是二者的基础用法,性能对比,在vue中的应用进行了探索,希望能够帮助到想了解的小伙伴。
Object.defineProperty简介
首先,来看看MDN上的定义:
Object.defineProperty()
方法会直接在一个对象上定义一个新属性,或者修改一个对象的现有属性,并返回此对象。
备注: 应当直接在 Object 构造器对象上调用此方法,而不是在任意一个 Object
类型的实例上调用。
语法
Object.defineProperty(obj, prop, descriptor)
参数说明:
obj
:要定义属性的对象。
prop
:要定义或修改的属性的名称或Symbol
。
descriptor
:要定义或修改的属性描述符。
简单示例
let person = {}; let name = 'yuanwill'; Object.defineProperty(person, 'name', { get() { return name === 'yuanwill' ? 'zhangsan' : 'lisi' }, set(newVal) { name = newVal } }); console.log(person.name); // zhangsan person.name = 'haha'; console.log(person.name); // lisi
- 读取
person
的name
属性时,访问了get
方法,第一次name
是yuanwill
,所以返回了zhangsan
- 修改
person
的name
属性时,访问了set
方法,修改了name
变量的值 - 第二次读取
person
的name
属性,同理,返回了lisi
。
仿vue使用
在vue2中,使用了Object.defineProperty
来实现数据双向绑定的基础(具体的observe,watcher,dep等等balabala就不细说了),我们主要仿造vue
来看看怎么通过Object.defineProperty
来实现一个对象或数组(不扯对数组方法的拦截AOP)的属性拦截和监听。
对象的拦截
准备一个对象如下:
let person = { name: 'yuanwill', age: 26, address: { home: 'guangzhou', now: 'shenzhen' } };
很容易想到,我们需要遍历person
中的key
,然后对每一个key
进行转换即可,于是很自然的写出了下面的错误示例:
Object.keys(person).forEach(key => { Object.defineProperty(person, key, { get() { console.log('拦截到正在获取属性:' + key); return person[key]; // ① }, set(val) { console.log('拦截到正在修改属性:' + key); person[key] = val; // ② } }) }) console.log(person.name)
运行代码发现栈溢出了,错误有两处,代码已经标明:
- 在
get
中,直接使用person[key] 会继续调用get
,导致死循环 - 在
set
中同理。
所以,需要使用一个方法,来传递person[key] 的值。
const defineReactive = (obj, key, val) => { Object.defineProperty(obj, key, { get() { console.log('拦截到正在获取属性:' + key); return val; }, set(newVal) { console.log('拦截到正在修改属性:' + key); val = newVal; } }) } const observer = obj => { // 如果obj不是一个对象,就没必要包装了 if(typeof obj !== 'object' || !obj) { return; } Object.keys(obj).forEach(key => { defineReactive(obj, key, obj[key]) }) }
实验一下:
observer(person); person.name = 'haha'; // 拦截到正在修改属性:name console.log(person.name); // 拦截到正在获取属性:name, haha
可是,还有瑕疵,比如:
person.name = { firstName: 'yuan', lastName: 'will' }; // 拦截到正在修改属性:name person.name.firstName = 'haha'; // 拦截到正在获取属性:name console.log(person.name); // 拦截到正在获取属性:name
可以看到,person.name.firstName
并没有拦截到正在修改firstName
属性。原因是我们在set
的时候,newVal
可能也是一个object
,所以也需要进行observer
。
修改set如下:
set(newVal) { if(typeof newVal === 'object') { observer(newVal); } console.log('拦截到正在修改属性:' + key); val = newVal; }
当然,还有瑕疵,比如访问深层对象:
console.log(person.address.home) // 拦截到正在获取属性:address
并没有拦截到访问属性home
,所以我们还需要判断val
如果是对象也应该再一次observer
。优化后的完整代码如下:
const defineReactive = (obj, key, val) => { if(typeof val === 'object') { observer(val); } Object.defineProperty(obj, key, { get() { console.log('拦截到正在获取属性:' + key); return val; }, set(newVal) { if(typeof newVal === 'object') { observer(newVal); } console.log('拦截到正在修改属性:' + key); val = newVal; } }) } const observer = obj => { // 如果obj不是一个对象,就没必要包装了 if(typeof obj !== 'object' || !obj) { return; } Object.keys(obj).forEach(key => { defineReactive(obj, key, obj[key]) }) }
数组的拦截
我们总说,Object.defineProperty
不能拦截数组,这种说法不太准确,看示例:
let list = [1,2,3,4]; observer(list); console.log(list[0]) // 拦截到正在获取属性:0 list[0] = 2; // 拦截到正在修改属性:0 list[6] = 6; // 无法拦截... list.push(3); // 无法拦截...
可以看到,通过索引去访问或修改已经存在的元素,是可以拦截到的。如果是不存在的元素,或者是通过push
等方法去修改数组,则无法拦截。
正因为如此,vue2在实现的时候,通过重写了数组原型上的七个方法(push、pop、shift、unshift、splice、sort、reverse)来解决(具体可以看vue/src/core/observer/array.js),就不展开了。
Proxy简介
同样,来看看MDN上的定义:
Proxy 对象用于创建一个对象的代理,从而实现基本操作的拦截和自定义(如属性查找、赋值、枚举、函数调用等)。
语法
const p = new Proxy(target, handler)
参数说明:
target
:要使用Proxy
包装的目标对象(可以是任何类型的对象,包括原生数组,函数,甚至另一个代理)。handler
:一个通常以函数作为属性的对象,各属性中的函数分别定义了在执行各种操作时代理p
的行为。
handler
对象总共有13个属性方法,具体的可以参考MDN,就不一一列举了。
简单示例
let person = { name: 'yuanwill' } let personProxy = new Proxy(person, { get(target, key) { return target[key] === 'yuanwill' ? 'zhangsan': 'lisi' }, set(target, key, val) { target[key] = val; return true; } }); console.log(personProxy.name); // zhangsan personProxy.name = 'haha'; console.log(personProxy.name); // lisi
案例及其简单,就不介绍了。
拦截的本质
proxy
的拦截,并不是“万事万物”都拦截,看MDN上面的定义,是对基本操作的拦截和自定义,那么何为基本操作呢,看下面的例子:
const person = { name: 'yuanwill', say() { console.log('你好呀') } } let personProxy = new Proxy(person, { get(target, key) { console.log('拦截到正在获取属性:' + key); return target[key] }, set(target, key, val) { console.log('拦截到正在修改属性:' + key); target[key] = val; }, apply(target, thisArg, arguments) { console.log('拦截到了正在执行的方法:' + target); return target.call(thisArg, ...arguments) } }) console.log(personProxy.name); // 拦截到正在获取属性:name personProxy.name = 'haha'; // 拦截到正在修改属性:name personProxy.say(); // 拦截到正在获取属性:say
重点在最后一句代码,发现personProxy.say()
并没有走入apply
方法中,原因就在于只拦截基本操作。
那么到底什么是基本操作呢?像上面的personProxy.name
这种属性的读取,personProxy.name = 'haha'
这种属性的赋值就是基本操作,而personProxy.say()
是由两个基本操作(personProxy.say
的读取以及函数的调用)组成的复合操作,我们代理的对象是person
,而不是person.say
,所以,我们只拦截到了person.say
的读取操作。
孪生兄弟Reflect
来看看MDN上的定义:
Reflect 是一个内置的对象,它提供拦截 JavaScript 操作的方法。这些方法与proxy handlers (en-US)的方法相同。Reflect
不是一个函数对象,因此它是不可构造的。
换句话说,Reflet对象的方法和proxy的拦截器(第二个入参handler)的方法完全一致,因此也有13个方法,就不一一列举了。
Reflect的作用也及其简单,可以参考MDN上。
那么,为什么我们需要Reflect呢,来看下面的例子:
const person = { name: 'yuanwill', get firstName() { return this.name; } }; const personProxy = new Proxy(person, { get(target, key) { console.log('拦截到正在获取属性:' + key); return target[key] }, set(target, key, val) { console.log('拦截到正在修改属性:' + key); target[key] = val; } }); console.log(personProxy.firstName); // 拦截到正在获取属性:firstName
按照我们的理解,应该还需要拦截到name
属性,因为我们在firstName
中返回的是name
属性,那么为什么没有拦截到呢?关键在于this
指向问题,personProxy.firstName
会被get
拦截,然后返回target[key]
,这里的target
就是person
,key
就是firstName
,所以这个时候的this.name
就是person.name
,而我们的代理对象是personProxy
,所以访问name
属性就不会被拦截了。
那这个时候,Reflect
就派上用场了:
const personProxy = new Proxy(person, { get(target, key, receiver) { console.log('拦截到正在获取属性:' + key); return Reflect.get(target, key, receiver); }, set(target, key, val, receiver) { console.log('拦截到正在修改属性:' + key); return Reflect.set(target, key, val, receiver); } });
这个时候,就能拦截到了。原因在于,Reflect.get
中的第三个参数receiver
作用就是改变this的指向,MDN描述如下:
如果target对象中指定了getter,receiver则为getter调用时的this值。
仿vue使用
对象的拦截
还是使用上面的对象:
let person = { name: 'yuanwill', age: 26, address: { home: 'guangzhou', now: 'shenzhen' } };
我们很自然就能写出如下代码:
const observer = obj => { // 如果obj不是一个对象,就没必要包装了 if(typeof obj !== 'object' || !obj) { return obj; } const proxyConfig = { get(target, key, receiver) { console.log('拦截到正在获取属性:' + key); return Reflect.get(target, key, receiver) }, set(target, key, val, receiver) { console.log('拦截到正在修改属性:' + key); return Reflect.set(target, key, val, receiver);; } }; const observed = new Proxy(obj, proxyConfig); return observed; }
测试一下:
const personProxy = observer(person); personProxy.name = 'haha'; // 拦截到正在修改属性:name console.log(personProxy.name); // 拦截到正在获取属性:name
当然,也有瑕疵:
personProxy.name = { firstName: 'yuan', lastName: 'will' }; // 拦截到正在修改属性:name personProxy.name.firstName = 'haha'; // 拦截到正在获取属性:name console.log(personProxy.name); // 拦截到正在获取属性:name
可以看到,person.name.firstName
依然没有拦截到正在修改firstName属性。原因在于,get
返回的可能是个对象,我们需要对这个对象再次代理,所以修改如下:
const observer = obj => { // 如果obj不是一个对象,就没必要包装了 if(typeof obj !== 'object' || !obj) { return obj; } const proxyConfig = { get(target, key, receiver) { console.log('拦截到正在获取属性:' + key); const result = Reflect.get(target, key, receiver); return observer(result); }, set(target, key, val, receiver) { console.log('拦截到正在修改属性:' + key); return Reflect.set(target, key, val, receiver);; } }; const observed = new Proxy(obj, proxyConfig); return observed; }
仔细分析上面的代码,我们在get
的时候,才去判断了获取的值是不是一个对象,而Object.defineProperty
是最开始就循环遍历,对每个属性进行代理,所以,这样性能就提升了。同时,我们获取personProxy.address.home
也能拦截到home
属性了(想想就知道为啥了)。
数组的拦截
let list = [1,2,3,4]; let listProxy = observer(list); console.log(listProxy[0]) // 拦截到正在获取属性:0 listProxy[0] = 2; // 拦截到正在修改属性:0 listProxy[6] = 6; // 拦截到正在修改属性:6 /** * 拦截到正在获取属性:push * 拦截到正在获取属性:length * 拦截到正在修改属性:7 * 拦截到正在修改属性:length */ listProxy.push(3);
可以看到,proxy天然的解决了数组的相关问题。
最后
Object.defineProperty
和Proxy
的相关基础就介绍完了,文章只是讲解了比较基础的功能,学无止境,没办法了,慢慢来把~~~
更多关于defineProperty Proxy基础功能的资料请关注阿兔在线工具其它相关文章!