ES6的proxy记录

作者: chouchou723 | 来源:发表于2018-11-22 10:50 被阅读0次

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

    var handler = {
      get: function(target, name) {
        if (name === 'prototype') {
          return Object.prototype;
        }
        return 'Hello, ' + name;
      },
    
      apply: function(target, thisBinding, args) {
        return args[0];
      },
    
      construct: function(target, args) {
        return {value: args[1]};
      }
    };
    
    var fproxy = new Proxy(function(x, y) {
      return x + y;
    }, handler);
    
    fproxy(1, 2) // 1
    new fproxy(1, 2) // {value: 2}
    fproxy.prototype === Object.prototype // true
    fproxy.foo === "Hello, foo" // true
    

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

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

    var person = {
      name: "chouchou"
    };
    
    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 // "chouchou"
    proxy.age // 抛出一个错误
    

    2.set(target, propKey, value, receiver):拦截对象属性的设置,比如proxy.foo = v或proxy['foo'] = v,返回一个布尔值。
    set方法用来拦截某个属性的赋值操作,可以接受四个参数,依次为目标对象、属性名、属性值和 Proxy 实例本身,其中最后一个参数可选。

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

    3.has(target, propKey):拦截propKey in proxy的操作,返回一个布尔值。
    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
    

    4.deleteProperty(target, propKey):拦截delete proxy[propKey]的操作,返回一个布尔值。
    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
    

    5.ownKeys(target):拦截Object.getOwnPropertyNames(proxy)、Object.getOwnPropertySymbols(proxy)、Object.keys(proxy)、for...in循环,返回一个数组。该方法返回目标对象所有自身的属性的属性名,而Object.keys()的返回结果仅包括目标对象自身的可遍历属性。
    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' ]
    
    //下面的例子是拦截第一个字符为下划线的属性名:
    let target = {
      _bar: 'foo',
      _prop: 'bar',
      prop: 'baz'
    };
    
    let handler = {
      ownKeys (target) {
        return Reflect.ownKeys(target).filter(key => key[0] !== '_');
      }
    };
    
    let proxy = new Proxy(target, handler);
    for (let key of Object.keys(proxy)) {
      console.log(target[key]);
    }
    // "baz"
    

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

    1.目标对象上不存在的属性
    2.属性名为 Symbol 值
    3.不可遍历(enumerable)的属性

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

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

    6.getOwnPropertyDescriptor(target, propKey):拦截Object.getOwnPropertyDescriptor(proxy, propKey),返回属性的描述对象。
    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 }
    

    7.defineProperty(target, propKey, propDesc):拦截Object.defineProperty(proxy, propKey, propDesc)、Object.defineProperties(proxy, propDescs),返回一个布尔值。
    defineProperty方法拦截了Object.defineProperty操作。

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

    8.preventExtensions(target):拦截Object.preventExtensions(proxy),返回一个布尔值。

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

    9.getPrototypeOf(target):拦截Object.getPrototypeOf(proxy),返回一个对象。
    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方法的返回值必须是对象或者null,否则报错
    

    10.isExtensible(target):拦截Object.isExtensible(proxy),返回一个布尔值。
    isExtensible方法拦截Object.isExtensible操作。

    var p = new Proxy({}, {
      isExtensible: function(target) {
        console.log("called");
        return true;
      }
    });
    
    Object.isExtensible(p)
    // "called"
    // true
    //这个方法有一个强限制,它的返回值必须与目标对象的isExtensible属性保持一致,否则就会抛出错误。
    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')
    

    11.setPrototypeOf(target, proto):拦截Object.setPrototypeOf(proxy, proto),返回一个布尔值。如果目标对象是函数,那么还有两种额外操作可以拦截。

    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
    

    12.apply(target, object, args):拦截 Proxy 实例作为函数调用的操作,比如proxy(...args)、proxy.call(object, ...args)、proxy.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"
    
    var twice = {
      apply (target, ctx, args) {
        return Reflect.apply(...arguments) * 2;
      }
    };
    function sum (left, right) {
      return left + right;
    };
    var proxy = new Proxy(sum, twice);//当sum被调用的时候,进入拦截器twice中(1+2)*2
    proxy(1, 2) // 6
    proxy.call(null, 5, 6) // 22
    proxy.apply(null, [7, 8]) // 30
    

    13.construct(target, args,newTarget):拦截 Proxy 实例作为构造函数调用的操作,比如new proxy(...args)。
    construct方法用于拦截new命令,下面是拦截对象的写法。
    construct方法可以接受三个参数,target:目标对象,args:构造函数的参数对象, newTarget:创造实例对象时,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() // 报错
    // Uncaught TypeError: 'construct' on proxy: trap returned non-object ('1')
    

    相关文章

      网友评论

        本文标题:ES6的proxy记录

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