代理

概述

Proxy 用于修改某些操作的默认行为，等同于在语言层面做出修改，所以属于一种“元编程”（meta programming），即对编程语言进行编程。Proxy 可以理解成，在目标对象之前架设一层“拦截”，外界对该对象的访问，都必须先通过这层拦截，因此提供了一种机制，可以对外界的访问进行过滤和改写。Proxy 这个词的原意是代理，用在这里表示由它来“代理”某些操作，可以译为“代理器”。

下面是 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 实例本身（严格地说，是操作行为所针对的对象），其中最后一个参数可选。

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 // 抛出一个错误

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) {

        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 // 报错

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

has()

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

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

下面的例子使用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

construct()

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

var handler = {

  construct (target, args, newTarget) {

    return new target(...args);

  }

};

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

target：目标对象

args：构造函数的参数对象

newTarget：创造实例对象时，new命令作用的构造函数（下面例子的p）

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() // 报错

// Uncaught TypeError: 'construct' on proxy: trap returned non-object ('1')

deleteProperty()

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

var handler = {

  deleteProperty (target, key) {

    invariant(key, 'delete');

    delete target[key];

    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

defineProperty()

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

var handler = {

  defineProperty (target, key, descriptor) {

    return false;

  }

};

var target = {};

var proxy = new Proxy(target, handler);

proxy.foo = 'bar' // 不会生效

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。

getPrototypeOf()

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对象。

注意，getPrototypeOf方法的返回值必须是对象或者null，否则报错。另外，如果目标对象不可扩展（non-extensible）， 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。

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

ownKeys()

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

Object.getOwnPropertyNames() Object.getOwnPropertySymbols() 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' ]