1.概述
Proxy 用于修改某些操作的默认行为,等同于在语言层面做出修改,所以数以一种“元编程”(meta programming),即对编程语言进行编程。
Proxy 可以理解成,在目标对象之前架设一层“拦截”,外界对该对象的访问,都必须先通过这层拦截,因此提供了一种机制,可以对外界的访问进行过滤和改写,Proxy这个词的原意是代理,用在这里表示由它来“代理”某些操作,可以译为“代理器”。
var obj = new Proxy({}, {
get: function (target, propKey, receiver) {
console.log(`getting ${propKey}!`);
return Reflect.get(target, propKey, receiver);
},
set: function (target, propKey, value, receiver) {
console.log(`setting ${propKey}!`);
return Reflect.set(target, propKey, value, receiver);
}
});
上面代码对一个空对象架设了一层拦截,重定义了属性的读取(get)和设置(set)行为。这里暂时先不解释具体的语法,只看运行结果。对设置了拦截行为的对象obj,去读取它的属性,就会得到下面的结果。
obj.count = 1;
// setting count!
++obj.count;
// getting count!
// setting count!
// 2
上面代码说明,Proxy实际上重载(overload)了点运算符,即用自己的定义覆盖了语言的原始定义。
ES6原生提供Proxy构造函数,用来生成Proxy实例。
var proxy = new Proxy(target, handler);
Proxy对象的所有用法,都是上面这种形式,不同的只是handler参数的写法。其中,new Proxy()表示生成一个Proxy实例,target参数表示所要拦截的目标对象,handler参数也是一个对象,用来定义拦截行为。
下面是另一个拦截读取属性行为的例子。
var proxy = new Proxy({}, {
get: function(target, propKey) {
return 35;
}
});
proxy.time // 35
proxy.name // 35
proxy.title // 35
上面代码中,作为构造函数,Proxy接受两个参数,第一个参数是所要代理的目标对象(上例是一个空对象),即如果没有Proxy的介入,操作原来要访问的就是这个对象;第二个参数是一个配置对象,对于每一个被代理的操作,需要提供一个对应的处理函数,该函数将拦截对应的操作。比如。上面代码中,配置对象有一个get方法,用来拦截对目标对象属性的访问请求,get方法的两个参数分别是目标对象和所要访问的属性。可以看到,由于拦截函数总是返回35,所以访问任何属性都得到35。
注意。要使得Proxy起作用,必须针对Proxy实例(上例是proxy对象)进行操作,而不是针对目标对象(上例是空对象)进行操作。
如果handler没有设置任何拦截,那就等同于直接通向原对象。
var target = {};
var handler = {};
var proxy = new Proxy(target, handler);
proxy.a = 'b';
target.a // 'b'
上面代码中,handler是一个空对象,没有任何拦截效果,访问proxy就等同于访问target。
一个技巧是将Proxy对象,设置到object.proxy属性,从而可以在object对象上调用。
var object = { proxy: new Proxy(target, handler) };
Proxy 实例也可以作为其他对象的原型对象。
var proxy = new Porxy({}, {
get: function(target, propKey) {
return 35;
}
});
let obj = Object.create(proxy);
obj.time; // 35
上面代码中,proxy对象是obj对象的原型,obj对象本身并没有time属性,所以根据原型链,会在proxy对象上读取该属性,导致被拦截。
同一个拦截器函数,可以设置拦截多个操作。
var handler = {
get: function(target, name) {
if(name === "prototype") {
return Object.prototype;
}
return 'Hello, ' + name;
},
// 拦截 Proxy 实例作为函数调用的操作
apply: function(target, thisBinding, agrs) {
return args[0];
},
// 拦截 Proxy 实例作为构造函数调用的操作
construct: function(target, args) {
return { value: args[1] };
}
};
var fproxy = new Proxy(function(x, y) {
return x + y;
}, handler);
fproxy(1, 2); // 1
new fproxy(1 , 2); // {value: 2}
fproxy.prototype === Object.prototype // true
fproxy.foo === "Hello, foo" // true
对于可以设置、但没有设置拦截的操作,则直接落在目标对象上,按照原先的方式产生结果。 下面是Proxy支持的拦截操作一览,一共13种
- get(target,propKey,receiver):拦截对象属性的读取,比如
proxy.foo和`proxy['foo']。 - set(target,propKey,value,receiver):拦截对象属性的设置,比如
proxy.foo = v或者proxy['foo'] = v,返回一个布尔值 - has(target,propKey):拦截
propKey in porxy的操作,返回一个布尔值。 - deleteProperty(target, propKey):拦截
delete proxy[propKey]的操作,返回一个布尔值。 - ownKeys(target):拦截
Object.getOwnPropertyNames(proxy)、Object.getOwnPropertySymbols(proxy)、Object.keys(proxy)、for...in循环,返回一个数组。该方法返回目标对象所有自身的属性的属性名,而Object.keys()的返回结果仅包括目标对象自身的可遍历属性。 - getOwnPropertyDescriptor(target,propKey):拦截
Object.getOwnProertyDescriptor(proxy,propKey),返回属性的描述对象。 - definedProperty(target,propKey,propDesc):拦截
Object.defineProperty(prop, propKey, propDesc)、`Object.defineProperties(proxy,propDescs),返回一个布尔值。 - preventExtensions(target):拦截
Object.preventExtendsions(proxy),返回一个布尔值。 - getPrototypeOf(target):拦截
Object.getPrototypeOf(proxy),返回一个对象 - isExtensible(target):拦截
Object.isExtensible(proxy),返回一个布尔值 - setPrototypeOf(target, proto):拦截
Object.setPrototypeOf(proxy,proto),返回一个布尔值,如果目标对象是函数,那么还有两种额外操作可以拦截。 - apply(target,object,args):拦截Proxy实例作为函数调用的操作,比如
proxy(..args)、proxy.call(object, ...args)、proxy.apply(...)。 - construct(target, args):拦截Proxy实例作为构造函数调用的操作,比如
new proxy(...args)
2.Proxy 实例的方法
下面是上面这些拦截方法的详细介绍。
get()
get方法用于拦截某个属性的读取操作,可以接受三个参数,依次为目标对象,属性名和proxy实例本身(严格地说,是操作行为所针对的对象),其中最后一个参数可选,
get方法的用法,上文已经有一个例子,下面是另一个拦截读取操作的例子。
var person = {
name: '张三'
};
var proxy = new Proxy(person, {
get: function(target, propKey) {
if(propKey in target) {
return target[propKey];
} else {
throw new ReferenceError("Prop name \ "" + propKey + "\" does not exist.")
}
}
});
proxy.name // "张三"
proxy.age // 抛出一个错误
上面代码表示,如果访问目标对象不存在的属性,会抛出一个错误。如果没有这个拦截函数,访问不存在的属性,只会返回undefnined。
get方法可以继承。
let proto = new Proxy({}, {
get(target, propertyKey, receiver) {
console.log('GET' + propertyKey);
return target[propertyKey];
}
});
let obj = Object.create(proto);
obj.foo // "GET foo"
上面代码中,拦截操作定义在Prototype对象上面,所以如果读取obj对象继承的属性时,拦截会生效。
下面的例子使用get拦截。实现数组读取负数的索引。
function createArray(...elements) {
let handler = {
get(target, propKey, receiver) {
let index = Number(propKey);
if(index < 0) {
propKey = String(target.length + index);
}
return Reflect.get(target, propKey, receiver);;
}
};
let target = [];
target.push(...elements);
return new Proxy(target, handler);
}
let arr = createArray('a','b','c');
arr[-1] // c
上面代码中,数组的位置参数是-1,就会输出数组的倒数第一个成员。
利用Proxy,可以将读取属性的操作(get),转变为执行某个函数,从而实现属性的链式操作。
var pipe = function(value){
var funcStack = [];
var oproxy = new Proxy({}, {
get : function(pipeObject, fnName) {
if(fnName === 'get'){
return funcStack.reduce(function(val,fn){
return fn(val);
},value);
}
funcStack.push(window[fnName]);
return oproxy;
}
});
return oproxy;
}
var double = n => n * 2;
var pow = n => n * n;
var reverseInt = n => n.toString().spilt("").reverse().join("") | 0;
pipe(3).double.pow.reverseInt.get; // 63
上面代码设置Proxy以后,达到了将函数名链式使用的效果。
下面的例子则是利用get拦截,实现一个生成各种DOM节点的通用函数dom。
const dom = new Proxy({}, {
get(target, property) {
return function(attrs = {}, ...children) {
const el = document.createElement(property);
for(let prop of Object.keys(attrs)) {
el.setAttribute(prop, attrs[prop]);
}
for(let child of children){
if(typeof child === 'string') {
child = document.createTextNode(child);
}
el.appendChild(child);
}
return el;
}
}
});
const el = dom.div({},
'Hello, my name is',
dom.a({href: '//example.com'}, 'Mark'),
'. I like:',
dom.ul({},
dom.li({}, 'The web'),
dom.li({}, 'Food'),
dom.li({}, '...actually that\'s it')
)
);
document.body.appendChild(el);
下面是一个get方法的第三个参数的例子,它总是指向原始的读操作所在的那个对象,一般i情况下就是proxy实例。
const proxy = new Proxy({}, {
get: function(target, key, receiver) {
return receiver;
}
});
proxy.getReceiver === proxy // true
上面代码中,proxy对象的getReceiver属性是由proxy对象提供的,所以receiver指向proxy对象。
const proxy = new Proxy({}, {
get:function(target, key, receiver) {
return receiver;
}
});
const d = Object.create(proxy);
d.a === d // true
上面代码中,d对象本身没有a属性,所以读取d.a的时候,会去d的原型proxy对象找,这时,receiver就指向d,代表原始的读操作所在的那个对象。
如果一个属性不可配置(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实例本身,其中最后一个参数可选。
假定Person对象有一个age属性,该属性应该是一个不大于200的整数,那么可以使用Proxy保证age的属性值符合要求。
let validator = {
set: function(obj, prop, value) {
if(prop === 'age') {
if(!Number.isInteger(value)) {
throw new TypeError('The age is not an integer');
}
if(value > 200){
thorw new RangeError('The age seems invalid');
}
}
// 对于满足条件的age属性以及其他属性,直接保存
obj[prop] = value;
return true;
}
};
let person = new Proxy({}, validator);
person.age = 100;
person.age // 100;
person.age = 'young' // 报错
person.age = 300 // 报错
上面代码中,由于设置了存值函数set,任何不符合要求的age属性赋值,都会抛出一个错误,这是数据验证的一种实现方法。利用set方法,还可以数据绑定,即每当对象发生变化时,会自动更新DOM。
有时,我们会在对象上设置内部属性,属性名的第一个字符使用下划线开头,表示这些属性不应该被外部使用。结合get和set方法,就可以做到防止这些内部属性被外部读写。
const handler = {
get (target, key) {
invariant(key, 'get');
return target[key];
},
set (target, key, value) {
invariant(key, 'set');
target[key] = value;
return true;
}
};
function invariant (key, action) {
if(key[0] === '_') {
throw new Error(`Invalid attempt to ${action} private "${key}" property`)
}
}
const target = {};
const proxy = new Proxy(target,handler);
proxy._prop
// Error: Invalid attempt to get private "_prop" property
proxy._prop = 'c'
// Error: Invalid attempt to set private "_prop" property
上面代码中,只要读写的属性名的第一个字符是下划线,一律抛错,从而达到禁止读写内部属性的目的。
下面是set方法第四个参数的例子。
const handler = {
set: function(obj, prop, value, receiver) {
obj[prop] = receiver;
return ture;
}
};
const proxy = new Proxy({}, handler);
proxy.foo = 'bar';
proxy.foo === proxy; // true
上面代码中,set方法的第四个参数receiver,指的是原始的操作行为所在的那个对象,一般情况下是proxy实例本身,请看下面的例子。
const handler = {
set: function(obj, prop, value, receiver){
obj[prop] = receiver;
return true;
}
};
const proxy = new Proxy({}, handler);
const myObj = {};
// # 对象设置原型链
Object.setPrototypeOf(myObj,proxy);
myObj.foo = 'bar';
myObj.foo === myObj // true
上面代码中,设置myObj.foo属性的值时,myObj并没有foo属性,因此引擎会到myObj的原型链去找foo属性。myObj的原型对象proxy是一个Proxy实例,设置它的foo属性会触发set方法。这时,第四个参数receiver就指向原始赋值行为所在的对象myObj。
注意,如果目标对象自身的某个属性不可写,那么set方法将不起作用。
const obj = {};
Object.definedPropetry(obj, 'foo', {
value:'bar',
writable: false
});
const handler = {
set: function(obj, prop, value, receiver) {
obj[prop] = 'baz';
return true;
}
};
const proxy = new Proxy(obj, handler);
proxy.foo = 'baz';
proxy.foo // 'bar';
上面代码中,obj.foo属性不可写,Proxy对这个属性的set代理将不会生效。
注意,set代理应当返回一个布尔值,严格模式下,set代理如果没有返回true,就会报错。
'use strict';
const hanlder = {
set: function(obj, prop, value, recriver) {
obj[prop] = recriver;
// 无论有没有下面这行,都会报错
return false;
}
};
const proxy = new Proxy({}, handler);
proxy.foo = 'bar'
// TypeError:'set' on proxy:trap returned falsish for property 'foo'
上面代码中,严格模式下,set代理返回false或者undefined,都会报错
总结
- Proxy 可以理解成,在目标对象之前架设一层“拦截”,外界对该对象的访问,都必须先通过这层拦截,因此提供了一种机制,可以对外界的访问进行过滤和改写,Proxy这个词的原意是代理,用在这里表示由它来“代理”某些操作,可以译为“代理器”。
get方法用于拦截某个属性的读取操作,可以接受三个参数,依次为目标对象,属性名和proxy实例本身(严格地说,是操作行为所针对的对象),其中最后一个参数可选set方法用来拦截某个属性的赋值操作,可以接受四个参数,依次为目标对象,属性名,属性值和Proxy实例本身,其中最后一个参数可选。