es6 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
ES6原生提供了Proxy构造函数,用来生成Proxy实例。
var proxy = new Proxy(target, handler);
Proxy对象的所有用法,都是上面的这种形式。不同的只是handle参数的写法。其中new Proxy用来生成Proxy实例,target是表示所要拦截的对象,handle是用来定制拦截行为的对象。
var proxy = new Proxy({}, { get: function(target, property) { return 35; } }); proxy.time // 35 proxy.name // 35 proxy.title // 35
上面是一个拦截读取属性的行为的例子。要使Proxy起作用,必须针对Proxy实例进行操作,而不是针对目标对象(target)进行操作。
如果handler没有设置任何拦截,那就等同于直接通向原对象,如下:
var target = {}; var handler = {}; var proxy = new Proxy(target, handler); proxy.a = 'b'; target.a // "b"
我们可以将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" // 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 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(proxy, 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(...)
。 - construct(target, args):拦截 Proxy 实例作为构造函数调用的操作,比如
new proxy(...args)
。
Proxy实例方法:
get()
get方法用于拦截某个属性的读取操作,可以接收三个参数,依次为目标对象,属性名和Proxy实例本身(操作行为是针对的对象),其中最后一个参数可选。
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.foo // "GET foo"
上面代码中,拦截操作定义在prototype对象上面,所以如果读取obj对象继承的属性时,拦截会生效。
利用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
如果一个属性不可配置(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方法用来拦截某个属性的赋值操作,可以接受4个参数,依次为目标对象,属性名,属性值和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) { 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。
有时我们可以对一个对象设置内部属性,属性名的第一个字符使用下划线开头,表示这些属性不应被外部使用,如:
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
上面代码中,只要读写的属性名的第一个字符是下划线,一律报错,从而禁止读写内部属性的目的。
const handler = { set: function(obj, prop, value, receiver) { obj[prop] = receiver; } }; const proxy = new Proxy({}, handler); proxy.foo = 'bar'; proxy.foo === proxy // true
上面代码中,set方法的第四个参数receiver,指的是原始的操作行为实在的对象,一般情况下是Proxy实例本身。
如果目标对象的某个属性,不可配置且不可写,那么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"
apply()
apply方法拦截函数的调用,call和apply操作。
apply方法可以接收三个参数,依次是目标对象,目标对象的上下文对象(this)和目标对象的参数数组。
var handler = { apply (target, ctx, args) { return Reflect.apply(...arguments); } };
下面是一个例子:
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()
has方法用来拦截Hasproperty操作,即判断对象是否有某个属性时,这个方法会生效。典型的操作就是in操作。
has方法可以接收两个参数,分别是目标对象,需查询的属性名。
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
上面代码中,如原对象的属性名的第一个字符是下划线,则返回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
ps:has方法拦截的是hasProperty操作,而不是hasOwnProperty操作,即不判断一个属性是自身的属性还是继承属性。、
has方法只对in运算符生效,而不对for...in循环生效,如下。
let stu1 = {name: '张三', score: 59}; let stu2 = {name: '李四', 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); 'score' in oproxy1 // 张三 不及格 // false 'score' in oproxy2 // true for (let a in oproxy1) { console.log(oproxy1[a]); } // 张三 // 59 for (let b in oproxy2) { console.log(oproxy2[b]); } // 李四 // 99
construct()
construct方法用于拦截new命令,下面是拦截对象的写法。
var handler = { construct (target, args, newTarget) { return new target(...args); } };
construct方法可以接收三个参数,依次是目标对象,构造函数的参数对象和创造实例对象时,new命令作用的构造函数(可选)
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()
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操作,当删除属性的第一个字符为下划线的时候会报错。
当目标对象的不可配置(configruable)的属性时,不能被deleteProperty方法拦截,会报错。
defineProperty()
defineProperty方法拦截的Object.defineProperty操作。
var handler = { defineProperty (target, key, descriptor) { return false; } }; var target = {}; var proxy = new Proxy(target, handler); proxy.foo = 'bar' // 不会生效
上面代码中,defineProperty方法返回false,导致添加新属性总是无效。
如果目标对象不可扩展(extensible),则defineProperty不能增加目标对象上不存在的属性,否则会报错。另外,如果目标对象不可配置或不可写,则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 }
上面代码中,handler的getOwnPropertyDescriptor方法对于第一个字符为下划线的属性名会返回undefined。
getPropertyOf()
getPropertyOf方法主要用来拦截获取对象原型。具体来说,拦截下面这些操作:
- 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对象。
ps:getPrototypeOf必须返回对象或者null,否则报错。另外如果目标对象不可扩展,getPrototypeOf必须返回目标对象的原型对象。
isExtensible()
isExtensible方法拦截Object.isExtensible操作。
var p = new Proxy({}, { isExtensible: function(target) { console.log("called"); return true; } }); Object.isExtensible(p) // "called" // true
上面代码中设置了isExtensible方法,在调用Object.isExtensible是输出called。
该方法只能返回布尔值,如果不是将会把返回值自动转化为布尔值。
还有一个强限制,它的返回值必须与目标对象的isExtensible属性保持一致,否则就会抛出错误。
Object.isExtensible(proxy) === Object.isExtensible(target)
下面的就会报错:
var p = new Proxy({}, { isExtensible: function(target) { return false; } }); Object.isExtensible(p) // 报错
ownKeys()
ownKeys方法是用来拦截对象自身属性的读取操作,拦截的操作有:
- Object.getOwnPropertyNames()
- Object.getOwnPropertySymbls()
- Object.keys()
- for...in循环
下面一个拦截Object.keys()的例子:
let target = { a: 1, b: 2, c: 3 }; let handler = { ownKeys(target) { return ['a']; } }; let proxy = new Proxy(target, handler); Object.keys(proxy) // [ 'a' ]
下面例子拦截第一个字符为下划线的属性名:
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"
在使用Object.keys()时,以下三类属性会被ownKeys方法自动过滤,不会返回:
- 目标对象不存在的属性
- 属性名为Symbol值
- 不可遍历(enumerable)的属性
let target = { a: 1, b: 2, c: 3, [Symbol.for('secret')]: '4', }; Object.defineProperty(target, 'key', { enumerable: false, configurable: true, writable: true, value: 'static' }); let handler = { ownKeys(target) { return ['a', 'd', Symbol.for('secret'), 'key']; } }; let proxy = new Proxy(target, handler); Object.keys(proxy) // ['a']
ownKeys方法还可以拦截Object.getOwnPropertyNames()方法。
var p = new Proxy({}, { ownKeys: function(target) { return ['a', 'b', 'c']; } }); Object.getOwnPropertyNames(p) // [ 'a', 'b', 'c' ]
for...in循环也受到ownKeys方法的拦截。
const obj = { hello: 'world' }; const proxy = new Proxy(obj, { ownKeys: function () { return ['a', 'b']; } }); for (let key in proxy) { console.log(key); // 没有任何输出 }
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
preventExtensions()
preventExtensions方法拦截Object.preventExtensions(),该方法必须返回布尔值,否则自动转化为布尔值。
该方法还有一个限制,只有目标对象不可扩展(即Object.isExtensible(proxy)为false时),Proxy.preventExtensions才能返回true,否则报错。
var p = new Proxy({}, { preventExtensions: function(target) { return true; } }); Object.preventExtensions(p) // 报错
为了防止这问题出现,通常要在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()
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); Object.setPrototypeOf(proxy, proto); // Error: Changing the prototype is forbidden
上面代码中,只要修改target的原型对象,就会报错。
注意,该方法只能返回布尔值,否则会自动转化为布尔值。另外如果目标对象不可扩展。setPrototypeOf方法不得改变目标对象的原型。
Proxy.revocable()
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实例,就会报错。
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,而不是target。
而有些原生对象的内部属性,只有通过正确的this才能拿到,所以proxy也无法代理这些原生对象的属性。
const target = new Date(); const handler = {}; const proxy = new Proxy(target, handler); proxy.getDate(); // TypeError: this is not a Date object.
上面代码,getDate方法只能在Date对象的实例上面拿到,如果this不是Date就会报错。如果this绑定原始对象,就可以解决这个问题。
const target = new Date('2015-01-01'); const handler = { get(target, prop) { if (prop === 'getDate') { return target.getDate.bind(target); } return Reflect.get(target, prop); } }; const proxy = new Proxy(target, handler); proxy.getDate() // 1
实例:Web 服务的客户端
Proxy 对象可以拦截目标对象的任意属性,这使得它很合适用来写 Web 服务的客户端。
const service = createWebService('http://example.com/data'); service.employees().then(json => { const employees = JSON.parse(json); // ··· });
上面代码新建了一个 Web 服务的接口,这个接口返回各种数据。Proxy 可以拦截这个对象的任意属性,所以不用为每一种数据写一个适配方法,只要写一个 Proxy 拦截就可以了。
function createWebService(baseUrl) { return new Proxy({}, { get(target, propKey, receiver) { return () => httpGet(baseUrl+'/' + propKey); } }); }
原文链接:http://es6.ruanyifeng.com/#docs/proxy