Proxy可以理解成,在目标对象之前架设一层拦截,外界对该对象的访问,都必须先通过这层拦截,因此提供了一种机制,可以对外界的访问进行过滤和改写。
Proxy的原意是代理,用在这里表示由它来代理某些操作,可以译为代理器。
ES6原生提供了Proxy构造函数,用来生成Proxy实例。var proxy = new Proxy(target, handler);
。new Proxy()表示生成一个Proxy实例;target参数表示所要拦截的目标对象;handler参数是一个配置对象,用来定制拦截行为,对于每一个被代理的操作,需要提供一个对应的处理函数,该函数将拦截对应的操作。
var target = {};
var handler = {
get: function(target, propKey) {
return 35;
}
}
var proxy = new Proxy(target,handler);
proxy.time // 35
proxy.title // 35
要使得Proxy起作用,必须针对proxy实例进行操作,而不是针对目标对象进行操作。
var target = {};
var handler = {
get: function(target, propKey) {
return 35;
}
}
var proxy = new Proxy(target,handler);
target.time // undefined
proxy.time // 35
如果handler是一个空对象,没有设置任何拦截,那就等同于直接通向源对象,访问proxy就等同于访问target。
var target = {};
var handler = {};
var proxy = new Proxy(target,handler);
proxy.a = 'b';
target.a // "b"
Proxy.revocable():
Proxy.revocable()方法返回一个可取消的Proxy实例。该方法返回一个对象,该对象的proxy属性是proxy实例,revoke属性是一个函数,可以取消Proxy实例。
let target = {};
let handler = {};
let {proxy, revoke} = Proxy.revocable(target, handler);
proxy.foo = 123;
proxy.foo // 123
revoke();
proxy.foo // TypeError: Revoked
Proxy.revocable()的一个使用场景是,目标对象不允许直接访问,必须通过代理访问,一旦访问结束,就收回代理权,不允许再次访问。
this问题:
虽然Proxy可以代理针对目标对象的访问,但它不是目标对象的透明代理,即不做任何拦截的情况下,也无法保证与目标对象的行为一致。
主要原因就是在Proxy代理的情况下,目标对象内部的this关键字会指向Proxy代理。
const target = {
m: function () {
console.log(this === proxy);
}
};
const handler = {};
const proxy = new Proxy(target, handler);
target.m() // false
proxy.m() // true
上面代码中,一旦proxy代理target.m,后者内部的this就是指向proxy而不是tarhet。
Proxy实例的方法:
get():
get()方法用于拦截某个属性的读取操作,可以接受三个参数,依次为目标对象,属性名和proxy实例,其中最后一个参数可选。
var person = {
name:'Lee'
}
var proxy = new Proxy(person,{
get:fucntion(target,propKey,receiver){
if(propKey in target){
return target[propKey];
}else{
throw new ReferenceError("Prop name \"" + propKey + "\" does not exist.");
}
}
})
proxy.name //Lee
proxy.age //抛出一个错误
如果一个属性不可配置(configurable)且不可写(writable),则Proxy不能修改该属性,否则通过Proxy对象访问该属性会报错。
const target = Object.defineProperties({}, {
foo: {
value: 123,
writable: false,
configurable: false
},
});
const handler = {
get(target, propKey) {
return 'abc';
}
};
const proxy = new Proxy(target, handler);
proxy.foo
// TypeError: Invariant check failed
set():
set()方法用来拦截某个属性的赋值操作,可以接受四个参数,依次为目标对象、属性名、属性值和Proxy实例本身,其中最后一个参数可选。
let validator = {
set:function(obj,prop,value){
if(prop === 'age'){
if(!Number.isInteger(value)){
throw new TypeErrow('The age is not an integer');
}
}
obj[prop] = value;
}
}
let proxy = new Proxy({},validator);
proxy.age = 200;
proxy.age //200
proxy.age = 'young'; // 报错
如果目标对象自身的某个属性,不可写且不可配置,那么set方法将不起作用。
const obj = {};
Object.defineProperty(obj, 'foo', {
value: 'bar',
writable: false,
});
const handler = {
set: function(obj, prop, value, receiver) {
obj[prop] = 'baz';
}
};
const proxy = new Proxy(obj, handler);
proxy.foo = 'baz';
proxy.foo // "bar"
上面代码中,obj.foo属性不可写,Proxy对这个属性的set代理将不会生效。
deleteProperty():
deleteProperty()方法用于拦截delete操作,如果这个方法抛出错误或者返回false,当前属性就无法被delete命令删除。
var handler = {
deleteProperty (target, key) {
delete target[key];
return true;
}
};
var target = { prop: 'foo' };
var proxy = new Proxy(target, handler);
delete proxy.prop
目标对象自身的不可配置属性,不能被deleteProperty方法删除,否则报错。
has():
has()方法用来拦截HasProperty操作,即判断对象是否具有某个属性时,这个方法会生效。典型的操作就是in运算符。可以接受两个参数,分别是目标对象、需查询的属性名。
has()方法拦截的是HasProperty操作,而不是HasOwnProoerty操作,即has方法不判断一个属性是对象自身的属性,还是继承的属性。
has拦截对for…in循环不生效。
//使用has方法隐藏某些属性,不被in运算符发现
var handler = {
has (target, key) {
if (key[0] === '_') {
return false;
}
return key in target;
}
};
var target = { _prop: 'foo', prop: 'foo' };
var proxy = new Proxy(target, handler);
'_prop' in proxy // false
如果原对象不可配置或禁止扩展,这时has拦截会报错。
var obj = { a: 10 };
Object.preventExtensions(obj);
var p = new Proxy(obj, {
has: function(target, prop) {
return false;
}
});
'a' in p // TypeError is thrown
apply():
apply()方法拦截函数的调用、call和apply操作。可以接受三个参数,分别是目标对象、目标对象的上下文对象this和目标对象的参数数组。
var target = function () { return 'I am the target'; };
var handler = {
apply: function () {
return 'I am the proxy';
}
};
var p = new Proxy(target, handler);
p()
// "I am the proxy"
上面代码中,变量p是Proxy的实例,当它作为函数调用时(p()),就会被apply方法拦截,返回一个字符串。
construct():
construct()方法用于拦截new命令,可以接受三个参数,分别是target目标对象、args构造函数的参数对象和newTarget创造实例对象时,new命令作用的构造函数。
var proxy = new Proxy(function () {}, {
construct: function(target, args) {
return { value: args[0] * 10 };
}
});
(new proxy(1)).value
// 10
construct()方法返回的是必须是一个对象,否则会报错。
var p = new Proxy(function() {}, {
construct: function(target, argumentsList) {
return 1;
}
});
new p() // 报错
// Uncaught TypeError: 'construct' on proxy: trap returned non-object ('1')
ownKeys():
ownKeys()方法用来拦截对象自身属性的读取操作。
具体来说,拦截以下操作:
- Object.getOwnPropertyNames()
- Objetc.getOwnPropertySymbols()
- Objetc.keys()
- for…in循环
let target = {
a: 1,
b: 2,
c: 3
};
let handler = {
ownKeys(target) {
return ['a'];
}
};
let proxy = new Proxy(target, handler);
Object.keys(proxy)
// [ 'a' ]
ownKeys()方法返回的数组成员,只能是字符串或Symbol值。如果有其他类型的值,或者返回的根本不是数组,就会报错。
var obj = {};
var p = new Proxy(obj, {
ownKeys: function(target) {
return [123, true, undefined, null, {}, []];
}
});
Object.getOwnPropertyNames(p)
// Uncaught TypeError: 123 is not a valid property name
如果目标对象自身包含不可配置的属性,则该属性必须被ownKeys()方法返回,否则报错。
var obj = {};
Object.defineProperty(obj, 'a', {
configurable: false,
enumerable: true,
value: 10 }
);
var p = new Proxy(obj, {
ownKeys: function(target) {
return ['b'];
}
});
Object.getOwnPropertyNames(p)
// Uncaught TypeError: 'ownKeys' on proxy: trap result did not include 'a'
如果目标对象是不可扩展的,这时ownKeys()方法返回的数组之中,必须包含原对象的所有属性,且不能包含多余的属性,否则报错。
var obj = {
a: 1
};
Object.preventExtensions(obj);
var p = new Proxy(obj, {
ownKeys: function(target) {
return ['a', 'b'];
}
});
Object.getOwnPropertyNames(p)
// Uncaught TypeError: 'ownKeys' on proxy: trap returned extra keys but proxy target is non-extensible
defineProperty():
defineProperty()方法拦截了Object.defineProperty()操作。
Object.defineProperty() 方法会直接在一个对象上定义一个新属性,或者修改一个对象的现有属性,并返回此对象。
const object1 = {}; Object.defineProperty(object1, 'property1', { value: 42, writable: false });
var handler = {
defineProperty (target, key, descriptor) {
return false;
}
};
var target = {};
var proxy = new Proxy(target, handler);
proxy.foo = 'bar' // 不会生效
如果目标对象不可扩展(non-extensible),则defineProperty()不能增加目标对象上不存在的属性,否则会报错。
如果目标对象的某个属性不可写(writable)或不可配置(configurable),则defineProperty()方法不得改变这两个设置。
getOwnPropertydescriptor():
getOwnPropertydescriptor()方法拦截Object.getOwnPropertydescriptor(),返回一个属性描述对象或者undefined。
var handler = {
getOwnPropertyDescriptor (target, key) {
if (key[0] === '_') {
return;
}
return Object.getOwnPropertyDescriptor(target, key);
}
};
var target = { _foo: 'bar', baz: 'tar' };
var proxy = new Proxy(target, handler);
Object.getOwnPropertyDescriptor(proxy, 'wat')
// undefined
Object.getOwnPropertyDescriptor(proxy, '_foo')
// undefined
Object.getOwnPropertyDescriptor(proxy, 'baz')
// { value: 'tar', writable: true, enumerable: true, configurable: true }
getPropertyOf():
getPropertyOf()方法主要用来拦截获取对象原型。getPropertyOf()方法的返回值必须是对象或者null,否则报错。
具体来说,拦截下面这些操作:
- Objetc.property.proto
- Objetc.property.isPropertyOf()
- Objetc.getPropertyOf()
- Reflect.getPropertyOf()
- instanceof
var proto = {};
var p = new Proxy({}, {
getPrototypeOf(target) {
return proto;
}
});
Object.getPrototypeOf(p) === proto // true
如果目标对象不可扩展,getPropertyOf()必须返回目标对象的原型对象。
setPropertyOf():
setPropertyOf()方法主要用来拦截Object.setPropertyOf()方法。该方法只能返回布尔值,否则会被自动转为布尔值。
Object.setPropertyOf():将一个指定的对象的原型设置为另一个对象或者null。
var handler = {
setPrototypeOf (target, proto) {
throw new Error('Changing the prototype is forbidden');
}
};
var proto = {};
var target = function () {};
var proxy = new Proxy(target, handler);
Object.setPrototypeOf(proxy, proto);
// Error: Changing the prototype is forbidden
如果目标对象不可扩展,setPropertyOf()方法不得改变目标对象的原型。
isExtensible():
isExtensible()方法拦截Object.isExtensible()操作。该方法只能返回布尔值,否则返回值会被自动转为布尔值。
var p = new Proxy({}, {
isExtensible: function(target) {
return true;
}
});
Object.isExtensible(p)
// true
这个isExtensible()方法有一个强限制,它的返回值必须与目标对象的isExtensible属性保持一致,否则就会抛出错误。
var p = new Proxy({}, {
isExtensible: function(target) {
return false;
}
});
Object.isExtensible(p)
// Uncaught TypeError: 'isExtensible' on proxy: trap result does not reflect extensibility of proxy target (which is 'true')
preventExtensions():
preventExtensions()方法拦截Object.preventExtensions()。该方法必须返回一个布尔值,否则会被自动转为布尔值。
这个方法有一个限制,只有目标对象不可扩展,即Object.isExtensible(proxy)为false时,proxy.preventExtensions才能返回true,否则会报错。
var proxy = new Proxy({}, {
preventExtensions: function(target) {
return true;
}
});
Object.preventExtensions(proxy)
// Uncaught TypeError: 'preventExtensions' on proxy: trap returned truish but the proxy target is extensible
上面代码中,proxy.preventExtensions()方法返回true,但这时Object.isExtensible(proxy)会返回true,因此报错。
为了防止出现这个问题,通常要在proxy.preventExtensions()方法里面,调用一次Objetc.preventExtensions()。
var proxy = new Proxy({}, {
preventExtensions: function(target) {
Object.preventExtensions(target);
return true;
}
});
Object.preventExtensions(proxy)
// Proxy {}