Web/JavaScript/Guide/Iterators_and_generators
Proxy 和 Reflect 对象允许你拦截并自定义基本语言操作(例如属性查找、赋值、枚举和函数调用等)。借助这两个对象,你可以在 JavaScript 进行元级别的编程。
代理
Proxy 对象可以拦截某些操作并实现自定义行为。
例如获取一个对象上的属性:
let handler = {
get(target, name) {
return name in target ? target[name] : 42;
},
};
let p = new Proxy({}, handler);
p.a = 1;
console.log(p.a, p.b); // 1, 42
Proxy 对象定义了一个 target(这里是一个空对象)和一个实现了 get 陷阱的 handler 对象。这里,代理的对象在获取未定义的属性时不会返回 undefined,而是返回 42。
更多例子参见 Proxy 页面。
术语
在讨论代理的功能时会用到以下术语:
- Proxy/Proxy
- : 包含陷阱的占位符对象(下译作“处理器”)。
- 陷阱
- : 提供属性访问的方法(这类似于操作系统中陷阱的概念)。
target- : 代理所虚拟化的对象(下译作“目标”)。它通常用作代理的存储后端。JavaScript 会验证与不可扩展性或不可配置属性相关的不变式。
- 不变式
- : 实现自定义操作时保持不变的语义称为不变式。如果你破坏了处理器的不变式,则会引发 TypeError 异常。
处理器和陷阱
以下表格中总结了 Proxy 对象可用的陷阱。详细的解释和例子请看Proxy/Proxy。
<table class="standard-table"> <thead> <tr> <th>处理器 / 陷阱</th> <th>拦截的操作</th> <th>不变式</th> </tr> </thead> <tbody> <tr> <td> Proxy/Proxy/getPrototypeOf </td> <td> Object.getPrototypeOf()<br />Reflect.getPrototypeOf()<br />Object/proto<br />Object.prototype.isPrototypeOf()<br />instanceof </td> <td> <ul> <li> <code>getPrototypeOf</code> 方法必须返回一个对象或 <code>null</code>。 </li> <li> 如果 <code><var>target</var></code> 不可扩展,<code >Object.getPrototypeOf(<var>proxy</var>)</code > 必须返回和 <code>Object.getPrototypeOf(<var>target</var>)</code> 一样的值。 </li> </ul> </td> </tr> <tr> <td> Proxy/Proxy/setPrototypeOf </td> <td> Object.setPrototypeOf()<br />Reflect.setPrototypeOf() </td> <td> 如果 <code><var>target</var></code> 不可扩展,参数 <code>prototype</code> 必须与 <code>Object.getPrototypeOf(<var>target</var>)</code> 的值相同。 </td> </tr> <tr> <td> Proxy/Proxy/isExtensible </td> <td> Object.isExtensible()<br />Reflect.isExtensible() </td> <td> <code>Object.isExtensible(<var>proxy</var>)</code> 必须返回和 <code>Object.isExtensible(<var>target</var>)</code> 一样的值。 </td> </tr> <tr> <td> Proxy/Proxy/preventExtensions </td> <td> Object.preventExtensions()<br />Reflect.preventExtensions() </td> <td> 如果 <code>Object.isExtensible(<var>proxy</var>)</code> 值为 <code>false</code>,那么 <code>Object.preventExtensions(<var>proxy</var>)</code> 只可能返回 <code>true</code>。 </td> </tr> <tr> <td> Proxy/Proxy/getOwnPropertyDescriptor </td> <td> Object.getOwnPropertyDescriptor()<br />Reflect.getOwnPropertyDescriptor() </td> <td> <ul> <li> <code>getOwnPropertyDescriptor</code> 必须返回对象或者 <code>undefined</code>。 </li> <li> 如果存在一个对应于 <code><var>target</var></code> 的属性是不可配置的自有属性,那么该属性不能被报告为不存在的。 </li> <li> 如果存在一个对应于 <code><var>target</var></code> 的属性是自有属性,且该 <code><var>target</var></code> 不可扩展,那么该属性不能被报告为不存在的。 </li> <li> 如果并不存在一个对应于 <code><var>target</var></code> 的属性是自有属性,且该 <code><var>target</var></code> 不可扩展,那么该属性不能被报告为存在的。 </li> <li> 如果并不存在一个对应于 <code><var>target</var></code> 的属性是自有属性,或存在一个对应于 <code><var>target</var></code> 的属性是可配置的自有属性,那么它不能被报告为不可配置的。 </li> <li> <code>Object.getOwnPropertyDescriptor(<var>target</var>)</code> 的结果可以通过 <code>Object.defineProperty</code> 应用到 <code><var>target</var></code> 上,且不会抛出异常。 </li> </ul> </td> </tr> <tr> <td> Proxy/Proxy/defineProperty </td> <td> Object.defineProperty()<br />Reflect.defineProperty() </td> <td> <ul> <li> 如果 <code><var>target</var></code> 不可扩展,那么就不能添加属性。 </li> <li> 如果并不存在一个对应于 <code><var>target</var></code> 的属性是不可配置的自有属性,那么就不能添加(或修改)该属性为不可配置的。 </li> <li> 如果存在一个对应于 <code><var>target</var></code> 的属性是可配置的,那么这个属性未必是不可配置的。 </li> <li> 如果存在一个对应于 <code><var>target</var></code> 的属性,那么 <code >Object.defineProperty(<var>target</var>, <var>prop</var>, <var>descriptor</var>)</code > 将不会抛出异常。 </li> <li> 在严格模式下,如果 <code>defineProperty</code> 处理器返回 <code>false</code>,则会抛出 TypeError 异常。 </li> </ul> </td> </tr> <tr> <td> Proxy/Proxy/has </td> <td> <dl> <dt>属性查询</dt> <dd><code>foo in proxy</code></dd> <dt>继承属性查询</dt> <dd> <code>foo in Object.create(<var>proxy</var>)</code ><br />Reflect.has() </dd> </dl> </td> <td> <ul> <li> 如果存在一个对应于 <code><var>target</var></code> 的属性是不可配置的自有属性,那么该属性不能被报告为不存在的。 </li> <li> 如果存在一个对应于 <code><var>target</var></code> 的属性是自有属性,且 <code><var>target</var></code> 不可扩展,那么该属性不能被报告为不存在的。 </li> </ul> </td> </tr> <tr> <td> Proxy/Proxy/get </td> <td> <dl> <dt>属性访问</dt> <dd> <code><var>proxy</var>[foo]</code><br /><code ><var>proxy</var>.bar</code > </dd> <dt>继承属性访问</dt> <dd>
<code>Object.create(<var>proxy</var>)[foo]</code
><br />Reflect.get()
</dd>
</dl>
</td>
<td>
<ul>
<li>
如果对应于 <code><var>target</var></code>
的属性是不可写且不可配置的数据属性,那么该属性值必须与其相同。
</li>
<li>
如果对应于 <code><var>target</var></code>
的属性是不可配置的访问器属性,且其 <code>[[Get]]</code>
属性为 <code>undefined</code>,那么该属性值必须为
<code>undefined</code>。
</li>
</ul>
</td>
</tr>
<tr>
<td>
Proxy/Proxy/set
</td>
<td>
<dl>
<dt>属性赋值</dt>
<dd>
<code><var>proxy</var>[foo] = bar</code><br /><code
><var>proxy</var>.foo = bar</code
>
</dd>
<dt>继承属性赋值</dt>
<dd>
<code>Object.create(<var>proxy</var>)[foo] = bar</code
><br />Reflect.set()
</dd>
</dl>
</td>
<td>
<ul>
<li>
如果对应于 <code><var>target</var></code>
的属性是不可写且不可配置的数据属性,那么就不能修改该属性的值使其不同于
<code><var>target</var></code> 上对应属性的值。
</li>
<li>
如果对应于 <code><var>target</var></code>
的属性是不可配置的访问器属性,且其 <code>[[Set]]</code>
属性为 <code>undefined</code>,那么就不能设置该属性的值。
</li>
<li>
在严格模式下,如果 <code>set</code> 处理器返回
<code>false</code>,则会抛出 TypeError 异常。
</li>
</ul>
</td>
</tr>
<tr>
<td>
Proxy/Proxy/deleteProperty
</td>
<td>
<dl>
<dt>属性删除</dt>
<dd>
<code>delete <var>proxy</var>[foo]</code><br /><code
>delete <var>proxy</var>.foo</code
><br />Reflect.deleteProperty()
</dd>
</dl>
</td>
<td>
如果存在一个对应于 <code><var>target</var></code>
的属性是不可配置的自有属性,那么该属性不能被删除。
</td>
</tr>
<tr>
<td>
Proxy/Proxy/ownKeys
</td>
<td>
Object.getOwnPropertyNames()<br />Object.getOwnPropertySymbols()<br />Object.keys()<br />Reflect.ownKeys()
</td>
<td>
<ul>
<li><code>ownKeys</code> 的返回值是一个数组。</li>
<li>
返回值中的每个元素类型为
String 或 Symbol。
</li>
<li>
返回值中必须包含 <code><var>target</var></code>
的所有不可配置自有属性的键名。
</li>
<li>
如果 <code><var>target</var></code> 不可扩展,那么返回值中必须有且仅有
<code><var>target</var></code> 的所有自有属性的键名。
</li>
</ul>
</td>
</tr>
<tr>
<td>
Proxy/Proxy/apply
</td>
<td>
<code>proxy(..args)</code
><br />Function.prototype.apply()<br />Function.prototype.call()<br />Reflect.apply()
</td>
<td>
不存在关于 <code><var>handler</var>.apply</code> 方法的不变式。
</td>
</tr>
<tr>
<td>
Proxy/Proxy/construct
</td>
<td>
<code>new proxy(...args)</code
><br />Reflect.construct()
</td>
<td>返回值必须是一个 <code>Object</code>。</td>
</tr>
</tbody> </table>
可撤销的 Proxy
可以用 Proxy.revocable() 方法来创建可撤销的 Proxy 对象。这意味着可以通过 revoke 函数来撤销并关闭一个代理。
此后,对代理进行的任意的操作都会导致 TypeError。
const revocable = Proxy.revocable(
{},
{
get(target, name) {
return `[[${name}]]`;
},
},
);
const proxy = revocable.proxy;
console.log(proxy.foo); // "[[foo]]"
revocable.revoke();
console.log(proxy.foo); // TypeError: Cannot perform 'get' on a proxy that has been revoked
proxy.foo = 1; // TypeError: Cannot perform 'set' on a proxy that has been revoked
delete proxy.foo; // TypeError: Cannot perform 'deleteProperty' on a proxy that has been revoked
console.log(typeof proxy); // "object", `typeof` 不会触发任何陷阱
反射
Reflect 是一个内置对象,它为可拦截的 JavaScript 操作提供了方法。这些方法与Proxy/Proxy类似。
Reflect 并不是一个函数对象。
Reflect 将默认操作从处理器转发到 target。
以 Reflect.has() 为例,你可以将 in 运算符作为函数:
Reflect.has(Object, "assign"); // true
更好的 apply 函数
在不借助 Reflect 的情况下,我们通常使用 Function.prototype.apply() 方法调用一个具有给定 this 值和 arguments 数组(或类数组对象)的函数。
Function.prototype.apply.call(Math.floor, undefined, [1.75]);
借助 Reflect.apply,这些操作将变得更加简洁:
Reflect.apply(Math.floor, undefined, [1.75]);
// 1;
Reflect.apply(String.fromCharCode, undefined, [104, 101, 108, 108, 111]);
// "hello"
Reflect.apply(RegExp.prototype.exec, /ab/, ["confabulation"]).index;
// 4
Reflect.apply("".charAt, "ponies", [3]);
// "i"
检查属性定义是否成功
使用 Object.defineProperty,如果成功则返回一个对象,否则抛出一个 TypeError,你可使用 Statements/try...catch 块来捕获定义属性时发生的任何错误。因为 Reflect.defineProperty 返回一个布尔值表示的成功状态,你可以在这里使用 Statements/if...else 块:
if (Reflect.defineProperty(target, property, attributes)) {
// success
} else {
// failure
}
Web/JavaScript/Guide/Iterators_and_generators
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
