Proxy-Reflect详解
监听对象的操作
我们先来看一个需求:有一个对象,我们希望监听这个对象中的属性被设置或获取的过程
- 通过我们前面所学的知识,能不能做到这一点呢?
- 其实是可以的,我们可以通过之前的属性描述符中的存储属性描述符来做到;
这段代码就利用了前面讲过的 Object.defineProperty 的存储属性描述符来 对属性的操作进行监听。
const obj = {
name: "why",
age: 18,
height: 1.88
}
// 2.监听所有的属性: 遍历所有的属性, 对每一个属性使用defineProperty
const keys = Object.keys(obj)
for (const key of keys) {
let value = obj[key]
Object.defineProperty(obj, key, {
set: function(newValue) {
console.log(`监听: 给${key}设置了新的值:`, newValue)
value = newValue
},
get: function() {
console.log(`监听: 获取${key}的值`)
return value
}
})
}
// console.log(obj.name)
// obj.name = "kobe"
console.log(obj.age)
obj.age = 17
console.log(obj.age)
- 但是这样做有什么缺点呢?
- 首先,Object.defineProperty设计的初衷,不是为了去监听截止一个对象中 所有的属性的。
- 我们在定义某些属性的时候,初衷其实是定义普通的属性,但是后面我们强 行将它变成了数据属性描述符。
- 其次,如果我们想监听更加丰富的操作,比如新增属性、删除属性,那么 Object.defineProperty是无能为力的。
- 所以我们要知道,存储数据描述符设计的初衷并不是为了去监听一个完整的对象。
Proxy基本使用
在ES6中,新增了一个Proxy类,这个类从名字就可以看出来,是用于帮助我们创建一个代理的:
- 也就是说,如果我们希望监听一个对象的相关操作,那么我们可以先创建一个代理对象(Proxy对象);
- 之后对该对象的所有操作,都通过代理对象来完成,代理对象可以监听我们想要对原对象进行哪些操作;
我们可以将上面的案例用Proxy来实现一次:
首先,我们需要
new Proxy
对象,并且传入需要侦听的对象以及一个处理对象,可以称之为handler
;const p = new Proxy(target, handler)
其次,我们之后的操作都是直接对
Proxy
的操作,而不是原有的对象,因为我们需要在handler
里面进行侦听;
Proxy的set和get捕获器
- 如果我们想要侦听某些具体的操作,那么就可以在handler中添加对应的捕捉器(Trap):
- set和get分别对应的是函数类型;
- set函数有四个参数:
- target:目标对象(侦听的对象);
- property:将被设置的属性key;
- value:新属性值;
- receiver:调用的代理对象;
- get函数有三个参数:
- target:目标对象(侦听的对象);
- property:被获取的属性key;
- receiver:调用的代理对象;
const obj = {
name: "why",
age: 18,
height: 1.88
}
// 1.创建一个Proxy对象
const objProxy = new Proxy(obj, {
set: function(target, key, newValue) {
console.log(`监听: 监听${key}的设置值: `, newValue)
target[key] = newValue
},
get: function(target, key) {
console.log(`监听: 监听${key}的获取`)
return target[key]
}
})
// 2.对obj的所有操作, 应该去操作objProxy
// console.log(objProxy.name)
// objProxy.name = "kobe"
// console.log(objProxy.name)
// objProxy.name = "james"
objProxy.address = "广州市"
console.log(objProxy.address)
Proxy所有捕获器
13个活捉器分别是做什么的呢?
handler.getPrototypeOf()
- Object.getPrototypeOf 方法的捕捉器。
handler.setPrototypeOf()
- Object.setPrototypeOf 方法的捕捉器。
handler.isExtensible()
- Object.isExtensible 方法的捕捉器(判断是否可以新增属性
handler.preventExtensions()
- Object.preventExtensions 方法的捕捉器。
handler.getOwnPropertyDescriptor()
- Object.getOwnPropertyDescriptor 方法的捕捉器。
handler.ownKeys()
- Object.getOwnPropertyNames 方法和 Object.getOwnPropertySymbols 方法的捕捉器。
handler.has()
- in 操作符的捕捉器。
handler.get()
- 属性读取操作的捕捉器。
handler.set()
- 属性设置操作的捕捉器。
handler.deleteProperty()
- delete 操作符的捕捉器。
handler.apply()
- 函数调用操作的捕捉器。
handler.defineProperty()
- Object.defineProperty方法的捕捉器。
handler.construct()
- new 操作符的捕捉器。
const obj = {
name: "why",
age: 18,
height: 1.88
}
// 1.创建一个Proxy对象
const objProxy = new Proxy(obj, {
set: function(target, key, newValue) {
console.log(`监听: 监听${key}的设置值: `, newValue)
target[key] = newValue
},
get: function(target, key) {
console.log(`监听: 监听${key}的获取`)
return target[key]
},
deleteProperty: function(target, key) {
console.log(`监听: 监听删除${key}属性`)
delete obj.name
},
has: function(target, key) {
console.log(`监听: 监听in判断 ${key}属性`)
return key in target
}
})
delete objProxy.name
console.log("age" in objProxy)
Proxy的construct和apply
- 当然,我们还会看到捕捉器中还有construct和apply,它们是应用于函数对象的:
function foo(num1, num2) {
console.log(this, num1, num2)
}
const fooProxy = new Proxy(foo, {
apply: function(target, thisArg, otherArgs) {
console.log("监听执行了apply操作")
target.apply(thisArg, otherArgs)
},
construct: function(target, otherArray) {
console.log("监听执行了new操作")
console.log(target, otherArray)
return new target(...otherArray)
}
})
// fooProxy.apply("abc", [111, 222])
new fooProxy("aaa", "bbb")
Reflect的作用
Reflect也是ES6新增的一个API,它是一个对象,字面的意思是反射。
那么这个Reflect有什么用呢?
- 它主要提供了很多操作JavaScript对象的方法,有点像Object中操作对象的方法;
- 比如Reflect.getPrototypeOf(target)类似于 Object.getPrototypeOf();
- 比如Reflect.defineProperty(target, propertyKey, attributes)类似于Object.defineProperty() ;
如果我们有Object可以做这些操作,那么为什么还需要有Reflect这样的新增对象呢?
- 这是因为在早期的ECMA规范中没有考虑到这种对 对象本身 的操作如何设计会更加规范,所以将这些API放到了Object上面;
- 但是Object作为一个构造函数,这些操作实际上放到它身上并不合适;
- 另外还包含一些类似于 in、delete操作符,让JS看起来是会有一些奇怪的;
- 所以在ES6中新增了Reflect,让我们这些操作都集中到了Reflect对象上;
- 另外在使用Proxy时,可以做到不操作原对象;
那么Object和Reflect对象之间的API关系,可以参考MDN文档:
优点之一:Reflect的函数比Object的一些函数更好用,比如能够返回是否操作成功。
const obj = {
name: "why",
age: 18
}
Object.defineProperty(obj, "name", {
configurable: false
})
// Reflect.defineProperty()
// 1.用以前的方式进行操作
// delete obj.name
// if (obj.name) {
// console.log("name没有删除成功")
// } else {
// console.log("name删除成功")
// }
// 2.Reflect
if (Reflect.deleteProperty(obj, "name")) {
console.log("name删除成功")
} else {
console.log("name没有删除成功")
}
- 优点之二:Reflect一般和Proxy一起使用,在代码逻辑层面,可以做到真正不操作原对象。
const obj = {
name: "why",
age: 18
}
const objProxy = new Proxy(obj, {
set: function(target, key, newValue, receiver) {
// target[key] = newValue
// 1.好处一: 代理对象的目的: 不再直接操作原对象
// 2.好处二: Reflect.set方法有返回Boolean值, 可以判断本次操作是否成功
const isSuccess = Reflect.set(target, key, newValue)
if (!isSuccess) {
throw new Error(`set ${key} failure`)
}
},
get: function(target, key, receiver) {
}
})
// 操作代理对象
objProxy.name = "kobe"
console.log(obj)
Reflect的常见方法
Reflect中有哪些常见的方法呢?它和Proxy是一一对应的,也是13个:
Reflect.ownKeys(target)
返回一个包含所有自身属性(不包含继承属性)的数组。(类似于Object.keys(), 但不会受enumerable影响).
Reflect.getPrototypeOf(target)
- 类似于 Object.getPrototypeOf()。
Reflect.has(target, propertyKey)
- 判断一个对象是否存在某个属性,和 in 运算符 的功能完全相同。
Reflect.setPrototypeOf(target, prototype)
- 设置对象原型的函数. 返回一个 Boolean, 如果更新成功,则返回true。
Reflect.get(target, propertyKey[, receiver])
- 获取对象身上某个属性的值,类似于 target[name]。
Reflect.isExtensible(target)
- 类似于 Object.isExtensible()
Reflect.set(target, propertyKey, value[, receiver])
- 将值分配给属性的函数。返回一个Boolean,如果更新成功,则返回true。
Reflect.preventExtensions(target)
- 类似于 Object.preventExtensions()。返回一个Boolean。
Reflect.deleteProperty(target, propertyKey)
- 作为函数的delete操作符,相当于执行 delete target[name]。
Reflect.getOwnPropertyDescriptor(target, propertyKey)
- 类似于 Object.getOwnPropertyDescriptor()。如果对象中存在该属性,则返回对应的属性描述符, 否则返回 undefined.
Reflect.apply(target, thisArgument, argumentsList)
- 对一个函数进行调用操作,同时可以传入一个数组作为调用参数。和 Function.prototype.apply() 功能类似。
Reflect.defineProperty(target, propertyKey, attributes)
- 和 Object.defineProperty() 类似。如果设置成功就会返回 true
Reflect.construct(target, argumentsList[, newTarget])
- 对构造函数进行 new 操作,相当于执行 new target(...args)。
那么我们可以将之前Proxy案例中对原对象的操作,都修改为Reflect来操作:
Receiver的作用
我们发现在使用getter、setter的时候有一个receiver的参数,它的作用是什么呢?
- 如果我们的源对象(obj)有setter、getter的访问器属性,那么可以通过receiver来改变里面的this;
- 不改变this指向时,set,get操作的是原对象,不会触发proxy的捕获器
- 改变this指向时,set,get操作的是proxy对象,会触发Proxy的捕获器
我们来看这样的一个对象:
const obj = {
_name: "why",
set name(newValue) {
console.log("this:", this) // 默认是obj
this._name = newValue
},
get name() {
return this._name
}
}
// obj.name = "aaaa"
// console.log(obj.name)
// obj.name = "kobe"
const objProxy = new Proxy(obj, {
set: function(target, key, newValue, receiver) {
// target[key] = newValue
// 1.好处一: 代理对象的目的: 不再直接操作原对象
// 2.好处二: Reflect.set方法有返回Boolean值, 可以判断本次操作是否成功
/*
3.好处三:
> receiver就是外层Proxy对象
> Reflect.set/get最后一个参数, 可以决定对象访问器setter/getter的this指向
*/
console.log("proxy中设置方法被调用")
const isSuccess = Reflect.set(target, key, newValue, receiver)
if (!isSuccess) {
throw new Error(`set ${key} failure`)
}
},
get: function(target, key, receiver) {
console.log("proxy中获取方法被调用")
return Reflect.get(target, key, receiver)
}
})
// 操作代理对象
objProxy.name = "kobe"
console.log(objProxy.name)
Reflect的construct
function Person(name, age) {
this.name = name
this.age = age
}
function Student(name, age) {
// Person.call(this, name, age)
const _this = Reflect.construct(Person, [name, age], Student)
return _this
}
// const stu = new Student("why", 18)
const stu = new Student("why", 18)
console.log(stu)
console.log(stu.__proto__ === Student.prototype)