proxy

1.概述

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

varobj=newProxy({}, {

get:function(target,propKey,receiver) {

console.log(`getting ${propKey}!`);

returnReflect.get(target,propKey,receiver);

  },

set:function(target,propKey,value,receiver) {

console.log(`setting ${propKey}!`);

returnReflect.set(target,propKey,value,receiver);

  }

});

上面代码对一个空对象架设了一层拦截,重定义了属性的读取(get)和设置(set)行为。这里暂时先不解释具体的语法,只看运行结果。对设置了拦截行为的对象obj,去读写它的属性,就会得到下面的结果。

obj.count=1

//  setting count!

++obj.count

//  getting count!

//  setting count!

//  2

下面是 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)。

2.proxy实例的方法

get()

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

varperson={

name:"张三"

};

varproxy=newProxy(person, {

get:function(target,propKey) {

if(propKeyintarget) {

returntarget[propKey];

}else{

thrownewReferenceError("Prop name \""+propKey+"\" does not exist.");

   }

  }

});

proxy.name// "张三"

proxy.age// 抛出一个错误

上面代码表示,如果访问目标对象不存在的属性,会抛出一个错误。如果没有这个拦截函数,访问不存在的属性,只会返回undefined。

letproto=newProxy({}, {

get(target,propertyKey,receiver) {

console.log('GET '+propertyKey);

returntarget[propertyKey];

  }

});

letobj=Object.create(proto);

obj.foo// "GET foo"

上面代码中,拦截操作定义在Prototype对象上面,所以如果读取obj对象继承的属性时,拦截会生效。

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

functioncreateArray(...elements) {

lethandler={

get(target,propKey,receiver) {

letindex=Number(propKey);

if(index<0) {

propKey=String(target.length+index);

     }

returnReflect.get(target,propKey,receiver);

   }

  };

lettarget=[];

target.push(...elements);

returnnewProxy(target,handler);

}

letarr=createArray('a','b','c');

arr[-1]// c

上面代码中,数组的位置参数是-1,就会输出数组的倒数第一个成员。

利用 Proxy,可以将读取属性的操作(get),转变为执行某个函数,从而实现属性的链式操作。

varpipe=function(value) {

varfuncStack=[];

varoproxy=newProxy({} , {

get:function(pipeObject,fnName) {

if(fnName==='get') {

returnfuncStack.reduce(function(val,fn) {

returnfn(val);

},value);

     }

funcStack.push(window[fnName]);

returnoproxy;

   }

  });

returnoproxy;

}

vardouble=n=>n*2;

varpow=n=>n*n;

varreverseInt=n=>n.toString().split("").reverse().join("")|0;

pipe(3).double.pow.reverseInt.get;// 63

上面代码设置 Proxy 以后,达到了将函数名链式使用的效果。

下面的例子则是利用get拦截,实现一个生成各种 DOM 节点的通用函数dom。

constdom=newProxy({}, {

get(target,property) {

returnfunction(attrs={},...children) {

constel=document.createElement(property);

for(letpropofObject.keys(attrs)) {

el.setAttribute(prop,attrs[prop]);

     }

for(letchildofchildren) {

if(typeofchild==='string') {

child=document.createTextNode(child);

       }

el.appendChild(child);

     }

returnel;

   }

  }

});

constel=dom.div({},

'Hello, my name is ',

dom.a({href:'//example.com'},'Mark'),

'. I like:',

dom.ul({},

dom.li({},'The web'),

dom.li({},'Food'),

dom.li({},'…actually that\'s it')

  )

);

document.body.appendChild(el);

set()

set方法用来拦截某个属性的赋值操作,可以接受四个参数,依次为目标对象、属性名、属性值和 Proxy 实例本身,其中最后一个参数可选。

假定Person对象有一个age属性,该属性应该是一个不大于 200 的整数,那么可以使用Proxy保证age的属性值符合要求。

letvalidator={

set:function(obj,prop,value) {

if(prop==='age') {

if(!Number.isInteger(value)) {

thrownewTypeError('The age is not an integer');

     }

if(value>200) {

thrownewRangeError('The age seems invalid');

     }

   }

// 对于满足条件的 age 属性以及其他属性,直接保存

obj[prop]=value;

returntrue;

  }

};

letperson=newProxy({},validator);

person.age=100;

person.age// 100

person.age='young'// 报错

person.age=300// 报错

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

有时,我们会在对象上面设置内部属性,属性名的第一个字符使用下划线开头,表示这些属性不应该被外部使用。结合get和set方法,就可以做到防止这些内部属性被外部读写。

const handler = {

get (target, key) {

invariant(key, 'get');

return target[key];

},

set (target, key, value) {

invariant(key, 'set');

target[key] = value;

return true;

}

};

function invariant (key, action) {

if (key[0] === '_') {

throw new Error(`Invalid attempt to ${action} private "${key}" property`);

}

}

const target = {};

const proxy = new Proxy(target, handler);

proxy._prop

// Error: Invalid attempt to get private "_prop" property

proxy._prop = 'c'

// Error: Invalid attempt to set private "_prop" property

上面代码中,只要读写的属性名的第一个字符是下划线,一律抛错,从而达到禁止读写内部属性的目的。

下面是set方法第四个参数的例子。

const handler = {

set: function(obj, prop, value, receiver) {

obj[prop] = receiver;

return true;

}

};

const proxy = new Proxy({}, handler);

proxy.foo = 'bar';

proxy.foo === proxy // true

上面代码中,set方法的第四个参数receiver,指的是原始的操作行为所在的那个对象,一般情况下是proxy实例本身,请看下面的例子。

const handler = {

set: function(obj, prop, value, receiver) {

obj[prop] = receiver;

return true;

}

};

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';

return true;

}

};

const proxy = new Proxy(obj, handler);

proxy.foo = 'baz';

proxy.foo // "bar"

上面代码中,obj.foo属性不可写,Proxy 对这个属性的set代理将不会生效。

注意,set代理应当返回一个布尔值。严格模式下,set代理如果没有返回true,就会报错。

'use strict';

const handler = {

set: function(obj, prop, value, receiver) {

obj[prop] = receiver;

// 无论有没有下面这一行,都会报错

return false;

}

};

const proxy = new Proxy({}, handler);

proxy.foo = 'bar';

// TypeError: 'set' on proxy: trap returned falsish for property 'foo'

上面代码中,严格模式下,set代理返回false或者undefined,都会报错。

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

上面代码中,每当执行proxy函数(直接调用或call和apply调用),就会被apply方法拦截。

另外,直接调用Reflect.apply方法,也会被拦截。

Reflect.apply(proxy, null, [9, 10]) // 38

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

上面代码中,obj对象禁止扩展,结果使用has拦截就会报错。也就是说,如果某个属性不可配置(或者目标对象不可扩展),则has()方法就不得“隐藏”(即返回false)目标对象的该属性。

值得注意的是,has()方法拦截的是HasProperty操作,而不是HasOwnProperty操作,即has()方法不判断一个属性是对象自身的属性,还是继承的属性。

另外,虽然for...in循环也用到了in运算符,但是has()拦截对for...in循环不生效。

let stu1 = {name: '张三', score: 59};

let stu2 = {name: '李四', score: 99};

let handler = {

has(target, prop) {

if (prop === 'score' && target[prop] < 60) {

console.log(`${target.name} 不及格`);

return false;

}

return prop in target;

}

}

let oproxy1 = new Proxy(stu1, handler);

let oproxy2 = new Proxy(stu2, handler);

'score' in oproxy1

// 张三 不及格

// false

'score' in oproxy2

// true

for (let a in oproxy1) {

console.log(oproxy1[a]);

}

// 张三

// 59

for (let b in oproxy2) {

console.log(oproxy2[b]);

}

// 李四

// 99

上面代码中,has()拦截只对in运算符生效,对for...in循环不生效,导致不符合要求的属性没有被for...in循环所排除。

construct()

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

const handler = {

construct (target, args, newTarget) {

return new target(...args);

}

};

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

target:目标对象。

args:构造函数的参数数组。

newTarget:创造实例对象时,new命令作用的构造函数(下面例子的p)。

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

const p = new Proxy(function() {}, {

construct: function(target, argumentsList) {

return 1;

}

});

new p() // 报错

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

另外,由于construct()拦截的是构造函数,所以它的目标对象必须是函数,否则就会报错。

const p = new Proxy({}, {

construct: function(target, argumentsList) {

return {};

}

});

new p() // 报错

// Uncaught TypeError: p is not a constructor

上面例子中,拦截的目标对象不是一个函数,而是一个对象(new Proxy()的第一个参数),导致报错。

注意,construct()方法中的this指向的是handler,而不是实例对象。

const handler = {

construct: function(target, args) {

console.log(this === handler);

return new target(...args);

}

}

let p = new Proxy(function () {}, handler);

new p() // true

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

上面代码中,deleteProperty方法拦截了delete操作符,删除第一个字符为下划线的属性会报错。

注意,目标对象自身的不可配置(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,导致添加新属性总是无效。注意,这里的false只是用来提示操作失败,本身并不能阻止添加新属性。

注意,如果目标对象不可扩展(non-extensible),则defineProperty()不能增加目标对象上不存在的属性,否则会报错。另外,如果目标对象的某个属性不可写(writable)或不可配置(configurable),则defineProperty()方法不得改变这两个设置。

Object.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。

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

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

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' ]

上面代码拦截了对于target对象的Object.keys()操作,只返回a、b、c三个属性之中的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()方法自动过滤,不会返回。

目标对象上不存在的属性

属性名为 Symbol 值

不可遍历(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()方法之中,显式返回不存在的属性(d)、Symbol 值(Symbol.for('secret'))、不可遍历的属性(key),结果都被自动过滤掉。

ownKeys()方法还可以拦截Object.getOwnPropertyNames()。

var p = new Proxy({}, {

ownKeys: function(target) {

return ['a', 'b', 'c'];

}

});

Object.getOwnPropertyNames(p)

// [ 'a', 'b', 'c' ]

for...in循环也受到ownKeys()方法的拦截。

const obj = { hello: 'world' };

const proxy = new Proxy(obj, {

ownKeys: function () {

return ['a', 'b'];

}

});

for (let key in proxy) {

console.log(key); // 没有任何输出

}

上面代码中,ownkeys()指定只返回a和b属性,由于obj没有这两个属性,因此for...in循环不会有任何输出。

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

上面代码中,ownKeys()方法虽然返回一个数组,但是每一个数组成员都不是字符串或 Symbol 值,因此就报错了。

如果目标对象自身包含不可配置的属性,则该属性必须被ownKeys()方法返回,否则报错。

var obj = {};

Object.defineProperty(obj, 'a', {

configurable: false,

enumerable: true,

value: 10 }

);

var p = new Proxy(obj, {

ownKeys: function(target) {

return ['b'];

}

});

Object.getOwnPropertyNames(p)

// Uncaught TypeError: 'ownKeys' on proxy: trap result did not include 'a'

上面代码中,obj对象的a属性是不可配置的,这时ownKeys()方法返回的数组之中,必须包含a,否则会报错。

另外,如果目标对象是不可扩展的(non-extensible),这时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

上面代码中,obj对象是不可扩展的,这时ownKeys()方法返回的数组之中,包含了obj对象的多余属性b,所以导致了报错。

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()方法返回true,但这时Object.isExtensible(proxy)会返回true,因此报错。

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

var proxy = new Proxy({}, {

preventExtensions: function(target) {

console.log('called');

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

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

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

3.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()的一个使用场景是,目标对象不允许直接访问,必须通过代理访问,一旦访问结束,就收回代理权,不允许再次访问。

4.this 问题

虽然 Proxy 可以代理针对目标对象的访问,但它不是目标对象的透明代理,即不做任何拦截的情况下,也无法保证与目标对象的行为一致。主要原因就是在 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,target.m()内部的this就是指向proxy,而不是target。

下面是一个例子,由于this指向的变化,导致 Proxy 无法代理目标对象。

const _name = new WeakMap();

class Person {

constructor(name) {

_name.set(this, name);

}

get name() {

return _name.get(this);

}

}

const jane = new Person('Jane');

jane.name // 'Jane'

const proxy = new Proxy(jane, {});

proxy.name // undefined

上面代码中,目标对象jane的name属性,实际保存在外部WeakMap对象_name上面,通过this键区分。由于通过proxy.name访问时,this指向proxy,导致无法取到值,所以返回undefined。

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

另外,Proxy 拦截函数内部的this,指向的是handler对象。

const handler = {

get: function (target, key, receiver) {

console.log(this === handler);

return 'Hello, ' + key;

},

set: function (target, key, value) {

console.log(this === handler);

target[key] = value;

return true;

}

};

const proxy = new Proxy({}, handler);

proxy.foo

// true

// Hello, foo

proxy.foo = 1

// true

上面例子中,get()和set()拦截函数内部的this,指向的都是handler对象。

5.实例: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);

}

});

}

同理,Proxy 也可以用来实现数据库的 ORM 层。

你可能感兴趣的:(proxy)