Skip to content

Proxy and Reflect ​

ES6新增的代理(Proxy)和反射(Reflect)为开发者提供了拦截并向基本操作嵌入额外行为的能力。具体地说,可以给目标对象定义一个关联的代理对象,而这个代理对象可以作为抽象的目标对来使用。在对目标对象的各种操作影响目标对象之前,可以在代理对象中对这些操作加以控制。

注意

在ES6之前,ECMAScript中并没有类似代理的特性。由于代理是一种新的基础性语言能力,很多转译程序都不能把代理行为转换为之前的ECMAScript代码,因为代理的行为实际上是无可替代的。为此代理和反射只在百分之百支持它们的平台上有用。可以检测代理是否存在,不存在则提供后备代码。不过这会导致代码冗余,因此并不推荐。

代理基础 ​

创建空代理 ​

js
const target = {
  id: 'target'
}
const handler = {}
const proxy = new Proxy(target, handler)
// id属性会访问同一个值
console.log(target.id)  // traget
console.log(proxy.id)  // traget
// 给目标属性赋值会反映在两个对象上
target.id = 'foo'
console.log(target.id)  // foo
console.log(proxy.id)  // foo
// 给代理属性赋值会反映在两个对象上
proxy.id = 'bar'
console.log(target.id)  // bar
console.log(proxy.id)  // bar

console.log(target.hasOwnProperty('id'))  // true
console.log(proxy.hasOwnProperty('id'))  // true

console.log(target instanceof Proxy)  // TypeError
console.log(proxy instanceof Proxy) // TypeError

console.log(target === proxy) // false

Proxy对象用于创建一个对象的代理,从而实现基本操作的拦截和自定义(如属性查找、赋值、枚举、函数调用等)。

js
const p = new Proxy(target, handler)

定义捕获器 ​

使用代理的主要目的是可以定义捕获器(trap)。捕获器就是在处理程序对象中定义的”基本操作的拦截器“。每个处理程序对象可以包含零个或多个捕获器,每个捕获器都对应一种基本操作,可以直接或间接在代理对象上调用。每次在代理对象上调用这些基本操作时,代理可以在这些操作传播到目标对象之前先调用捕获器函数,从而拦截并修改响应的行为。

例如,可以定义一个get()捕获器,在ECMAScript操作以某种形式调用get()时触发。下面的例子定义了一个get()捕获器:

js
const target = {
  foo: 'bar'
}
const hander = {
  get() {
    return 'handler override'
  }
}
const proxy = new Proxy(target, handler)

这样,当通过代理对象之行get()操作时,就会触发定义的get()捕获器。当然,get()不是ECMAScript对象一个调用的方法。这个操作在JavaScript代码中可以通过多种形式触发并被get()捕获器拦截到。proxy[property]、proxy.property或Object.create(proxy)[property]等操作都会触发基本的get()操作以获取属性。因此所有这些操作只要发生在代理对象上,就会出发get()捕获器。注意,只有在代理对象上执行这些操作才会触发捕获器。在目标对象上执行这些操作仍然会产生正常的行为。

js
const target = {
  foo: 'bar'
}
const handler = {
  get() {
    return 'handler override'
  }
}
const proxy = new Proxy(target, handler)

console.log(target.foo) // bar
console.log(proxy.foo) // handler override


console.log(target['foo']) // bar
console.log(proxy['foo']) // handler override


console.log(Object.create(target)['foo']) // bar
console.log(Object.create(proxy)['foo']) // handler override

捕获器参数和反射API ​

所有捕获器都可以访问响应的参数,基于这些参数可以重建被捕获方法的原始行为。比如,get()捕获器会接收到目标对象、要查询的属性和代理对象三个参数。

js
const target = {
  foo: 'bar'
}
const handler = {
  get(trapTarget, property, receiver) {
    console.log(trapTarget === target)
    console.log(property)
    console.log(receiver === proxy)
  }
}
const proxy = new Proxy(target, handler)
proxy.foo
// true
// 'foo'
// true

所有捕获器都可以给予自己的参数创建原始操作,但并非所有捕获器行为都像get()那么简单。因此,通过手动写代码如法炮制的想法是不现实的。实际上,开发者并不需要手动重建原始行为,而是可以通过调用全局Reflect对象上(封装了原始行为)的同名方法来轻松重建。

处理程序对象中所有可以捕获的方法都有对应的反射(Reflect)API方法。这些方法与捕获器拦截的方法具有相同的名称和函数签名,而且也具有与被拦截方法相同的行为。 因此,使用反射API也可以像下面这样定义出空代理对象:

js
const target = {
  foo: 'bar'
}
const handler = {
  get() {
    return Reflect.get(...arguments)
  }
}
const proxy = new Proxy(target, handler)

甚至可以写的更简洁一些:

js
const target = {
  foo: 'bar'
}
const handler = {
  get: Reflect.get
}
const proxy = new Proxy(target, handler)

事实上,如果真想创建一个可以捕获所有方法,然后将每个方法转发给对应反射API的空代理,那么甚至不需要定义处理程序对象:

js
const target = {
  foo: 'bar'
}
const proxy = new Proxy(target, Reflect)

反射API为开发者准备好了样板代码,在此基础上开发者可以用最少的代码修改捕获的方法。

捕获器不变式 ​

使用捕获器几乎可以改变所有基本方法的行为,但也不是没有限制。根据ECMAScript规范,每个捕获的方法都知道目标对象上下文、捕获函数签名,而捕获处理程序的行为必须遵守“捕获器不变式”(trap invariant)。捕获器不变式因方法不同而异,但通常都会防止捕获器定义出现过于反常的行为。 比如,如果目标对象对有一个不可配置且不可写的数据属性,那么在捕获器返回一个与该属性不同的值时,会抛出TypeError:

js
const target = {}
Object.defineProperty(target, 'foo', {
  configurable: false,
  writable: false,
  value: 'bar'
})
const handler = {
  get() {
    return 'qux'
  }
}
const proxy = new Proxy(target, handler)
console.log(proxy.foo)
// TypeError

可撤销代理 ​

有时候可能需要中断代理对象与目标对象之前的联系。对于使用new Proxy()创建的普通代理来说,这种联系会在代理对象的生命周期内一直持续存在。

Proxy也暴露了revocable()方法,这个方法支持撤销代理对象与目标对象的关联。撤销代理的操作时不可逆的。而且撤销函数(revoke())是幂等的,调用多少次的结果都一样。撤销代理之后在调用代理会抛出TypeError。

撤销函数和代理对象是在实例化时同时生成的:

js
const target = {
  foo: 'bar'
}
const handler = {
  get() {
    return 'intercepted'
  }
}
const { proxy, revoke } = Proxy.revocable(target, handler)
console.log(proxy.foo); // intercepted
console.log(target.foo);  // bar

revoke();
console.log(proxy.foo); // TypeError

实用反射API ​

某些情况下应该优先使用反射API,这是有一些理由的。

  1. 反射API与对象API

在使用反射API时,要记住:

  • 反射API并不限于捕获处理程序;
  • 大多数反射API方法在Object类型上有对应的方法。

通常,Object上的方法适用于通用程序,而反射方法适用于细粒度的对象控制与操作。

  1. 状态标记

很多反射方法返回称作“状态标记”的布尔值,表示意图执行的操作是否成功。有时候,状态标记比那些返回修改后的对象或者抛出错误(取决于方法)的反射API方法更有用。例如,可以使用反射API对下面的代码进行重构:

js
const o = {}
try {
  Object.defineProperty(o, 'foo', 'bar');
  console.log('success');
} catch(e) {
  console.log('failure')
}

在定义新属性时如果发生问题,Reflect.defineProperty()会返回false,而不是抛出错误。因此使用这个反射方法可以重新重构上面的代码:

js
const o = {}
if (Reflect.defineProperty(o, 'foo', {value: 'bar'})) {
  console.log('success')
} else {
  console.log('failure')
}

以下反射方法都会提供状态标记:

  • Reflect.defineProperty()
  • Reflect.preventExtensions()
  • Reflect.setPrototypeOf()
  • Reflect.set()
  • Reflect.deleteProperty()
  1. 用一等函数代替操作符

以下反射方法提供只有通过操作符才能完成的操作。

  • Reflect.get():可以代替对象属性访问操作符。
  • Reflect.set():可以代替=赋值操作符
  • Reflect.has():可以代替in操作符或with()
  • Reflect.deleteProperty():可以代替delete操作符。
  • Reflect.construct():可以代替new操作符。
  1. 安全地应用函数

在通过apply方法调用函数时,被调用的函数可能也定义了自己的apply属性(虽然可能性极小)。为了绕过这个问题,可以使用定义在Function原型上的apply方法,比如:Function.prototype.apply.call(myFunc, thisVal, argumentList);这种可怕的代码完全可以使用Reflect.apply来避免:Reflect.apply(myFunc, thisVal, argumentList);

代理另一个代理 ​

代理可以拦截反射API的操作,而这意味完全可以创建一个代理,通过它取代理另一个代理。这样就可以在一个目标对象之上构建多层拦截网:

js
const target = {
  foo: 'bar'
}
const firstProxy = new Proxy(target, {
  get() {
    console.log('first proxy');
    return Reflect.get(...arguments)
  }
})
const secondProxy = new Proxy(firstProxy, {
  get() {
    console.log('second proxy');
    return Reflect.get(...arguments)
  }
})

console.log(secondProxy.foo)
// second proxy
// first proxy
// bar

代理的问题与不足 ​

代理是在ECMAScript现有基础之上构建起来的一套新API,因此其实实现已经尽力做到最好了。很大程度上,代理作为对象的虚拟层可以正常使用。但在默写情况下,代理也不能与现在的ECMAScript机制很好地协同。

  1. 代理中的this

代理潜在的一个问题来源是this值。我们知道,方法中的this通常指向调用这个方法的对象:

js
const target = {
  theisValEqualsProxy() {
    return this === proxy;
  }
}
const proxy = new Proxy(target, {});

console.log(target.thisValEqualsProxy()); // false
console.log(proxy.thisValEqualsProxy()); // true

从直觉上讲,这样完全没有问题:调用代理上的任何方法,比如proxy.outermethod(),而这个方法进而又会调用另一个方法,如this.innerMethod(),实际上都会调用proxy.innerMethod()。多数情况下,这是符合预期的行为。可是,如果目标对象依赖于对象标识,那就可能碰到意料之外的问题。

js
const wm = new WeakMap();
class User {
  constructor(userId) {
    wm.set(this, userId)
  }
  set id(userId) {
    wm.set(this.userId);
  }
  get id() {
    return wm.get(this)
  }
}

由于这个实现依赖User实例的对象标识,在这个实例被代理的情况下就会出现问题:

js
const user = new User(123);
console.log(user.id); // 123

const userInstanceProxy = new Proxy(user, {});
console.log(userInstanceProxy.id);  // undefined

这是因为User实例一开始使用目标对象作为WeakMap的键,代理对象却尝试从自身取得这个实例。要解决这个问题,就需要重新配置代理,把代理User实例改为代理User类本身。之后在创建代理的实例就会以代理实例作为WeakMap的键了:

js
const UserClassProxy = new Proxy(User, {});
const proxyUser = new UserClassProxy(456);
console.log(proxyUser.id);  // 456
  1. 代理与内部槽位

代理与内置引用类型(比如Array)的实例通常可以很好地协同,但有些ECMAScript内置类型可能会依赖代理无法控制的机制,结果导致在代理上调用某些方法会出错。

一个典型的例子就是Date类型。根据ECMAScript规范,Date类型方法的执行依赖this值上的内部槽位[[NumberDate]]。代理对象上不存在这个内部槽位,而且这个内部槽位的值也不能通过普通的get()和set()操作访问到,于是代理拦截后本应转发给不表对象的方法会抛出TypeError:

js
const target = new Date();
const proxy = new Proxy(target, {});

console.log(proxy instanceof Date); // true
proxy.getDate();  // TypeError: 'this' is not a Date object

代理捕获器与反射方法 ​

代理可以捕获13种不同的基本操作。这些操作有各自不同的反射API方法、参数、关联ECMAScript操作和不变式。

对于在代理对象上执行的任何一种操作,只会有一个捕获处理程序被调用。不会存在重复捕获的情况。

只要在代理上调用,所有捕获器都会拦截它们对应的反射API操作。

get() ​

get()捕获器会在获取属性值的操作中被调用。对应的反射API方法为Reflect.get()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  get(target, property, receiver) {
    console.log('get()');
    return Reflect.get(...arguments);
  }
})
proxy.foo;  // get()
  1. 返回值

返回值无限制。

  1. 拦截的操作
  • proxy.property
  • proxy[property]
  • Object.create(proxy)[property]
  • Reflect.get(proxy, property, receiver)
  1. 捕获器处理程序参数
  • target:目标对象。
  • property:引用的目标对象上的字符串属性。
  • receiver:代理对象或继承代理对象的对象。
  1. 捕获器不变式
  • 如果target.property不可写且不可配置,则处理程序返回的值必须与target.property匹配。
  • 如果target.property不可配置且[[Get]]特性为undefined,处理程序的返回值也必须是undefined。

set() ​

set()捕获器会在设置属性值的操作中被调用。对应的反射API方法为Reflect.set()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  set(target, property, value, receiver) {
    console.log('set()');
    return Reflect.set(...arguments);
  }
})
proxy.foo = 'bar';  // set()
  1. 返回值

返回true表示成功;返回false表示失败,严格模式下会抛出TypeError。

  1. 拦截的操作
  • proxy.property = value
  • proxy[property] = value
  • Object.create(proxy)[property] = value
  • Reflect.set(proxy, property, value, receiver)
  1. 捕获器处理程序参数
  • target:目标对象。
  • property:引用的目标对象上的字符串键属性。
  • value:要赋给属性的值。
  • receiver:接收最初赋值的对象。
  1. 捕获器不变式
  • 如果target.property不可写且不可配置,则不能修改目标属性的值。
  • 如果target.property不可配置且[[Set]]特性为undefined,则不能修改目标属性的值。
  • 严格模式下处理程序中返回false会抛出TypeError。

has() ​

has()捕获器还在in操作符中被调用。对应的反射API方法为Reflect.has()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  has(target, property) {
    console.log('has()');
    return Reflect.has(...arguments);
  }
})
'foo' in proxy; // has()
  1. 返回值

has()必须返回布尔值,标识属性是否存在。返回非布尔值会被转型为布尔值。

  1. 拦截的操作
  • property in proxy
  • property in Object.create(proxy)
  • with(proxy) {(property);}
  • Reflect.has(proxy, property)
  1. 捕获器处理程序参数
  • target:目标对象。
  • property:引用的目标对象上的字符串键属性。
  1. 捕获器不变式
  • 如果target.property存在且不可配置,则处理程序必须返回true。
  • 如果target.property存在且目标对象不可扩展,则处理程序必须返回true。

defineProperty() ​

defineProperty()捕获器会在Object.defineProperty()中被调用。对应的反射API方法为Reflect.defineProperty()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  defineProperty(target, property, descriptor) {
    console.log('defineProperty()');
    return Reflect.defineProperty(...arguments);
  }
})
Object.defineProperty(proxy, 'foo', { value: 'bar' });
// defineProperty()
  1. 返回值

defineProperty()必须返回布尔值,表示属性是否成功定义。返回非布尔值会被转型为布尔值。

  1. 拦截的操作
  • Object.defineProperty(proxy, property, descriptor)
  • Reflect.defineProperty(proxy, property, descriptor)
  1. 捕获器处理程序参数
  • target:目标对象。
  • property:引用的目标对象上的字符串键属性。
  • descriptor:包含可选的enumerable、configurable、writable、value、get和set定义的对象。
  1. 捕获器不变式
  • 如果目标对象不可扩展,则无法定义属性。
  • 如果目标对象有一个可配置的属性,则不能添加同名的不可配置属性。
  • 如果目标对象有一个不可配置的属性,则不能添加同名的可配置属性。

getOwnPropertyDescriptor() ​

getOwnPropertyDescriptor()捕获器会在Object.getOwnPropertyDescriptor()中被调用。对应的反射API方法为Reflect.getOwnPropertyDescriptor()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  getOwnPropertyDescriptor(target, property) {
    console.log('getOwnPropertyDescriptor()');
    return Reflect.getOwnPropertyDescriptor(...arguments);
  }
})
Object.getOwnPropertyDescriptor(proxy, 'foo');
// getOwnPropertyDescriptor()
  1. 返回值

getOwnPropertyDescriptor()必须返回对象,或者在属性不存在时返回undefined。

  1. 拦截的操作
  • Object.getOwnPropertyDescriptor(proxy, property)
  • Reflect.getOwnPropertyDescriptor(proxy, property)
  1. 捕获器处理程序参数
  • target:目标对象。
  • property:引用的目标对象上的字符串键属性。
  1. 捕获器不变式
  • 如果自有的target.property存在且不可配置,则处理程序必须返回一个表示该属性存在的对象。
  • 如果自有的target.property存在且可配置,则处理程序必须返回表示该属性可配置的对象。
  • 如果自有的target.property存在且target不可扩展,则处理程序必须返回一个表示该属性存在的对象。
  • 如果target.property不存在且target不可扩展,则处理程序必须返回undefined表示该属性不存在。
  • 如果target.property不存在,则处理程序不能返回表示该属性可配置的对象。

deleteProperty() ​

deleteProperty()捕获器会在delete操作符中被调用。对应的反射API方法为Reflect.deleteProperty()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  deleteProperty(target, property) {
    console.log('deleteProperty()');
    return Reflect.deleteProperty(...arguments);
  }
})
delete proxy.foo
// deleteProperty()

ownKeys() ​

ownKeys()捕获器会在Object.keys()及类似方法中呗调用。对应的反射API方法为Reflect.ownKeys()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  ownKeys(target) {
    console.log('ownKeys()');
    return Reflect.ownKeys(...arguments);
  }
})

Object.keys(proxy); // ownKeys()
  1. 返回值

ownKeys() 必须返回包含字符串或符号的可枚举对象。

  1. 拦截的操作
  • Object.getOwnPropertyNames(proxy)
  • Object.getOwnPropertySymbols(proxy)
  • Object.keys(proxy)
  • Reflect.ownkeys(proxy)
  1. 捕获器处理程序参数
  • target:目标对象。
  1. 捕获器不变式
  • 返回的可枚举对象必须包含target的所有不可配置的自有属性。
  • 如果target不可扩展,则返回可枚举对象必须准确地包含自由属性键。

getPrototypeOf() ​

getPrototypeOf()捕获器会在Object.getPrototypeOf()中被调用。对应的反射API方法为Reflect.getPrototypeOf()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  getPrototypeOf(target) {
    console.log('getPrototypeOf()');
    return Reflect.getPrototypeOf(...arguments);
  }
})
Object.getPrototypeOf(proxy); // getPrototypeOf()
  1. 返回值

getPrototypeOf()必须返回对象或null

  1. 拦截的操作
  • Object.getPrototypeOf(proxy)
  • Reflect.getPrototypeOf(proxy)
  • proxy.__proto__
  • Object.prototype.isPrototypeof(proxy)
  • proxy instanceof Object
  1. 捕获器处理程序参数
  • target:目标对象。
  1. 捕获器不变式
  • 如果target不可扩展,则Object.getPrototypeOf(proxy)唯一有效的返回值就是Object.getPrototypeOf(target)的返回值。

setPrototypeOf() ​

setPrototypeOf()捕获器会在Object.setPrototypeOf()中被调用。对应的反射API方法为Reflect.setPrototypeOf()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  setPrototypeOf(target, prototype) {
    console.log('setPrototypeOf()');
    return Reflect.setPrototypeOf(...arguments);
  }
})

Object.setPrototypeOf(proxy, Object);
// setPrototypeOf()
  1. 返回值

setPrototypeOf()必须返回布尔值,表示原型赋值是否成功。返回非布尔值会被转型为布尔值。

  1. 拦截的操作
  • Object.setPrototypeOf(proxy)
  • Reflect.setPrototypeOf(proxy)
  1. 捕获器处理程序参数
  • target:目标对象。
  • prototype:target的代替原型,如果是顶级原型则为null。
  1. 捕获器不变式
  • 如果target不可扩展,则唯一有效的prototype参数就是Object.getPrototypeOf(target)的返回值。

isExtensible() ​

isExtensible()捕获器会在Object.isExtensible()中被调用。对应的反射API方法为Reflect.isExtensible()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  isExtensible(target) {
    console.log('isExtensible()');
    return Reflect.isExtensible(...arguments);
  }
})

Object.isExtensible(proxy); // isExtensible()
  1. 返回值

isExtensible()必须返回布尔值,表示target是否可扩展。返回非布尔值会被转型为布尔值。

  1. 拦截的操作
  • Object.isExtensible(proxy)
  • Reflect.isExtensible(proxy)
  1. 捕获器处理程序参数
  • target:目标对象。
  1. 捕获器不变式
  • 如果target可扩展,则处理程序必须返回true。
  • 如果target不可扩展,则处理程序必须返回false。

preventExtensions() ​

preventExtensions()捕获器会在Object.preventExtensions()中被调用。对应的反射API方法为Reflect.preventExtensions()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  preventExtensions(target) {
    console.log('preventExtensions()');
    return Reflect.preventExtensions(...arguments);
  }
})

Object.preventExtensions(proxy); // preventExtensions()
  1. 返回值

preventExtensions()必须返回布尔值,表示target是否已经不可扩展。返回非布尔值会被转型为布尔值。

  1. 拦截的操作
  • Object.preventExtensions(proxy)
  • Reflect.preventExtensions(proxy)
  1. 捕获器处理程序参数
  • target:目标对象。
  1. 捕获器不变式
  • 如果Object.isExtensible(proxy)是false,则处理程序必须返回true。

apply() ​

apply()捕获器会在调用函数时中被调用。对应的反射API方法为Reflect.apply()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  apply(target, thisArg, ...argumentsList) {
    console.log('apply()');
    return Reflect.apply(...arguments);
  }
})

proxy(); // apply()
  1. 返回值

返回值无限制。

  1. 拦截的操作
  • proxy(...argumentsList)
  • Function.prototype.apply(thisArg, argumentsList)
  • Function.prototype.call(thisArg, ...argumentsList)
  • Reflect.apply(target, thisArgument, argumentsList)
  1. 捕获器处理程序参数
  • target:目标对象。
  • thisArg:调用函数时的this参数。
  • argumentsList:调用函数时的参数列表。
  1. 捕获器不变式
  • target必须是一个函数对象。

construct() ​

construct()捕获器会在new操作符中被调用。对应的反射API方法为Reflect.construct()。

js
const myTarget = {};
const proxy = new Proxy(myTarget, {
  construct(target, argumentsList, newTarget) {
    console.log('construct()');
    return Reflect.construct(...arguments);
  }
})

new proxy; // construct()
  1. 返回值

construct()必须返回一个对象。

  1. 拦截的操作
  • new proxy(...argumentsList)
  • Reflect.construct(target, argumentsList, newTarget)
  1. 捕获器处理程序参数
  • target:目标构造函数。
  • argumentsList:传给目标构造函数的参数列表。
  • newTarget:最初被调用的构造函数。
  1. 捕获器不变式
  • target必须可以用作构造函数。

代理模式 ​

使用代理可以在代码中实现一些有用的编程模式。

跟踪属性访问 ​

通过捕获get、set和has等操作,可以知道对象属性什么时候被访问、被查询。 把实现相应捕获器的某个对象代理放到应用中,可以监控这个对象何时在何处被访问过:

js
const user = {
  name: 'Jake'
}
const proxy = new Proxy(user, {
  get(target, property, receiver) {
    console.log(`Getting ${property}`);
    return Reflect.get(...arguments);
  },
  set(target, property, value, receiver) {
    console.log(`Setting ${property}=${value}`);
    return Reflect.set(...arguments);
  }
})

proxy.name; // Getting name
proxy.age = 27;  // Setting age=27

隐藏属性 ​

代理的内部实现对外部代码是不可见的,因此要隐藏目标对象上的属性也轻而易举。 比如:

js
const hiddenProperties = ['foo', 'bar'];
const targetObject = {
  foo: 1, 
  bar: 2,
  baz: 3
}
const proxy = new Proxy(targetObject, {
  get(target, property) {
    if (hiddenProperties.includes(property)) {
      return undefined;
    } else {
      Reflect.get(...arguments);
    }
  },
  has(target, property) {
    if (hiddenProperties.includes(property)) {
      return false;
    } else {
      return Reflect.has(...arguments);
    }
  }
})

// get()
console.log(proxy.foo); // undefined
console.log(proxy.bar); // undefined
console.log(proxy.baz); // 3

// has()
console.log('foo' in proxy);  // false
console.log('bar' in proxy);  // false
console.log('baz' in proxy);  // true

属性验证 ​

因为所有肤质操作都会触发set()捕获器,所以可以根据所赋的值决定是否允许还是拒绝赋值:

js
const target = {
  onlyNumbersGoHere: 0
}
const proxy = new Proxy(target, {
  set(target, property, value) {
    if (typeof value !== 'number') {
      return false;
    } else {
      return Reflect.set(...arguments);
    }
  }
})

proxy.onlyNumbersGoHere = 1;
console.log(proxy.onlyNumbersGoHere); // 1
proxy.onlyNumbersGoHere = '2';
console.log(proxy.onlyNumbersGoHere); // 1

函数与构造函数参数验证 ​

跟保护和验证对象属性类似,也可对函数和构造函数参数进行审查。 比如,可以让函数只接收某种类型的值:

js
function median(...nums) {
  return nums.sort()[Math.floor(nums.length / 2)];
}
const proxy = new Proxy(median, {
  apply(target, thisArg, argumentsList) {
    for (const arg of argumentsList) {
      if (typeof arg !== 'number') {
        throw 'Non-number argument provided';
      }
    }
    return Reflect.apply(...arguments);
  }
})

console.log(proxy(4, 7, 1));  // 4
console.log(proxy(4, '7', 1));
// Error: Non-number argument provided

类似地,可以要求实例化时必须给构造函数传参:

js
class User {
  constructor(id) {
    this.id_ = id;
  }
}
const proxy = new Proxy(User, {
  construct(target, arugmentsList, newTarget) {
    if (argumentsList[0] === undefined) {
      throw 'User cannot be instantiated without id';
    } else {
      return Reflect.construct(...arguments);
    }
  }
})

new proxy(1);
new proxy();
// Error: User cannot be instantiated without id

数据绑定与可观察对象 ​

通过代理可以把运行时原本不相关的部分联系到一起。这样就可以实现各种模式,从而让不同的代码互操作。

比如,可以将代理的类绑定到一个全局实例集合,让所有创建的实例都被添加到这个集合中:

js
const userList = [];

class User {
  constructor(name) {
    this.name_ = name;
  }
}
const proxy = new Proxy(User, {
  construct() {
    const newUser = Reflect.construct(...arguments);
    userList.push(newUser);
    return newUser;
  }
})

new proxy('John');
new proxy('Jacob');
new proxy('Jingleheimerschmidt');

console.log(userList);  
// [User {}, User {}, User{}]

另外,还可以把集合绑定到一个时间分派程序,每次插入新实例时都会发送消息:

js
const userList = [];

function emit(newValue) {
  console.log(newValue);
}

const proxy = new Proxy(userList, {
  set(target, property, value, receiver) {
    const result = Reflect.set(...arguments);
    if (result) {
      emit(Reflect.get(target, property, receiver));
    }
    return result;
  }
})

proxy.push('John'); // John
proxy.push('Jacob');  // Jacob