pspxuan

ES6 Proxy实例拦截方法详解

此文参考学习于阮一峰老师《ES6入门》，更多特性以及方法可以点击查看

1.get（）

get方法用于拦截某个属性的读取操作，可以接受三个参数

target：目标对象
propKey：属性名
receiver（可选）：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对象继承的属性时，拦截会生效。

2.set()

set方法用来拦截某个属性的赋值操作

target：目标对象
propKey：属性名
propValue：属性值
receiver（可选）：proxy 实例本身（原始的操作行为所在的那个对象，简单来说，如果要调用一个属性，谁调用了那个属性，receiver就是谁）

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

上述代码中的Number.isInteger()方法用来判断给定的参数是否为整数。返回布尔值

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

const handler = {
  set: function(obj, prop, value, receiver) {
    obj[prop] = receiver;
  }
};
const proxy = new Proxy({}, handler);
const myObj = {};
Object.setPrototypeOf(myObj, proxy);

myObj.foo = 'bar';
myObj.foo === myObj // true

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

注意，如果目标对象自身的某个属性，不可写且不可配置，那么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"

Object.defineProperty(obj, prop, descriptor)
obj：要在其上定义属性的对象。
prop：要定义或修改的属性的名称。
descriptor：定义或修改的属性描述符（属性的描述对象）。

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

3.apply()

apply方法拦截函数的调用、call和apply操作。可以接受三个参数

target：目标对象
ctx：目标对象的上下文对象（this）
arguments：目标对象的参数数组。

var target = function () { return 'I am the target'; };
var handler = {
  apply: function () {
    return 'I am the proxy';
  }
};
var p = new Proxy(target, handler);
console.log(p())//I am the proxy

上述代码，执行 p() 时被apply拦截操作后输出 I am the proxy 。若 handler 中为一个空对象，执行 p() 则直接指向target目标函数执行，输出 I am the target

4.has()

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

has 方法可以接受两个参数

target：目标对象
Key：需查询的属性名。

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

in 运算符（key in obj） ：监测 obj 中是否有指定的key(键名)，返回一个布尔值

上面代码中，如果原对象的属性名的第一个字符是下划线，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

Object.preventExtensions（obj）方法防止将新属性添加到 obj（即，防止将来对该 obj 进行扩展）。

注意：

has 方法拦截的是HasProperty操作，而不是HasOwnProperty操作，即 has 方法不判断一个属性是对象自身的属性，还是继承的属性。
另外，虽然for...in 循环也用到了in运算符，但是 has 拦截对for...in循环不生效。

5.construct()

construct方法用于拦截new命令,接受两个参数。

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方法返回的必须是一个对象，否则会报错。

6.deleteProperty()

deleteProperty方法用于拦截 delete 操作，如果使用这个方法，当前属性就无法被delete 命令删除。
接收两个参数，返回一个 Boolean 类型的值

target：目标对象。
prop：待删除的属性名。

var p = new Proxy({a:1}, {
  deleteProperty: function(target, prop) {
    console.log('called: ' + prop);
    return true;
  }
});

delete p.a; //called: a
console.log(p)//Proxy {a: 1}

上面代码中，deleteProperty方法拦截了delete操作符
注意：

目标对象自身的不可配置（configurable）的属性，不能被deleteProperty方法删除，否则报错。

7.defineProperty()

用于拦截对对象的 Object.defineProperty() 操作。简单来说，就是向对象添加和修改属性时会触发拦截
下列参数将会被传递给 defineProperty 方法。 this 绑定在 handler 对象上。

target：目标对象。
property：待检索其描述的属性名。
descriptor：待定义或修改的属性的描述符。

var handler = {
  defineProperty (target, key, descriptor) {
    return false;
  }
};
var target = {};
var proxy = new Proxy(target, handler);
proxy.foo = 'bar' // 不会生效

上面代码中，defineProperty 方法返回 false，导致添加新属性总是无效。
注意：

如果目标对象不可扩展（non-extensible），则defineProperty不能增加目标对象上不存在的属性，否则会报错。

默认情况下，对象是可扩展的，
使用Object.preventExtensions，Object.seal 或 Object.freeze 方法都可以标记一个对象为不可扩展（non-extensible）。

另外，如果目标对象的某个属性不可写（writable）或不可配置（configurable），则defineProperty方法不得改变这两个设置。

8.getOwnPropertyDescriptor()

getOwnPropertyDescriptor方法拦截Object.getOwnPropertyDescriptor()，返回一个属性描述对象或者undefined。
有两个参数

target：目标对象。
prop：应检索其描述的属性名称。

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。

Object.getOwnPropertyDescriptor() 方法返回指定对象上一个自有属性对应的描述对象
obj：需要查找的目标对象
prop：目标对象内属性名称
若指定的属性不存在于对象，则返回 undefined。

9.getPrototypeOf()

当 getPrototypeOf 方法被调用时，this 指向的是它所属的处理器对象。
只有一个参数

target ：被代理的目标对象

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方法必须返回目标对象的原型对象。

10.isExtensible()

isExtensible方法拦截Object.isExtensible操作。只有一个参数

target：目标对象

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

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

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

var p = new Proxy({}, {
  isExtensible: function(target) {
    return false;
  }
});

Object.isExtensible(p)
// Uncaught TypeError: 'isExtensible' on proxy: trap result does not reflect extensibility of proxy target (which is 'true')

Object.isExtensible() 方法判断一个对象是否是可扩展的（是否可以在它上面添加新的属性）。返回布尔值
参数
obj：需要检测的对象

11.ownKeys()

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

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

参数：target：目标对象

12.preventExtensions()

preventExtensions方法拦截Object.preventExtensions()。该方法必须返回一个布尔值，否则会被自动转为布尔值。
这个方法有一个限制，只有目标对象不可扩展时（即Object.isExtensible(proxy)为false），proxy.preventExtensions才能返回true，否则会报错。

var proxy = new Proxy({}, {
  preventExtensions: function(target) {
    return true;
  }
});

Object.preventExtensions(proxy)
// Uncaught TypeError: 'preventExtensions' on proxy: trap returned truish but the proxy target is extensible

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

var proxy = new Proxy({}, {
  preventExtensions: function(target) {
    console.log('called');
    Object.preventExtensions(target);
    return true;
  }
});

Object.preventExtensions(proxy)
// "called"
// Proxy {}

Object.preventExtensions( obj ) 方法让一个对象变的不可扩展，也就是永远不能再添加新的属性。

13.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