Proxy

概述

Proxy 用于修改某些操作的默认行为,等同于在语言层面做出修改,所以属于一种“元编程”(meta programming),即对编程语言进行编程。

Proxy 可以理解成,在目标对象之前架设一层“拦截”,外界对该对象的访问,都必须先通过这层拦截,因此提供了一种机制,可以对外界的访问进行过滤和改写。Proxy 这个词的原意是代理,用在这里表示由它来“代理”某些操作,可以译为“代理器”。

  1. var obj = new Proxy({}, {
  2. get: function (target, propKey, receiver) {
  3. console.log(`getting ${propKey}!`);
  4. return Reflect.get(target, propKey, receiver);
  5. },
  6. set: function (target, propKey, value, receiver) {
  7. console.log(`setting ${propKey}!`);
  8. return Reflect.set(target, propKey, value, receiver);
  9. }
  10. });

上面代码对一个空对象架设了一层拦截,重定义了属性的读取(get)和设置(set)行为。这里暂时先不解释具体的语法,只看运行结果。对设置了拦截行为的对象obj,去读写它的属性,就会得到下面的结果。

  1. obj.count = 1
  2. // setting count!
  3. ++obj.count
  4. // getting count!
  5. // setting count!
  6. // 2

上面代码说明,Proxy 实际上重载(overload)了点运算符,即用自己的定义覆盖了语言的原始定义。

ES6 原生提供 Proxy 构造函数,用来生成 Proxy 实例。

  1. var proxy = new Proxy(target, handler);

Proxy 对象的所有用法,都是上面这种形式,不同的只是handler参数的写法。其中,new Proxy()表示生成一个Proxy实例,target参数表示所要拦截的目标对象,handler参数也是一个对象,用来定制拦截行为。

下面是另一个拦截读取属性行为的例子。

  1. var proxy = new Proxy({}, {
  2. get: function(target, propKey) {
  3. return 35;
  4. }
  5. });
  6. proxy.time // 35
  7. proxy.name // 35
  8. proxy.title // 35

上面代码中,作为构造函数,Proxy接受两个参数。第一个参数是所要代理的目标对象(上例是一个空对象),即如果没有Proxy的介入,操作原来要访问的就是这个对象;第二个参数是一个配置对象,对于每一个被代理的操作,需要提供一个对应的处理函数,该函数将拦截对应的操作。比如,上面代码中,配置对象有一个get方法,用来拦截对目标对象属性的访问请求。get方法的两个参数分别是目标对象和所要访问的属性。可以看到,由于拦截函数总是返回35,所以访问任何属性都得到35

注意,要使得Proxy起作用,必须针对Proxy实例(上例是proxy对象)进行操作,而不是针对目标对象(上例是空对象)进行操作。

如果handler没有设置任何拦截,那就等同于直接通向原对象。

  1. var target = {};
  2. var handler = {};
  3. var proxy = new Proxy(target, handler);
  4. proxy.a = 'b';
  5. target.a // "b"

上面代码中,handler是一个空对象,没有任何拦截效果,访问proxy就等同于访问target

一个技巧是将 Proxy 对象,设置到object.proxy属性,从而可以在object对象上调用。

  1. var object = { proxy: new Proxy(target, handler) };

Proxy 实例也可以作为其他对象的原型对象。

  1. var proxy = new Proxy({}, {
  2. get: function(target, propKey) {
  3. return 35;
  4. }
  5. });
  6. let obj = Object.create(proxy);
  7. obj.time // 35

上面代码中,proxy对象是obj对象的原型,obj对象本身并没有time属性,所以根据原型链,会在proxy对象上读取该属性,导致被拦截。

同一个拦截器函数,可以设置拦截多个操作。

  1. var handler = {
  2. get: function(target, name) {
  3. if (name === 'prototype') {
  4. return Object.prototype;
  5. }
  6. return 'Hello, ' + name;
  7. },
  8. apply: function(target, thisBinding, args) {
  9. return args[0];
  10. },
  11. construct: function(target, args) {
  12. return {value: args[1]};
  13. }
  14. };
  15. var fproxy = new Proxy(function(x, y) {
  16. return x + y;
  17. }, handler);
  18. fproxy(1, 2) // 1
  19. new fproxy(1, 2) // {value: 2}
  20. fproxy.prototype === Object.prototype // true
  21. fproxy.foo === "Hello, foo" // true

对于可以设置、但没有设置拦截的操作,则直接落在目标对象上,按照原先的方式产生结果。

下面是 Proxy 支持的拦截操作一览,一共 13 种。

  • get(target, propKey, receiver):拦截对象属性的读取,比如proxy.fooproxy['foo']
  • set(target, propKey, value, receiver):拦截对象属性的设置,比如proxy.foo = vproxy['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 实例本身(严格地说,是操作行为所针对的对象),其中最后一个参数可选。

get方法的用法,上文已经有一个例子,下面是另一个拦截读取操作的例子。

  1. var person = {
  2. name: "张三"
  3. };
  4. var proxy = new Proxy(person, {
  5. get: function(target, propKey) {
  6. if (propKey in target) {
  7. return target[propKey];
  8. } else {
  9. throw new ReferenceError("Prop name \"" + propKey + "\" does not exist.");
  10. }
  11. }
  12. });
  13. proxy.name // "张三"
  14. proxy.age // 抛出一个错误

上面代码表示,如果访问目标对象不存在的属性,会抛出一个错误。如果没有这个拦截函数,访问不存在的属性,只会返回undefined

get方法可以继承。

  1. let proto = new Proxy({}, {
  2. get(target, propertyKey, receiver) {
  3. console.log('GET ' + propertyKey);
  4. return target[propertyKey];
  5. }
  6. });
  7. let obj = Object.create(proto);
  8. obj.foo // "GET foo"

上面代码中,拦截操作定义在Prototype对象上面,所以如果读取obj对象继承的属性时,拦截会生效。

下面的例子使用get拦截,实现数组读取负数的索引。

  1. function createArray(...elements) {
  2. let handler = {
  3. get(target, propKey, receiver) {
  4. let index = Number(propKey);
  5. if (index < 0) {
  6. propKey = String(target.length + index);
  7. }
  8. return Reflect.get(target, propKey, receiver);
  9. }
  10. };
  11. let target = [];
  12. target.push(...elements);
  13. return new Proxy(target, handler);
  14. }
  15. let arr = createArray('a', 'b', 'c');
  16. arr[-1] // c

上面代码中,数组的位置参数是-1,就会输出数组的倒数第一个成员。

利用 Proxy,可以将读取属性的操作(get),转变为执行某个函数,从而实现属性的链式操作。

  1. var pipe = function (value) {
  2. var funcStack = [];
  3. var oproxy = new Proxy({} , {
  4. get : function (pipeObject, fnName) {
  5. if (fnName === 'get') {
  6. return funcStack.reduce(function (val, fn) {
  7. return fn(val);
  8. },value);
  9. }
  10. funcStack.push(window[fnName]);
  11. return oproxy;
  12. }
  13. });
  14. return oproxy;
  15. }
  16. var double = n => n * 2;
  17. var pow = n => n * n;
  18. var reverseInt = n => n.toString().split("").reverse().join("") | 0;
  19. pipe(3).double.pow.reverseInt.get; // 63

上面代码设置 Proxy 以后,达到了将函数名链式使用的效果。

下面的例子则是利用get拦截,实现一个生成各种 DOM 节点的通用函数dom

  1. const dom = new Proxy({}, {
  2. get(target, property) {
  3. return function(attrs = {}, ...children) {
  4. const el = document.createElement(property);
  5. for (let prop of Object.keys(attrs)) {
  6. el.setAttribute(prop, attrs[prop]);
  7. }
  8. for (let child of children) {
  9. if (typeof child === 'string') {
  10. child = document.createTextNode(child);
  11. }
  12. el.appendChild(child);
  13. }
  14. return el;
  15. }
  16. }
  17. });
  18. const el = dom.div({},
  19. 'Hello, my name is ',
  20. dom.a({href: '//example.com'}, 'Mark'),
  21. '. I like:',
  22. dom.ul({},
  23. dom.li({}, 'The web'),
  24. dom.li({}, 'Food'),
  25. dom.li({}, '…actually that\'s it')
  26. )
  27. );
  28. document.body.appendChild(el);

下面是一个get方法的第三个参数的例子,它总是指向原始的读操作所在的那个对象,一般情况下就是 Proxy 实例。

  1. const proxy = new Proxy({}, {
  2. get: function(target, key, receiver) {
  3. return receiver;
  4. }
  5. });
  6. proxy.getReceiver === proxy // true

上面代码中,proxy对象的getReceiver属性是由proxy对象提供的,所以receiver指向proxy对象。

  1. const proxy = new Proxy({}, {
  2. get: function(target, key, receiver) {
  3. return receiver;
  4. }
  5. });
  6. const d = Object.create(proxy);
  7. d.a === d // true

上面代码中,d对象本身没有a属性,所以读取d.a的时候,会去d的原型proxy对象找。这时,receiver就指向d,代表原始的读操作所在的那个对象。

如果一个属性不可配置(configurable)且不可写(writable),则 Proxy 不能修改该属性,否则通过 Proxy 对象访问该属性会报错。

  1. const target = Object.defineProperties({}, {
  2. foo: {
  3. value: 123,
  4. writable: false,
  5. configurable: false
  6. },
  7. });
  8. const handler = {
  9. get(target, propKey) {
  10. return 'abc';
  11. }
  12. };
  13. const proxy = new Proxy(target, handler);
  14. proxy.foo
  15. // TypeError: Invariant check failed

set()

set方法用来拦截某个属性的赋值操作,可以接受四个参数,依次为目标对象、属性名、属性值和 Proxy 实例本身,其中最后一个参数可选。

假定Person对象有一个age属性,该属性应该是一个不大于 200 的整数,那么可以使用Proxy保证age的属性值符合要求。

  1. let validator = {
  2. set: function(obj, prop, value) {
  3. if (prop === 'age') {
  4. if (!Number.isInteger(value)) {
  5. throw new TypeError('The age is not an integer');
  6. }
  7. if (value > 200) {
  8. throw new RangeError('The age seems invalid');
  9. }
  10. }
  11. // 对于满足条件的 age 属性以及其他属性,直接保存
  12. obj[prop] = value;
  13. }
  14. };
  15. let person = new Proxy({}, validator);
  16. person.age = 100;
  17. person.age // 100
  18. person.age = 'young' // 报错
  19. person.age = 300 // 报错

上面代码中,由于设置了存值函数set,任何不符合要求的age属性赋值,都会抛出一个错误,这是数据验证的一种实现方法。利用set方法,还可以数据绑定,即每当对象发生变化时,会自动更新 DOM。

有时,我们会在对象上面设置内部属性,属性名的第一个字符使用下划线开头,表示这些属性不应该被外部使用。结合getset方法,就可以做到防止这些内部属性被外部读写。

  1. const handler = {
  2. get (target, key) {
  3. invariant(key, 'get');
  4. return target[key];
  5. },
  6. set (target, key, value) {
  7. invariant(key, 'set');
  8. target[key] = value;
  9. return true;
  10. }
  11. };
  12. function invariant (key, action) {
  13. if (key[0] === '_') {
  14. throw new Error(`Invalid attempt to ${action} private "${key}" property`);
  15. }
  16. }
  17. const target = {};
  18. const proxy = new Proxy(target, handler);
  19. proxy._prop
  20. // Error: Invalid attempt to get private "_prop" property
  21. proxy._prop = 'c'
  22. // Error: Invalid attempt to set private "_prop" property

上面代码中,只要读写的属性名的第一个字符是下划线,一律抛错,从而达到禁止读写内部属性的目的。

下面是set方法第四个参数的例子。

  1. const handler = {
  2. set: function(obj, prop, value, receiver) {
  3. obj[prop] = receiver;
  4. }
  5. };
  6. const proxy = new Proxy({}, handler);
  7. proxy.foo = 'bar';
  8. proxy.foo === proxy // true

上面代码中,set方法的第四个参数receiver,指的是原始的操作行为所在的那个对象,一般情况下是proxy实例本身,请看下面的例子。

  1. const handler = {
  2. set: function(obj, prop, value, receiver) {
  3. obj[prop] = receiver;
  4. }
  5. };
  6. const proxy = new Proxy({}, handler);
  7. const myObj = {};
  8. Object.setPrototypeOf(myObj, proxy);
  9. myObj.foo = 'bar';
  10. myObj.foo === myObj // true

上面代码中,设置myObj.foo属性的值时,myObj并没有foo属性,因此引擎会到myObj的原型链去找foo属性。myObj的原型对象proxy是一个 Proxy 实例,设置它的foo属性会触发set方法。这时,第四个参数receiver就指向原始赋值行为所在的对象myObj

注意,如果目标对象自身的某个属性,不可写且不可配置,那么set方法将不起作用。

  1. const obj = {};
  2. Object.defineProperty(obj, 'foo', {
  3. value: 'bar',
  4. writable: false,
  5. });
  6. const handler = {
  7. set: function(obj, prop, value, receiver) {
  8. obj[prop] = 'baz';
  9. }
  10. };
  11. const proxy = new Proxy(obj, handler);
  12. proxy.foo = 'baz';
  13. proxy.foo // "bar"

上面代码中,obj.foo属性不可写,Proxy 对这个属性的set代理将不会生效。

注意,严格模式下,set代理如果没有返回true,就会报错。

  1. 'use strict';
  2. const handler = {
  3. set: function(obj, prop, value, receiver) {
  4. obj[prop] = receiver;
  5. // 无论有没有下面这一行,都会报错
  6. return false;
  7. }
  8. };
  9. const proxy = new Proxy({}, handler);
  10. proxy.foo = 'bar';
  11. // TypeError: 'set' on proxy: trap returned falsish for property 'foo'

上面代码中,严格模式下,set代理返回false或者undefined,都会报错。

apply()

apply方法拦截函数的调用、callapply操作。

apply方法可以接受三个参数,分别是目标对象、目标对象的上下文对象(this)和目标对象的参数数组。

  1. var handler = {
  2. apply (target, ctx, args) {
  3. return Reflect.apply(...arguments);
  4. }
  5. };

下面是一个例子。

  1. var target = function () { return 'I am the target'; };
  2. var handler = {
  3. apply: function () {
  4. return 'I am the proxy';
  5. }
  6. };
  7. var p = new Proxy(target, handler);
  8. p()
  9. // "I am the proxy"

上面代码中,变量p是 Proxy 的实例,当它作为函数调用时(p()),就会被apply方法拦截,返回一个字符串。

下面是另外一个例子。

  1. var twice = {
  2. apply (target, ctx, args) {
  3. return Reflect.apply(...arguments) * 2;
  4. }
  5. };
  6. function sum (left, right) {
  7. return left + right;
  8. };
  9. var proxy = new Proxy(sum, twice);
  10. proxy(1, 2) // 6
  11. proxy.call(null, 5, 6) // 22
  12. proxy.apply(null, [7, 8]) // 30

上面代码中,每当执行proxy函数(直接调用或callapply调用),就会被apply方法拦截。

另外,直接调用Reflect.apply方法,也会被拦截。

  1. Reflect.apply(proxy, null, [9, 10]) // 38

has()

has()方法用来拦截HasProperty操作,即判断对象是否具有某个属性时,这个方法会生效。典型的操作就是in运算符。

has()方法可以接受两个参数,分别是目标对象、需查询的属性名。

下面的例子使用has()方法隐藏某些属性,不被in运算符发现。

  1. var handler = {
  2. has (target, key) {
  3. if (key[0] === '_') {
  4. return false;
  5. }
  6. return key in target;
  7. }
  8. };
  9. var target = { _prop: 'foo', prop: 'foo' };
  10. var proxy = new Proxy(target, handler);
  11. '_prop' in proxy // false

上面代码中,如果原对象的属性名的第一个字符是下划线,proxy.has()就会返回false,从而不会被in运算符发现。

如果原对象不可配置或者禁止扩展,这时has()拦截会报错。

  1. var obj = { a: 10 };
  2. Object.preventExtensions(obj);
  3. var p = new Proxy(obj, {
  4. has: function(target, prop) {
  5. return false;
  6. }
  7. });
  8. 'a' in p // TypeError is thrown

上面代码中,obj对象禁止扩展,结果使用has拦截就会报错。也就是说,如果某个属性不可配置(或者目标对象不可扩展),则has()方法就不得“隐藏”(即返回false)目标对象的该属性。

值得注意的是,has()方法拦截的是HasProperty操作,而不是HasOwnProperty操作,即has()方法不判断一个属性是对象自身的属性,还是继承的属性。

另外,虽然for...in循环也用到了in运算符,但是has()拦截对for...in循环不生效。

  1. let stu1 = {name: '张三', score: 59};
  2. let stu2 = {name: '李四', score: 99};
  3. let handler = {
  4. has(target, prop) {
  5. if (prop === 'score' && target[prop] < 60) {
  6. console.log(`${target.name} 不及格`);
  7. return false;
  8. }
  9. return prop in target;
  10. }
  11. }
  12. let oproxy1 = new Proxy(stu1, handler);
  13. let oproxy2 = new Proxy(stu2, handler);
  14. 'score' in oproxy1
  15. // 张三 不及格
  16. // false
  17. 'score' in oproxy2
  18. // true
  19. for (let a in oproxy1) {
  20. console.log(oproxy1[a]);
  21. }
  22. // 张三
  23. // 59
  24. for (let b in oproxy2) {
  25. console.log(oproxy2[b]);
  26. }
  27. // 李四
  28. // 99

上面代码中,has()拦截只对in运算符生效,对for...in循环不生效,导致不符合要求的属性没有被for...in循环所排除。

construct()

construct()方法用于拦截new命令,下面是拦截对象的写法。

  1. const handler = {
  2. construct (target, args, newTarget) {
  3. return new target(...args);
  4. }
  5. };

construct()方法可以接受三个参数。

  • target:目标对象。
  • args:构造函数的参数数组。
  • newTarget:创造实例对象时,new命令作用的构造函数(下面例子的p)。
  1. const p = new Proxy(function () {}, {
  2. construct: function(target, args) {
  3. console.log('called: ' + args.join(', '));
  4. return { value: args[0] * 10 };
  5. }
  6. });
  7. (new p(1)).value
  8. // "called: 1"
  9. // 10

construct()方法返回的必须是一个对象,否则会报错。

  1. const p = new Proxy(function() {}, {
  2. construct: function(target, argumentsList) {
  3. return 1;
  4. }
  5. });
  6. new p() // 报错
  7. // Uncaught TypeError: 'construct' on proxy: trap returned non-object ('1')

另外,由于construct()拦截的是构造函数,所以它的目标对象必须是函数,否则就会报错。

  1. const p = new Proxy({}, {
  2. construct: function(target, argumentsList) {
  3. return {};
  4. }
  5. });
  6. new p() // 报错
  7. // Uncaught TypeError: p is not a constructor

上面例子中,拦截的目标对象不是一个函数,而是一个对象(new Proxy()的第一个参数),导致报错。

注意,construct()方法中的this指向的是handler,而不是实例对象。

  1. const handler = {
  2. construct: function(target, args) {
  3. console.log(this === handler);
  4. return new target(...args);
  5. }
  6. }
  7. let p = new Proxy(function () {}, handler);
  8. new p() // true

deleteProperty()

deleteProperty方法用于拦截delete操作,如果这个方法抛出错误或者返回false,当前属性就无法被delete命令删除。

  1. var handler = {
  2. deleteProperty (target, key) {
  3. invariant(key, 'delete');
  4. delete target[key];
  5. return true;
  6. }
  7. };
  8. function invariant (key, action) {
  9. if (key[0] === '_') {
  10. throw new Error(`Invalid attempt to ${action} private "${key}" property`);
  11. }
  12. }
  13. var target = { _prop: 'foo' };
  14. var proxy = new Proxy(target, handler);
  15. delete proxy._prop
  16. // Error: Invalid attempt to delete private "_prop" property

上面代码中,deleteProperty方法拦截了delete操作符,删除第一个字符为下划线的属性会报错。

注意,目标对象自身的不可配置(configurable)的属性,不能被deleteProperty方法删除,否则报错。

defineProperty()

defineProperty()方法拦截了Object.defineProperty()操作。

  1. var handler = {
  2. defineProperty (target, key, descriptor) {
  3. return false;
  4. }
  5. };
  6. var target = {};
  7. var proxy = new Proxy(target, handler);
  8. proxy.foo = 'bar' // 不会生效

上面代码中,defineProperty()方法内部没有任何操作,只返回false,导致添加新属性总是无效。注意,这里的false只是用来提示操作失败,本身并不能阻止添加新属性。

注意,如果目标对象不可扩展(non-extensible),则defineProperty()不能增加目标对象上不存在的属性,否则会报错。另外,如果目标对象的某个属性不可写(writable)或不可配置(configurable),则defineProperty()方法不得改变这两个设置。

getOwnPropertyDescriptor()

getOwnPropertyDescriptor()方法拦截Object.getOwnPropertyDescriptor(),返回一个属性描述对象或者undefined

  1. var handler = {
  2. getOwnPropertyDescriptor (target, key) {
  3. if (key[0] === '_') {
  4. return;
  5. }
  6. return Object.getOwnPropertyDescriptor(target, key);
  7. }
  8. };
  9. var target = { _foo: 'bar', baz: 'tar' };
  10. var proxy = new Proxy(target, handler);
  11. Object.getOwnPropertyDescriptor(proxy, 'wat')
  12. // undefined
  13. Object.getOwnPropertyDescriptor(proxy, '_foo')
  14. // undefined
  15. Object.getOwnPropertyDescriptor(proxy, 'baz')
  16. // { value: 'tar', writable: true, enumerable: true, configurable: true }

上面代码中,handler.getOwnPropertyDescriptor()方法对于第一个字符为下划线的属性名会返回undefined

getPrototypeOf()

getPrototypeOf()方法主要用来拦截获取对象原型。具体来说,拦截下面这些操作。

  • Object.prototype.__proto__
  • Object.prototype.isPrototypeOf()
  • Object.getPrototypeOf()
  • Reflect.getPrototypeOf()
  • instanceof

下面是一个例子。

  1. var proto = {};
  2. var p = new Proxy({}, {
  3. getPrototypeOf(target) {
  4. return proto;
  5. }
  6. });
  7. Object.getPrototypeOf(p) === proto // true

上面代码中,getPrototypeOf()方法拦截Object.getPrototypeOf(),返回proto对象。

注意,getPrototypeOf()方法的返回值必须是对象或者null,否则报错。另外,如果目标对象不可扩展(non-extensible), getPrototypeOf()方法必须返回目标对象的原型对象。

isExtensible()

isExtensible()方法拦截Object.isExtensible()操作。

  1. var p = new Proxy({}, {
  2. isExtensible: function(target) {
  3. console.log("called");
  4. return true;
  5. }
  6. });
  7. Object.isExtensible(p)
  8. // "called"
  9. // true

上面代码设置了isExtensible()方法,在调用Object.isExtensible时会输出called

注意,该方法只能返回布尔值,否则返回值会被自动转为布尔值。

这个方法有一个强限制,它的返回值必须与目标对象的isExtensible属性保持一致,否则就会抛出错误。

  1. Object.isExtensible(proxy) === Object.isExtensible(target)

下面是一个例子。

  1. var p = new Proxy({}, {
  2. isExtensible: function(target) {
  3. return false;
  4. }
  5. });
  6. Object.isExtensible(p)
  7. // Uncaught TypeError: 'isExtensible' on proxy: trap result does not reflect extensibility of proxy target (which is 'true')

ownKeys()

ownKeys()方法用来拦截对象自身属性的读取操作。具体来说,拦截以下操作。

  • Object.getOwnPropertyNames()
  • Object.getOwnPropertySymbols()
  • Object.keys()
  • for...in循环

下面是拦截Object.keys()的例子。

  1. let target = {
  2. a: 1,
  3. b: 2,
  4. c: 3
  5. };
  6. let handler = {
  7. ownKeys(target) {
  8. return ['a'];
  9. }
  10. };
  11. let proxy = new Proxy(target, handler);
  12. Object.keys(proxy)
  13. // [ 'a' ]

上面代码拦截了对于target对象的Object.keys()操作,只返回abc三个属性之中的a属性。

下面的例子是拦截第一个字符为下划线的属性名。

  1. let target = {
  2. _bar: 'foo',
  3. _prop: 'bar',
  4. prop: 'baz'
  5. };
  6. let handler = {
  7. ownKeys (target) {
  8. return Reflect.ownKeys(target).filter(key => key[0] !== '_');
  9. }
  10. };
  11. let proxy = new Proxy(target, handler);
  12. for (let key of Object.keys(proxy)) {
  13. console.log(target[key]);
  14. }
  15. // "baz"

注意,使用Object.keys()方法时,有三类属性会被ownKeys()方法自动过滤,不会返回。

  • 目标对象上不存在的属性
  • 属性名为 Symbol 值
  • 不可遍历(enumerable)的属性
  1. let target = {
  2. a: 1,
  3. b: 2,
  4. c: 3,
  5. [Symbol.for('secret')]: '4',
  6. };
  7. Object.defineProperty(target, 'key', {
  8. enumerable: false,
  9. configurable: true,
  10. writable: true,
  11. value: 'static'
  12. });
  13. let handler = {
  14. ownKeys(target) {
  15. return ['a', 'd', Symbol.for('secret'), 'key'];
  16. }
  17. };
  18. let proxy = new Proxy(target, handler);
  19. Object.keys(proxy)
  20. // ['a']

上面代码中,ownKeys()方法之中,显式返回不存在的属性(d)、Symbol 值(Symbol.for('secret'))、不可遍历的属性(key),结果都被自动过滤掉。

ownKeys()方法还可以拦截Object.getOwnPropertyNames()

  1. var p = new Proxy({}, {
  2. ownKeys: function(target) {
  3. return ['a', 'b', 'c'];
  4. }
  5. });
  6. Object.getOwnPropertyNames(p)
  7. // [ 'a', 'b', 'c' ]

for...in循环也受到ownKeys()方法的拦截。

  1. const obj = { hello: 'world' };
  2. const proxy = new Proxy(obj, {
  3. ownKeys: function () {
  4. return ['a', 'b'];
  5. }
  6. });
  7. for (let key in proxy) {
  8. console.log(key); // 没有任何输出
  9. }

上面代码中,ownkeys()指定只返回ab属性,由于obj没有这两个属性,因此for...in循环不会有任何输出。

ownKeys()方法返回的数组成员,只能是字符串或 Symbol 值。如果有其他类型的值,或者返回的根本不是数组,就会报错。

  1. var obj = {};
  2. var p = new Proxy(obj, {
  3. ownKeys: function(target) {
  4. return [123, true, undefined, null, {}, []];
  5. }
  6. });
  7. Object.getOwnPropertyNames(p)
  8. // Uncaught TypeError: 123 is not a valid property name

上面代码中,ownKeys()方法虽然返回一个数组,但是每一个数组成员都不是字符串或 Symbol 值,因此就报错了。

如果目标对象自身包含不可配置的属性,则该属性必须被ownKeys()方法返回,否则报错。

  1. var obj = {};
  2. Object.defineProperty(obj, 'a', {
  3. configurable: false,
  4. enumerable: true,
  5. value: 10 }
  6. );
  7. var p = new Proxy(obj, {
  8. ownKeys: function(target) {
  9. return ['b'];
  10. }
  11. });
  12. Object.getOwnPropertyNames(p)
  13. // Uncaught TypeError: 'ownKeys' on proxy: trap result did not include 'a'

上面代码中,obj对象的a属性是不可配置的,这时ownKeys()方法返回的数组之中,必须包含a,否则会报错。

另外,如果目标对象是不可扩展的(non-extensible),这时ownKeys()方法返回的数组之中,必须包含原对象的所有属性,且不能包含多余的属性,否则报错。

  1. var obj = {
  2. a: 1
  3. };
  4. Object.preventExtensions(obj);
  5. var p = new Proxy(obj, {
  6. ownKeys: function(target) {
  7. return ['a', 'b'];
  8. }
  9. });
  10. Object.getOwnPropertyNames(p)
  11. // Uncaught TypeError: 'ownKeys' on proxy: trap returned extra keys but proxy target is non-extensible

上面代码中,obj对象是不可扩展的,这时ownKeys()方法返回的数组之中,包含了obj对象的多余属性b,所以导致了报错。

preventExtensions()

preventExtensions()方法拦截Object.preventExtensions()。该方法必须返回一个布尔值,否则会被自动转为布尔值。

这个方法有一个限制,只有目标对象不可扩展时(即Object.isExtensible(proxy)false),proxy.preventExtensions才能返回true,否则会报错。

  1. var proxy = new Proxy({}, {
  2. preventExtensions: function(target) {
  3. return true;
  4. }
  5. });
  6. Object.preventExtensions(proxy)
  7. // Uncaught TypeError: 'preventExtensions' on proxy: trap returned truish but the proxy target is extensible

上面代码中,proxy.preventExtensions()方法返回true,但这时Object.isExtensible(proxy)会返回true,因此报错。

为了防止出现这个问题,通常要在proxy.preventExtensions()方法里面,调用一次Object.preventExtensions()

  1. var proxy = new Proxy({}, {
  2. preventExtensions: function(target) {
  3. console.log('called');
  4. Object.preventExtensions(target);
  5. return true;
  6. }
  7. });
  8. Object.preventExtensions(proxy)
  9. // "called"
  10. // Proxy {}

setPrototypeOf()

setPrototypeOf()方法主要用来拦截Object.setPrototypeOf()方法。

下面是一个例子。

  1. var handler = {
  2. setPrototypeOf (target, proto) {
  3. throw new Error('Changing the prototype is forbidden');
  4. }
  5. };
  6. var proto = {};
  7. var target = function () {};
  8. var proxy = new Proxy(target, handler);
  9. Object.setPrototypeOf(proxy, proto);
  10. // Error: Changing the prototype is forbidden

上面代码中,只要修改target的原型对象,就会报错。

注意,该方法只能返回布尔值,否则会被自动转为布尔值。另外,如果目标对象不可扩展(non-extensible),setPrototypeOf()方法不得改变目标对象的原型。

Proxy.revocable()

Proxy.revocable()方法返回一个可取消的 Proxy 实例。

  1. let target = {};
  2. let handler = {};
  3. let {proxy, revoke} = Proxy.revocable(target, handler);
  4. proxy.foo = 123;
  5. proxy.foo // 123
  6. revoke();
  7. proxy.foo // TypeError: Revoked

Proxy.revocable()方法返回一个对象,该对象的proxy属性是Proxy实例,revoke属性是一个函数,可以取消Proxy实例。上面代码中,当执行revoke函数之后,再访问Proxy实例,就会抛出一个错误。

Proxy.revocable()的一个使用场景是,目标对象不允许直接访问,必须通过代理访问,一旦访问结束,就收回代理权,不允许再次访问。

this 问题

虽然 Proxy 可以代理针对目标对象的访问,但它不是目标对象的透明代理,即不做任何拦截的情况下,也无法保证与目标对象的行为一致。主要原因就是在 Proxy 代理的情况下,目标对象内部的this关键字会指向 Proxy 代理。

  1. const target = {
  2. m: function () {
  3. console.log(this === proxy);
  4. }
  5. };
  6. const handler = {};
  7. const proxy = new Proxy(target, handler);
  8. target.m() // false
  9. proxy.m() // true

上面代码中,一旦proxy代理targettarget.m()内部的this就是指向proxy,而不是target

下面是一个例子,由于this指向的变化,导致 Proxy 无法代理目标对象。

  1. const _name = new WeakMap();
  2. class Person {
  3. constructor(name) {
  4. _name.set(this, name);
  5. }
  6. get name() {
  7. return _name.get(this);
  8. }
  9. }
  10. const jane = new Person('Jane');
  11. jane.name // 'Jane'
  12. const proxy = new Proxy(jane, {});
  13. proxy.name // undefined

上面代码中,目标对象janename属性,实际保存在外部WeakMap对象_name上面,通过this键区分。由于通过proxy.name访问时,this指向proxy,导致无法取到值,所以返回undefined

此外,有些原生对象的内部属性,只有通过正确的this才能拿到,所以 Proxy 也无法代理这些原生对象的属性。

  1. const target = new Date();
  2. const handler = {};
  3. const proxy = new Proxy(target, handler);
  4. proxy.getDate();
  5. // TypeError: this is not a Date object.

上面代码中,getDate()方法只能在Date对象实例上面拿到,如果this不是Date对象实例就会报错。这时,this绑定原始对象,就可以解决这个问题。

  1. const target = new Date('2015-01-01');
  2. const handler = {
  3. get(target, prop) {
  4. if (prop === 'getDate') {
  5. return target.getDate.bind(target);
  6. }
  7. return Reflect.get(target, prop);
  8. }
  9. };
  10. const proxy = new Proxy(target, handler);
  11. proxy.getDate() // 1

另外,Proxy 拦截函数内部的this,指向的是handler对象。

  1. const handler = {
  2. get: function (target, key, receiver) {
  3. console.log(this === handler);
  4. return 'Hello, ' + key;
  5. },
  6. set: function (target, key, value) {
  7. console.log(this === handler);
  8. target[key] = value;
  9. return true;
  10. }
  11. };
  12. const proxy = new Proxy({}, handler);
  13. proxy.foo
  14. // true
  15. // Hello, foo
  16. proxy.foo = 1
  17. // true

上面例子中,get()set()拦截函数内部的this,指向的都是handler对象。

实例:Web 服务的客户端

Proxy 对象可以拦截目标对象的任意属性,这使得它很合适用来写 Web 服务的客户端。

  1. const service = createWebService('http://example.com/data');
  2. service.employees().then(json => {
  3. const employees = JSON.parse(json);
  4. // ···
  5. });

上面代码新建了一个 Web 服务的接口,这个接口返回各种数据。Proxy 可以拦截这个对象的任意属性,所以不用为每一种数据写一个适配方法,只要写一个 Proxy 拦截就可以了。

  1. function createWebService(baseUrl) {
  2. return new Proxy({}, {
  3. get(target, propKey, receiver) {
  4. return () => httpGet(baseUrl + '/' + propKey);
  5. }
  6. });
  7. }

同理,Proxy 也可以用来实现数据库的 ORM 层。