Proxy

作者: 范小饭_ | 来源:发表于2020-05-07 16:29 被阅读0次

    众所周知,vue3.0快要来了,用ts进行了重构,而且用Proxy替代了Object.defineProperty(),所以在3.0真的到来之前,先了解一下Proxy。

    Proxy

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

    Proxy 可以理解成,在目标对象之前架设一层“拦截”,外界对该对象的访问,都必须先通过这层拦截,因此提供了一种机制,可以对外界的访问进行过滤和改写。

    ES6 原生提供 Proxy 构造函数,用来生成 Proxy 实例
    var proxy = new Proxy(target, handler);

    new Proxy()表示生成一个Proxy实例,target参数表示所要拦截的目标对象,handler是一个配置的对象,对于每一个被代理的操作,需要提供一个对应的处理函数,该函数将拦截对应的操作。

    要使得Proxy起作用,必须针对Proxy实例(上例是proxy对象)进行操作,而不是针对目标对象(上例是空对象)进行操作。如果handler没有设置任何拦截,那就等同于直接通向原对象。

    下面看下handler支持配置的链接操作

        let obj = new Proxy({}, {
            // 拦截对象属性的读取,比如proxy.foo和proxy['foo']
            get: function (target, propKey, receiver) {
                console.log('sonme code ....')
            },
            // 拦截对象属性的设置,比如proxy.foo = v或proxy['foo'] = v,返回一个布尔值
            set: function (target, propKey, value, receiver) {
                console.log('sonme code ....')
            },
            // 拦截propKey in proxy的操作,返回一个布尔值
            has: function (target, propKey, receiver) {
                console.log('sonme code ....')
            },
            // 拦截delete proxy[propKey]的操作,返回一个布尔值。
            deleteProperty: function (target, propKey) {
                console.log('sonme code ....')
            },
            // 拦截Object.getOwnPropertyNames(proxy)、Object.getOwnPropertySymbols(proxy)、Object.keys(proxy)、for...in循环,
            // 返回一个数组。该方法返回目标对象所有自身的属性的属性名,
            // 而Object.keys()的返回结果仅包括目标对象自身的可遍历属性。
            ownKeys:function(target){
                console.log('sonme code ....')
            },
            // 拦截Object.getOwnPropertyDescriptor(proxy, propKey),返回属性的描述对象
            getOwnPropertyDescriptor: function (target, propKey) {
                console.log('sonme code ....')
            },
            // 拦截Object.defineProperty(proxy, propKey, propDesc)、Object.defineProperties(proxy, propDescs),返回一个布尔值。
            defineProperty: function (target, propKey, propDesc) {
                console.log('sonme code ....')
            },
            // 拦截Object.preventExtensions(proxy),返回一个布尔值。
            preventExtensions: function (target) {
                console.log('sonme code ....')
            },
            // 拦截Object.getPrototypeOf(proxy),返回一个对象
            getPrototypeOf: function (target) {
                console.log('sonme code ....')
            },
            // 拦截Object.isExtensible(proxy),返回一个布尔值。
            isExtensible: function (target) {
                console.log('sonme code ....')
            },
            // 拦截Object.setPrototypeOf(proxy, proto),返回一个布尔值。
            // 如果目标对象是函数,那么还有两种额外操作可以拦截。
            setPrototypeOf: function (target, proto) {
                console.log('sonme code ....')
            },
            // 拦截 Proxy 实例作为函数调用的操作,比如proxy(...args)、
            // proxy.call(object, ...args)、proxy.apply(...)。
            apply: function (target, object, args) {
                console.log('sonme code ....')
            },
            // 拦截 Proxy 实例作为构造函数调用的操作,比如new proxy(...args)。
            construct:function (target, args) {
    
            }
        });
    

    下面详细介绍一下这些拦截方法

    get()

    get方法用于拦截某个属性的读取操作,可以接受三个参数,依次为目标对象、属性名和 proxy 实例本身(严格地说,是操作行为所针对的对象),其中最后一个参数可选

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

    function createArray(...elements) {
      let handler = {
        get(target, propKey, receiver) {
          let index = Number(propKey);
          if (index < 0) {
            propKey = String(target.length + index);
          }
          return Reflect.get(target, propKey, receiver);
        }
      };
    
      let target = [];
      target.push(...elements);
      return new Proxy(target, handler);
    }
    
    let arr = createArray('a', 'b', 'c');
    arr[-1] // c
    

    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 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方法拦截,返回一个字符串。

    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
    

    如果原对象不可配置或者禁止扩展,has拦截会报错.

    construct()
    construct方法用于拦截new命令,construct方法可以接受三个参数。
    target:目标对象
    args:构造函数的参数对象
    newTarget:创造实例对象时,new命令作用的构造函数
    construct方法返回的必须是一个对象,否则会报错。

    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
    

    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
    

    目标对象自身的不可配置(configurable)的属性,不能被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,导致添加新属性总是无效.
    如果目标对象不可扩展(non-extensible),则defineProperty不能增加目标对象上不存在的属性,否则会报错。另外,如果目标对象的某个属性不可写(writable)或不可配置(configurable),则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 }
    

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

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

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

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

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

    ownKeys()
    ownKeys方法用来拦截对象自身属性的读取操作。具体来说,拦截以下操作。
    Object.getOwnPropertyNames()
    Object.getOwnPropertySymbols()
    Object.keys()
    for...in循环

    let target = {
      a: 1,
      b: 2,
      c: 3
    };
    
    let handler = {
      ownKeys(target) {
        return ['a'];
      }
    };
    
    let proxy = new Proxy(target, handler);
    
    Object.keys(proxy)
    // [ 'a' ]
    

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

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

    var proxy = new Proxy({}, {
      preventExtensions: function(target) {
        console.log('called');
    // 为了防止出现这个问题,通常要在proxy.preventExtensions方法里面,调用一次Object.preventExtensions
        Object.preventExtensions(target);
        return true;
      }
    });
    
    Object.preventExtensions(proxy)
    // "called"
    // Proxy {}
    

    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
    

    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 代理的情况下,目标对象内部的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

    兼容性

    image.png

    本文参考:
    ECMAScript6 入门

    相关文章

      网友评论

        本文标题:Proxy

        本文链接:https://www.haomeiwen.com/subject/ekpoghtx.html