proxy用于修改某些操作的默认行为,等同于在语言层面做出修改,所以属于一种“元编程”(meta programming),即对编程语言进行编程。
proxy可以理解成,在目标对象之前架设一层“拦截”,外界对该对象的访问,都必须先通过这层拦截,因此提供了一种机制,可以对外界的访问进行过滤和改写。proxy这个词的原意是代理,用在这里表示由它来“代理”某些操作,可以译为“代理器”。
var obj = new proxy({}, {
get: function (target, key, receiver) {
console.log(`getting ${key}!`);
return reflect.get(target, key, receiver);
},
set: function (target, key, value, receiver) {
console.log(`setting ${key}!`);
return reflect.set(target, key, 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, property) {
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
是一个空对象,没有任何拦截效果,访问handeler
就等同于访问target
。
一个技巧是将proxy对象,设置到object.proxy
属性,从而可以在object
对象上调用。
var object = { proxy: new proxy(target, handler) };
proxy实例也可以作为其他对象的原型对象。
var proxy = new proxy({}, {
get: function(target, property) {
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;
},
apply: function(target, thisbinding, args) {
return args[0];
},
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"
下面是proxy支持的拦截操作一览。
对于可以设置、但没有设置拦截的操作,则直接落在目标对象上,按照原先的方式产生结果。
(1)get(target, propkey, receiver)
拦截对象属性的读取,比如proxy.foo
和proxy['foo']
。
最后一个参数receiver
是一个对象,可选,参见下面reflect.get
的部分。
(2)set(target, propkey, value, receiver)
拦截对象属性的设置,比如proxy.foo = v
或proxy['foo'] = v
,返回一个布尔值。
(3)has(target, propkey)
拦截propkey in proxy
的操作,以及对象的hasownproperty
方法,返回一个布尔值。
(4)deleteproperty(target, propkey)
拦截delete proxy[propkey]
的操作,返回一个布尔值。
(5)ownkeys(target)
拦截object.getownpropertynames(proxy)
、object.getownpropertysymbols(proxy)
、object.keys(proxy)
,返回一个数组。该方法返回对象所有自身的属性,而object.keys()
仅返回对象可遍历的属性。
(6)getownpropertydescriptor(target, propkey)
拦截object.getownpropertydescriptor(proxy, propkey)
,返回属性的描述对象。
(7)defineproperty(target, propkey, propdesc)
拦截object.defineproperty(proxy, propkey, propdesc)
、object.defineproperties(proxy, propdescs)
,返回一个布尔值。
(8)preventextensions(target)
拦截object.preventextensions(proxy)
,返回一个布尔值。
(9)getprototypeof(target)
拦截object.getprototypeof(proxy)
,返回一个对象。
(10)isextensible(target)
拦截object.isextensible(proxy)
,返回一个布尔值。
(11)setprototypeof(target, proto)
拦截object.setprototypeof(proxy, proto)
,返回一个布尔值。
如果目标对象是函数,那么还有两种额外操作可以拦截。
(12)apply(target, object, args)
拦截proxy实例作为函数调用的操作,比如proxy(...args)
、proxy.call(object, ...args)
、proxy.apply(...)
。
(13)construct(target, args)
拦截proxy实例作为构造函数调用的操作,比如new proxy(...args)
。
下面是上面这些拦截方法的详细介绍。
get
方法用于拦截某个属性的读取操作。上文已经有一个例子,下面是另一个拦截读取操作的例子。
var person = {
name: "张三"
};
var proxy = new proxy(person, {
get: function(target, property) {
if (property in target) {
return target[property];
} else {
throw new referenceerror("property \"" + property + "\" does not exist.");
}
}
});
proxy.name // "张三"
proxy.age // 抛出一个错误
上面代码表示,如果访问目标对象不存在的属性,会抛出一个错误。如果没有这个拦截函数,访问不存在的属性,只会返回undefined
。
get
方法可以继承。
let proto = new proxy({}, {
get(target, propertykey, receiver) {
console.log('get '+propertykey);
return target[propertykey];
}
});
let obj = object.create(proto);
obj.xxx // "get xxx"
上面代码中,拦截操作定义在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 () {
return 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().split("").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);
set
方法用来拦截某个属性的赋值操作。
假定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) {
throw new rangeerror('the age seems invalid');
}
}
// 对于age以外的属性,直接保存
obj[prop] = value;
}
};
let person = new proxy({}, validator);
person.age = 100;
person.age // 100
person.age = 'young' // 报错
person.age = 300 // 报错
上面代码中,由于设置了存值函数set
,任何不符合要求的age
属性赋值,都会抛出一个错误。利用set
方法,还可以数据绑定,即每当对象发生变化时,会自动更新dom。
有时,我们会在对象上面设置内部属性,属性名的第一个字符使用下划线开头,表示这些属性不应该被外部使用。结合get
和set
方法,就可以做到防止这些内部属性被外部读写。
var handler = {
get (target, key) {
invariant(key, 'get');
return target[key];
},
set (target, key, value) {
invariant(key, 'set');
return true;
}
};
function invariant (key, action) {
if (key[0] === '_') {
throw new error(`invalid attempt to ${action} private "${key}" property`);
}
}
var target = {};
var 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
上面代码中,只要读写的属性名的第一个字符是下划线,一律抛错,从而达到禁止读写内部属性的目的。
apply
方法拦截函数的调用、call和apply操作。
var handler = {
apply (target, ctx, args) {
return reflect.apply(...arguments);
}
};
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
方法拦截,返回一个字符串。
下面是另外一个例子。
var twice = {
apply (target, ctx, args) {
return reflect.apply(...arguments) * 2;
}
};
function sum (left, right) {
return left + right;
};
var proxy = new proxy(sum, twice);
proxy(1, 2) // 6
proxy.call(null, 5, 6) // 22
proxy.apply(null, [7, 8]) // 30
上面代码中,每当执行proxy
函数(直接调用或call
和apply
调用),就会被apply
方法拦截。
另外,直接调用reflect.apply
方法,也会被拦截。
reflect.apply(proxy, null, [9, 10]) // 38
has
方法用来拦截hasproperty
操作,即判断对象是否具有某个属性时,这个方法会生效。典型的操作就是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
上面代码中,如果原对象的属性名的第一个字符是下划线,proxy.has
就会返回false
,从而不会被in
运算符发现。
如果原对象不可配置或者禁止扩展,这时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
上面代码中,obj
对象禁止扩展,结果使用has
拦截就会报错。
值得注意的是,has
方法拦截的是hasproperty
操作,而不是hasownproperty
操作,即has
方法不判断一个属性是对象自身的属性,还是继承的属性。由于for...in
操作内部也会用到hasproperty
操作,所以has
方法在for...in
循环时也会生效。
let stu1 = {name: 'owen', score: 59};
let stu2 = {name: 'mark', score: 99};
let handler = {
has(target, prop) {
if (prop === 'score' && target[prop] < 60) {
console.log(`${target.name} 不及格`);
return false;
}
return prop in target;
}
}
let oproxy1 = new proxy(stu1, handler);
let oproxy2 = new proxy(stu2, handler);
for (let a in oproxy1) {
console.log(oproxy1[a]);
}
// owen
// owen 不及格
for (let b in oproxy2) {
console.log(oproxy2[b]);
}
// mark
// mark 99
上面代码中,for...in
循环时,has
拦截会生效,导致不符合要求的属性被排除在for...in
循环之外。
construct
方法用于拦截new
命令,下面是拦截对象的写法。
var handler = {
construct (target, args, newtarget) {
return new target(...args);
}
};
construct
方法可以接受两个参数。
target
: 目标对象args
:构建函数的参数对象下面是一个例子。
var p = new proxy(function() {}, {
construct: function(target, args) {
console.log('called: ' + args.join(', '));
return { value: args[0] * 10 };
}
});
new p(1).value
// "called: 1"
// 10
construct
方法返回的必须是一个对象,否则会报错。
var p = new proxy(function() {}, {
construct: function(target, argumentslist) {
return 1;
}
});
new p() // 报错
deleteproperty
方法用于拦截delete
操作,如果这个方法抛出错误或者返回false
,当前属性就无法被delete
命令删除。
var handler = {
deleteproperty (target, key) {
invariant(key, 'delete');
return true;
}
};
function invariant (key, action) {
if (key[0] === '_') {
throw new error(`invalid attempt to ${action} private "${key}" property`);
}
}
var target = { _prop: 'foo' };
var proxy = new proxy(target, handler);
delete proxy._prop
// error: invalid attempt to delete private "_prop" property
上面代码中,deleteproperty
方法拦截了delete
操作符,删除第一个字符为下划线的属性会报错。
defineproperty
方法拦截了object.defineproperty
操作。
var handler = {
defineproperty (target, key, descriptor) {
return false;
}
};
var target = {};
var proxy = new proxy(target, handler);
proxy.foo = 'bar'
// typeerror: proxy defineproperty handler returned false for property '"foo"'
上面代码中,defineproperty
方法返回false
,导致添加新属性会抛出错误。
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 }
上面代码中,handler.getownpropertydescriptor
方法对于第一个字符为下划线的属性名会返回undefined
。
getprototypeof
方法主要用来拦截object.getprototypeof()
运算符,以及其他一些操作。
object.prototype.__proto__
object.prototype.isprototypeof()
object.getprototypeof()
reflect.getprototypeof()
instanceof
运算符下面是一个例子。
var proto = {};
var p = new proxy({}, {
getprototypeof(target) {
return proto;
}
});
object.getprototypeof(p) === proto // true
上面代码中,getprototypeof
方法拦截object.getprototypeof()
,返回proto
对象。
isextensible
方法拦截object.isextensible
操作。
var p = new proxy({}, {
isextensible: function(target) {
console.log("called");
return true;
}
});
object.isextensible(p)
// "called"
// true
上面代码设置了isextensible
方法,在调用object.isextensible
时会输出called
。
这个方法有一个强限制,如果不能满足下面的条件,就会抛出错误。
object.isextensible(proxy) === object.isextensible(target)
下面是一个例子。
var p = new proxy({}, {
isextensible: function(target) {
return false;
}
});
object.isextensible(p) // 报错
ownkeys
方法用来拦截object.keys()
操作。
let target = {};
let handler = {
ownkeys(target) {
return ['hello', 'world'];
}
};
let proxy = new proxy(target, handler);
object.keys(proxy)
// [ 'hello', 'world' ]
上面代码拦截了对于target
对象的object.keys()
操作,返回预先设定的数组。
下面的例子是拦截第一个字符为下划线的属性名。
let target = {
_bar: 'foo',
_prop: 'bar',
prop: 'baz'
};
let handler = {
ownkeys (target) {
return reflect.ownkeys(target).filter(key => key[0] !== '_');
}
};
let proxy = new proxy(target, handler);
for (let key of object.keys(proxy)) {
console.log(target[key]);
}
// "baz"
preventextensions
方法拦截object.preventextensions()
。该方法必须返回一个布尔值。
这个方法有一个限制,只有当object.isextensible(proxy)
为false
(即不可扩展)时,proxy.preventextensions
才能返回true
,否则会报错。
var p = new proxy({}, {
preventextensions: function(target) {
return true;
}
});
object.preventextensions(p) // 报错
上面代码中,proxy.preventextensions
方法返回true
,但这时object.isextensible(proxy)
会返回true
,因此报错。
为了防止出现这个问题,通常要在proxy.preventextensions
方法里面,调用一次object.preventextensions
。
var p = new proxy({}, {
preventextensions: function(target) {
console.log("called");
object.preventextensions(target);
return true;
}
});
object.preventextensions(p)
// "called"
// true
setprototypeof
方法主要用来拦截object.setprototypeof
方法。
下面是一个例子。
var handler = {
setprototypeof (target, proto) {
throw new error('changing the prototype is forbidden');
}
};
var proto = {};
var target = function () {};
var proxy = new proxy(target, handler);
proxy.setprototypeof(proxy, proto);
// error: changing the prototype is forbidden
上面代码中,只要修改target
的原型对象,就会报错。
proxy.revocable方法返回一个可取消的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
方法返回一个对象,该对象的proxy
属性是proxy
实例,revoke
属性是一个函数,可以取消proxy
实例。上面代码中,当执行revoke
函数之后,再访问proxy
实例,就会抛出一个错误。
reflect
对象与proxy
对象一样,也是es6为了操作对象而提供的新api。reflect
对象的设计目的有这样几个。
(1) 将object
对象的一些明显属于语言内部的方法(比如object.defineproperty
),放到reflect
对象上。现阶段,某些方法同时在object
和reflect
对象上部署,未来的新方法将只部署在reflect
对象上。
(2) 修改某些object方法的返回结果,让其变得更合理。比如,object.defineproperty(obj, name, desc)
在无法定义属性时,会抛出一个错误,而reflect.defineproperty(obj, name, desc)
则会返回false
。
// 老写法
try {
object.defineproperty(target, property, attributes);
// success
} catch (e) {
// failure
}
// 新写法
if (reflect.defineproperty(target, property, attributes)) {
// success
} else {
// failure
}
(3) 让object
操作都变成函数行为。某些object
操作是命令式,比如name in obj
和delete obj[name]
,而reflect.has(obj, name)
和reflect.deleteproperty(obj, name)
让它们变成了函数行为。
// 老写法
'assign' in object // true
// 新写法
reflect.has(object, 'assign') // true
(4)reflect
对象的方法与proxy
对象的方法一一对应,只要是proxy
对象的方法,就能在reflect
对象上找到对应的方法。这就让proxy
对象可以方便地调用对应的reflect
方法,完成默认行为,作为修改行为的基础。也就是说,不管proxy
怎么修改默认行为,你总可以在reflect
上获取默认行为。
proxy(target, {
set: function(target, name, value, receiver) {
var success = reflect.set(target,name, value, receiver);
if (success) {
log('property ' + name + ' on ' + target + ' set to ' + value);
}
return success;
}
});
上面代码中,proxy
方法拦截target
对象的属性赋值行为。它采用reflect.set
方法将值赋值给对象的属性,然后再部署额外的功能。
下面是另一个例子。
var loggedobj = new proxy(obj, {
get(target, name) {
console.log('get', target, name);
return reflect.get(target, name);
},
deleteproperty(target, name) {
console.log('delete' + name);
return reflect.deleteproperty(target, name);
},
has(target, name) {
console.log('has' + name);
return reflect.has(target, name);
}
});
上面代码中,每一个proxy
对象的拦截操作(get
、delete
、has
),内部都调用对应的reflect方法,保证原生行为能够正常执行。添加的工作,就是将每一个操作输出一行日志。
有了reflect
对象以后,很多操作会更易读。
// 老写法
function.prototype.apply.call(math.floor, undefined, [1.75]) // 1
// 新写法
reflect.apply(math.floor, undefined, [1.75]) // 1
reflect
对象的方法清单如下,共13个。
上面这些方法的作用,大部分与object
对象的同名方法的作用都是相同的,而且它与proxy
对象的方法是一一对应的。下面是对其中几个方法的解释。
(1)reflect.get(target, name, receiver)
查找并返回target
对象的name
属性,如果没有该属性,则返回undefined
。
如果name
属性部署了读取函数,则读取函数的this绑定receiver
。
var obj = {
get foo() { return this.bar(); },
bar: function() { ... }
};
// 下面语句会让 this.bar()
// 变成调用 wrapper.bar()
reflect.get(obj, "foo", wrapper);
(2)reflect.set(target, name, value, receiver)
设置target
对象的name
属性等于value
。如果name
属性设置了赋值函数,则赋值函数的this
绑定receiver
。
(3)reflect.has(obj, name)
等同于name in obj
。
(4)reflect.deleteproperty(obj, name)
等同于delete obj[name]
。
(5)reflect.construct(target, args)
等同于new target(...args)
,这提供了一种不使用new
,来调用构造函数的方法。
(6)reflect.getprototypeof(obj)
读取对象的__proto__
属性,对应object.getprototypeof(obj)
。
(7)reflect.setprototypeof(obj, newproto)
设置对象的__proto__
属性,对应object.setprototypeof(obj, newproto)
。
(8)reflect.apply(fun,thisarg,args)
等同于function.prototype.apply.call(fun,thisarg,args)
。一般来说,如果要绑定一个函数的this对象,可以这样写fn.apply(obj, args)
,但是如果函数定义了自己的apply
方法,就只能写成function.prototype.apply.call(fn, obj, args)
,采用reflect对象可以简化这种操作。
另外,需要注意的是,reflect.set()
、reflect.defineproperty()
、reflect.freeze()
、reflect.seal()
和reflect.preventextensions()
返回一个布尔值,表示操作是否成功。它们对应的object方法,失败时都会抛出错误。
// 失败时抛出错误
object.defineproperty(obj, name, desc);
// 失败时返回false
reflect.defineproperty(obj, name, desc);
上面代码中,reflect.defineproperty
方法的作用与object.defineproperty
是一样的,都是为对象定义一个属性。但是,reflect.defineproperty
方法失败时,不会抛出错误,只会返回false
。