zoukankan      html  css  js  c++  java
  • ES6的Proxy对象

    Proxy在目标对象之前架设一层拦截,外部所有的访问都必须先通过这层拦截,因此提供了一种机制,可以对外部的访问进行过滤和修改。

    ES6原生提供了Proxy构造函数,用来生成Proxy实例。下面代码中proxy代理target。

    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对象也可以作为其它对象的原型对象。下面代码中,proxy对象是obj的原型对象,obj本身并没有time属性,所以根据原型链,会在proxy对象上读取属性,从而被拦截。

    var proxy = new Proxy({}, {
      get: function(target, property) {
        return 35;
      }
    });
    
    let obj = Object.create(proxy);
    obj.time    // 35

    Proxy的实例方法(支持拦截的操作),一共有13种:

    get(target, propKey, receiver)
    set(target, propKey, value, receiver)
    has(target, propKey)
    deleteProperty(target, propKey)
    ownKeys(target)
    getOwnPropertyDescriptor(target, propKey)
    defineProperty(target, propKey, propDesc)
    preventExtensions(target)
    getPrototypeOf(target)
    isExtensible(target)
    setPrototypeOf(target, proto)
    apply(target, object, args)
    construct(target, args)

    get()

    get方法用于拦截某个属性的读取操作,可以接收三个参数,依次为目标对象,属性名和Proxy实例本身,其中最后一个参数可选。

    下面代码表示如果有这个属性则返回属性值,如没有就会输出111,如果没有这个拦截,没有属性会返回undefined。

    var person = {
      name: "张三"
    };
    
    var proxy = new Proxy(person, {
      get: function(target, property) {
        if (property in target) {
          return target[property];
        } else {
          console.log(111)
        }
      }
    });
    
    proxy.name   // "张三"
    proxy.age   // 111

    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');   // 报错1
          }
          if (value > 200) {
            throw new RangeError('The age seems invalid');   //报错2
          }
        }
    
        // 对于满足条件的 age 属性以及其他属性,直接保存
        obj[prop] = value;
      }
    };
    
    let person = new Proxy({}, validator);
    
    person.age = 100;
    
    person.age // 100
    person.age = 'young'   // 报错1 
    person.age = 300   // 报错2
    const handler = {
      set: function(obj, prop, value, receiver) {
        obj[prop] = receiver;
      }
    };
    const proxy = new Proxy({}, handler);
    proxy.foo = 'bar';
    proxy.foo === proxy   // true

    apply()

    apply方法拦截函数的调用、call和apply操作。apply方法可以接收三个参数,依次是目标对象,目标对象的上下文对象(this)和目标对象的参数数组。

    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"

    has()

    has方法用来拦截Hasproperty操作,即判断对象是否有某个属性时,这个方法会生效。典型的操作就是in操作。has方法可以接收两个参数,分别是目标对象,需查询的属性名。

    下面代码中,如原对象的属性名的第一个字符是下划线,则返回false。

    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

    对象不可配置或禁止扩展时,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

    has方法拦截的是hasProperty操作,而不是hasOwnProperty操作,即不判断一个属性是自身的属性还是继承属性。

    has方法只对in运算符生效,而不对for...in循环生效,如下。

    construct()

    construct方法用于拦截new命令,下面是拦截对象的写法。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命令删除。当目标对象的不可配置(configruable)的属性时,不能被deleteProperty方法拦截,会报错。下面代码中,deleteProperty方法拦截了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

    defineProperty()

    defineProperty方法拦截的Object.defineProperty操作。如果目标对象不可扩展(extensible),则defineProperty不能增加目标对象上不存在的属性,否则会报错。另外,如果目标对象不可配置或不可写,则defineProperty方法不得改变这两个设置。上面代码中,defineProperty方法返回false,导致添加新属性总是无效。

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

    getOwnPropertyDescriptor()

    getOwnPropertyDescriptor方法是拦截Object.getOwnPropertyDescriptor,返回一个属性描述对象或者undefined。上面代码中,handler的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 }

    getPropertyOf()  

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

    Object.prototype.__proto__

    Object.prototype.isPrototypeOf()

    Object.getPrototypeOf()

    Reflect.getPrototypeOf()

    instanceOf()

    getPrototypeOf必须返回对象或者null,否则报错。另外如果目标对象不可扩展,getPrototypeOf必须返回目标对象的原型对象。

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

    var proto = {};
    var p = new Proxy({}, {
      getPrototypeOf(target) {
        return proto;
      }
    });
    Object.getPrototypeOf(p) === proto   // true

    isExtensible()

    isExtensible方法拦截Object.isExtensible操作。该方法只能返回布尔值,如果不是将会把返回值自动转化为布尔值。

    下面代码中设置了isExtensible方法,在调用Object.isExtensible是输出called。

    var p = new Proxy({}, {
      isExtensible: function(target) {
        console.log("called");
        return true;
      }
    });
    
    Object.isExtensible(p)
    // "called"
    // true

    还有一个强限制,它的返回值必须与目标对象的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' ]

    在使用Object.keys()时,以下三类属性会被ownKeys方法自动过滤,不会返回:

    1 目标对象不存在的属性

    2 属性名为Symbol值

    3 不可遍历(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' ]

    ownKeys方法拦截for...in循环

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

    如果目标对象是不可扩展的,这时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方法。

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

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

    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

    Proxy.revocable()

    Proxy.revocable方法返回一个可取消的proxy实例。proxy.revocable方法返回一个对象,该对象的proxy属性是proxy实例,revoke属性是一个函数,执行revoke函数可取消proxy实例。下面代码中,当执行revoke函数后,在访问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使用的一个场景,目标对象不允许直接访问,必须通过代理访问,一旦访问结束就收回代理权,不允许再次访问。

    this问题

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

    下面代码中,一旦proxy代理了target.m,后者内部的this则指向了proxy,而不是target。

    const target = {
      m: function () {
        console.log(this === proxy);
      }
    };
    const handler = {};
    
    const proxy = new Proxy(target, handler);
    
    target.m()   // false
    proxy.m()    // true

    而有些原生对象的内部属性,只有通过正确的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);
        }
      });
    }

    原文:https://www.cnblogs.com/kdcg/p/9145385.html

  • 相关阅读:
    winform_webApiSelfHost
    手机访问网站自动跳转到手机版
    Linux常用命令
    css居中
    固定菜单
    BOM操作写法实例
    表格(合并单元格)
    倒计时
    分享到插件
    jquery获得下拉框的值
  • 原文地址:https://www.cnblogs.com/xjy20170907/p/11558920.html
Copyright © 2011-2022 走看看