本文介绍ES6新标准中添加的Proxy。节选自《ESMAScript 6 入门 —— 阮一峰》)
一、概述
Proxy用于修改某些操作的默认行为,等同于在语言层面做出修改,所有属于一种“元编程”(meta programming),即对编程语言进行编程。
Proxy可以理解成,在目标对象之前假设一层“拦截”,外界对该对象的访问,都必须先通过这层拦截,因此提供了一种机制,可以对外界的访问进行过滤和改写。Proxy这个词的原意是代理,用在这里表示由它来“代理”某些操作,可以译为“代理器”。
1 | var obj = new Proxy({}, { |
上面代码对一个空对象架设了一层拦截,重定义了属性的读取(get
)和设置(set
)行为。这里暂时先不解释具体的语法,只看运行结果。对设置了拦截行为的对象obj
,去读写它的属性,就会得到下面的结果。
1 | obj.count = 1 |
上面代码说明,Proxy实际上重载(overload)了点运算符,即用自己的定义覆盖了语言的原始定义。
ES6原生提供了Proxy构造函数,用来生成Proxy实例。
1 | var proxy = new Proxy(target, handler); |
Proxy对象的所有用法,都是上面这种形式,不同的只是handler
参数的写法。其中,new Proxy()
表示生成一个Proxy
实例,target
参数表示所要拦截的目标对象,handler
参数也是一个对象,用来定制拦截行为。
下面时另一个拦截读取属性行为的例子。
1 | var proxy = new Proxy({}, { |
上面代码中,作为构造函数,Proxy
接受两个参数。第一个参数是所要代理的目标对象(上例是一个空对象),即如果没有Proxy
的介入,操作原来要访问的就是这个对象;第二个参数是一个配置对象,对于每一个被代理的操作,需要提供一个对应的处理函数,该函数将拦截对应的操作。比如,上面代码中,配置对象有一个get
方法,用来拦截对目标对象属性的访问请求。get
方法的两个参数分别是目标对象和所要访问的属性。可以看到,由于拦截函数总是返回35
,所以访问任何属性都得到35
。
注意,要使得Proxy
起作用,必须针对Proxy
实例(上例是proxy
对象)进行操作,而不是针对目标对象(上例是空对象)进行操作。
如果handler
没有设置任何拦截,那就等同于直接通向原对象。
1 | var target = {}; |
上面代码中,handler
是一个空对象,没有任何拦截效果,访问proxy
就等同于访问target
。
一个技巧是将Proxy对象,设置到object.proxy
属性,从而可以在object
对象上调用。
1 | var object = {proxy: new Proxy(target, handler)}; |
Proxy实例也可以作为其他对象的原型对象。
1 | var proxy = new Proxy({}, { |
上面代码中,proxy
对象是obj
对象的原型,obj
对象本身并没有time
属性,所以根据原型链,会在proxy
对象上读取该属性,导致被拦截。
同一个拦截器,可以设置拦截多个操作。
1 | var handler = { |
对于可以设置、但没有设置拦截的操作,则直接落在目标对象上,按照原先的方式产生结果。
下面是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 proxy
的操作,返回一个布尔值。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.getOwnPropertyDescriptor(target, propKey)
,返回属性的描述对象。defineProperty(target, propKey, propDesc)
:拦截Object.defineProperty(proxy, propKey, propDesc)
、Object.defineProperties(proxy, propDescs)
,返回一个布尔值。preventExtensions(target)
:拦截Object.preventExtensions(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(...)
。constructor
:拦截Proxy实例作为构造函数调用的操作,比如new proxy(...args)
。
二、Proxy实例的方法
下面是上面这些拦截方法的详细介绍。
1. get()
get
方法用于拦截某个属性的读取操作,可以接受三个参数,依次为目标对象、属性名和proxy实例本身(严格地说,是操作行为所针对的对象),其中最后一个参数可选。
get
方法的用法,上文已经有一个例子,下面是另一个拦截读取操作的例子。
1 | var person = { |
上面代码表示,如果访问目标对象不存在的属性,会抛出一个错误。如果没有这个拦截函数,访问不存在的属性,只会返回undefined
。
get
方法可以继承。
1 | let proto = new Proxy({}, { |
上面代码中,拦截操作定义在Prototype
对象上面,所以如果读取obj
对象继承的属性时,拦截会生效。
下面的例子使用get
拦截,实现数组读取负数的索引。
1 | function createArray(...elements) { |
上面代码中,数组的位置参数是-1
,就会输出数组的倒数第一个成员。
利用Proxy,可以将读取属性的操作(get
),转变为执行某个函数,从而实现属性的链式操作。
1 | var pipe = (function() { |
上面代码设置Proxy以后,达到了将函数名链式使用的效果。
下面的例子则是利用get
拦截,实现一个生成各种DOM节点的通用函数dom
。
1 | const dom = new Proxy({}, { |
下面是一个get
方法的第三个参数的例子,它总是指向原始的读操作所在的那个对象,一般情况下就是Proxy实例。
1 | const proxy = new Proxy({}, { |
上面代码中,proxy
对象的getReceiver
属性是由proxy
对象提供的,所以receiver
指向proxy
对象。
1 | const proxy = new Proxy({}, { |
上面代码中,d
对象本身没有a
属性,所以读取d.a
的时候,会去d
的原型proxy
对象找。这时,receiver
就指向d
,代表原始的读操作所在的那个对象。
如果一个属性不可配置(configurable)和不可写(writable),则该属性不能被代理,通过Proxy对象访问该属性会报错。
1 | const target = Object.defineProperties({}, { |
2. set()
set
方法用来拦截某个属性的赋值操作,可以接受四个参数,依次为目标对象、属性名、属性值和Proxy实例本身,其中最后一个参数可选。
假定Person
对象有一个age
属性,该属性应该时一个不大于200的整数,那么可以使用Proxy
保证age
的属性值符合要求。
1 | let validator = { |
上面代码中,由于设置了存值函数set
,任何不符合要求的age
属性赋值,都会抛出一个错误,这时数据验证的一种实现方法。利用set
方法,还可以数据绑定,即每当对象发生变化时,会自动更新DOM。
有时,我们会在对象上面设置内部属性,属性名的第一个字符使用下划线开头,表示这些属性不应该被外部使用。结合get
和set
方法,就可以做到防止这些内部属性被外部读写。
1 | const handler = { |
上面代码中,只要读写的属性名的第一个字符是下划线,一律抛错,从而达到禁止读写内部属性的目的。
下面是set
方法第四个参数的例子。
1 | const handler = { |
上面代码中,set
方法的第四个参数receiver
,指的是原始的操作行为所在的那个对象,一般情况下是proxy
实例本身,请看下面的例子:
1 | const handler = { |
上面代码中,设置myObj.foo
属性的值时,myObj
并没有foo
属性,因此引擎会到myObj
的原型链去找foo
属性。myObj
的原型对象proxy
是一个Proxy实例,设置它的foo
属性会触发set
方法。这时,第四个参数receiver
就指向原型赋值行为所在的对象myObj
。
注意,如果目标对象自身的某个属性,不可写或不可配置,那么set
方法将不起作用。
1 | const obj = {}; |
上面代码中,obj.foo
属性不可写,Proxy对这个属性的set
代理将不会生效。
3. apply()
apply
方法拦截函数的调用、call
和apply
操作。
apply
方法可以接受三个参数,分别是目标对象、目标对象的上下文对象(this
)和目标对象的参数数组。
1 | var handler = { |
下面是一个例子。
1 | var target = function() { return 'I am the target'; }; |
上面代码中,变量p
是Proxy的实例,当它作为函数调用时(p()
),就会被apply
方法拦截,返回一个字符串。
下面是另外一个例子。
1 | var twice = { |
上面代码中,每当执行proxy
函数(直接调用或call
和apply
调用),就会被apply
方法拦截。
另外,直接调用Reflect.apply
方法,也会被拦截。
1 | Reflect.apply(proxy, null, [9, 10]) // 38 |
4. has()
has
方法用来拦截HasProperty
操作,即判断对象是否具有某个属性时,这个方法会生效。典型的操作就是in
运算符。
has
方法可以接受两个参数,分别是目标对象、需查询的属性名。
下面的例子使用has
方法隐藏某些属性,不被in
运算符发现。
1 | var handler = { |
上面代码中,如果原对象的属性名的第一个字符是下划线,proxy.has
就会返回false,从而不会被in
运算符发现。
如果源对象不可配置或者禁止扩展,这时has
拦截会报错。
1 | var obj = { a: 10 }; |
上面代码中,obj
对象禁止扩展,结果使用has
拦截就会报错。也就是说,如果某个属性不可配置(或者目标对象不可扩展),则has
方法就不得“隐藏”(即返回false)目标对象的该属性。
值得注意的是,has
方法拦截的是HasProperty
操作,而不是HasOwnProperty
操作,即has
方法不判断一个属性是对象自身的属性,还是继承的属性。
另外,虽然for...in
循环也用到了in
运算符,但是has
拦截对for...in
循环不生效。
1 | let stu1 = {name: '张三', score: 59}; |
上面代码中,has
拦截只对in
运算符生效,对for...in
循环不生效,导致不符合要求的属性没有被for...in
循环所排除。
5. construct()
construct
方法用于拦截new
命令,下面是拦截对象的写法。
1 | var handler = { |
construct
方法可以接受两个参数。
target
:目标对象args
:构造函数的参数对象newTarget
:创造实例对象时,new
命令作用的构造函数(下面例子的p
)
1 | var p = new Proxy(function() {}, { |
construct
方法返回的必须是一个对象,否则会报错。
1 | var p = new Proxy(function() {}, { |
6. deleteProperty()
deleteProperty
方法用于拦截delete
操作,如果这个方法抛出错误或者返回false
,当前属性就无法被delete
命令删除。
1 | var handler = { |
上面代码中,deleteProperty
方法拦截了delete
操作符,删除第一个字符为下划线的属性会报错。
注意,目标对象自身的不可配置(configurable)的属性,不能被deleteProperty
方法删除,否则报错。
7. defineProperty()
defineProperty
方法拦截了Object.defineProperty
操作。
1 | var handler = { |
上面代码中,如果目标对象不可扩展(extensible),则defineProperty
不能增加目标对象上不存在的属性,否则会报错。另外,如果目标的某个属性不可写(writable)或者不可配置(configurable),则defineProperty
方法不得改变这两个设置。
8. getOwnPropertyDescriptor()
getOwnPropertyDescriptor
方法拦截Object.getOwnPropertyDescriptor()
,返回一个属性描述对象或者undefined
。
1 | var handler = { |
上面代码中,handler.getOwnPropertyDescriptor
方法对于第一个字符为下划线的属性名会返回undefined
。
9. getPrototypeOf()
getPrototypeOf
方法主要用来拦截获取对象原型。具体来说,拦截下面这些操作。
Object.prototype.__proto__
Object.prototype.isPrototypeOf()
Object.getPrototypeOf()
Reflect.getPrototypeOf()
instanceof
下面是一个例子。
1 | var proto = {}; |
上面代码中,getPrototypeOf
方法拦截Object.getPrototypeOf()
,返回proto
对象。
注意,getPrototypeOf
方法的返回值必须是对象或者null
,否则报错。另外,如果目标对象不可扩展(extensible),getPrototypeOf
方法必须返回目标对象的原型对象。
10. isExtensible()
isExtensible
方法拦截Object.isExtensible
操作。
1 | var p = new Proxy({}, { |
上面代码设置了isExtensible
方法,在调用Object.isExtensible
时会输出called
。
注意,该方法只能返回布尔值,否则返回值会被自动转为布尔值。
这个方法有一个强限制,它的返回值必须与目标对象的isExtensible
属性保持一致,否则就会抛出错误。
1 | Object.isExtensible(proxy) === Object.isExtensible(target) |
下面是一个例子。
1 | var p = new Proxy({}, { |
11. ownKeys()
ownKeys
方法用来拦截对象自身属性的读取操作。具体来说,拦截以下操作。
Object.getOwnPropertyNames()
Object.getOwnPropertySymbols()
Object.keys()
for...in
循环
下面是拦截Object.keys()
的例子。
1 | let target = { a: 1, b: 2, c: 3 }; |
上面代码拦截了对于target
对象的Object.keys()
操作,只返回a
、b
、c
属性之中的a
属性。
下面的例子是拦截第一个字符为下划线的属性名。
1 | let target = { |
注意,使用Object.keys
方法时,有三类属性会被ownKeys
方法自动过滤,不会返回。
目标对象上不存在的属性
属性名为Symbol值
不可遍历(enumerable)的属性
1 | let target = { |
上面代码中,ownKeys
方法之中,显式返回不存在的属性d
、Symbol值(Symbol.for('secret')
)、不可遍历属性(key
),结果都被自动过滤掉。
ownKeys
方法还可以拦截Object.getOwnPropertyNames()
。
1 | var p = new Proxy({}, { |
for...in
循环也受到ownKeys
方法的拦截。
1 | const obj = { hello: 'world' }; |
上面代码中,ownKeys
指定只返回a
和b
属性,由于obj
没有这两个属性,因此for...in
循环不会有任何输出。
ownKeys
方法返回的是数组成员,只能是字符串或Symbol值。如果有其他类型的值,或者返回的根本不是数组,就会报错。
1 | var obj = {}; |
上面代码中,obj
对象的a
属性是不可配置的,这时ownKeys
方法返回的数组之中,必须包含a
,否则会报错。
1 | var obj = { |
上面代码中,obj
对象是不可扩展的,这时ownKeys
方法返回的数组之中,包含了obj
对象的多余属性b
,所以导致了报错。
12. preventExtensions()
preventExtensions
方法拦截Object.preventExtensions()
。该方法必须返回一个布尔值,否则会自动转为布尔值。
这个方法有一个限制,只有目标对象不可扩展时(即Object.isExtensible(proxy)
为false
),proxy.preventExtensions
才能返回true
,否则会报错。
1 | var p = new Proxy({}, { |
上面代码中,proxy.preventExtensions
方法返回true
,但这时Object.isExtensible(proxy)
会返回true
,因此报错。
为了防止出现这个问题,通常要在proxy.preventExtensions
方法里面,调用一次Object.preventExtensions
。
1 | var p = new Proxy({}, { |
13. setPrototypeOf()
setPrototypeOf
方法主要用来拦截Object.setPrototypeOf
方法。
下面是一个例子。
1 | var handler = { |
上面代码中,只要修改target
的原型对象,就会报错。
注意,该方法只能返回布尔值,否则会被自动转为布尔值。另外,如果目标对象不可扩展(extensible),setPrototypeOf
方法不得改变目标对象的原型。
三、Proxy.revocable()
Proxy.revocable
方法返回一个可取消的Proxy实例。
1 | let target = {}; |
Proxy.revocable
方法返回一个对象,该对象的proxy
属性是Proxy
实例,revoke
属性是一个函数,可以取消Proxy
实例。上面代码中,当执行revoke
函数之后,再访问Proxy
实例,就会抛出一个错误。
Proxy.revocable
的一个使用场景是,目标对象不允许直接访问,必须通过代理访问,一旦访问结束,就收回代理权,不允许再次访问。
四、this问题
虽然Proxy可以代理针对目标对象的访问,但它不是目标对象的透明代理,即不做任何拦截的情况下,也无法保证与目标对象的行为一致。主要原因就是在Proxy代理的情况下,目标对象内部的this
关键字会指向Proxy代理。
1 | const target = { |
上面代码中,一旦proxy
代理target.m
,后者内部的this
就是指向proxy
,而不是target
。
下面是一个例子,由于this
指向的变化,导致Proxy无法代理目标对象。
1 | const _name = new WeakMap(); |
上面代码中,目标对象jane
的name
属性,实时保存在外部WeakMap
对象_name
上面,通过this
键区分。由于通过proxy.name
访问时,this
指向proxy
,导致无法取到值,所以返回undefined
。
此外,有些原生对象的内部属性,只有通过正确的this
才能拿到,所以Proxy也无法代理这些原生对象的属性。
1 | const target = new Date(); |
上面代码中,getDate
方法只能在Date
对象实例上面拿到,如果this
不是Date
对象实例就会报错。这时,this
绑定原始对象,就可以解决这个问题。
1 | const target = new Date('2015-01-01'); |
五、Web服务的客户端
Proxy对象可以拦截目标对象的任意属性,这使得它很适合用来写Web服务的客户端。
1 | const service = createWebService('http://example.com/data'); |
上面代码新建了一个Web服务的接口,这个接口返回各种数据。Proxy可以拦截这个对象的任意属性,所以不用为每一种数据写一个适配方法,只要写一个Proxy拦截就可以了。
1 | function createWebService(baseUrl) { |
同理,Proxy也可以用来实现数据库的ORM层。