Мета-программирование

Объекты Proxy

Введённый в ECMAScript 6, объект Proxy позволяет перехватить и определить пользовательское поведение для определённых операций. Например, получение свойства объекта:

js

var handler = {
  get: function (target, name) {
    return name in target ? target[name] : 42;
  },
};
var p = new Proxy({}, handler);
p.a = 1;
console.log(p.a, p.b); // 1, 42

Объект Proxy определяет target (в данном случае новый пустой объект) и handler - объект в котором реализована особая функция-ловушка get. "Проксированный" таким образом объект, при доступе к его несуществующему свойству вернёт не undefined, а числовое значение 42.

Дополнительные примеры доступны в справочнике Proxy.

Терминология

В разговоре о функциях объекта Proxy применимы следующие термины:

handler (обработчик): Объект - обёртка, содержащий в себе функции-ловушки.
ловушки (traps): Методы, реализующие доступ к свойствам. В своей концепции они аналогичны методам перехвата(hooking) в операционных системах.
цель (target): Объект, который оборачивается в Proxy. Часто используется лишь как внутреннее хранилище для Proxy объекта. Проверка на нарушение ограничений (invariants), связанных с нерасширяемостью объекта или неконфигурируемыми свойствами объекта производится для конкретной цели.
неизменяемые ограничения (дословно Invariants - те что остаются неизменными): Некоторые особенности поведения объекта, которые должны быть сохранены при реализации пользовательского поведения названы invariants. Если в обработчике нарушены такие ограничения, будет выброшена ошибка TypeError.

Обработчики и ловушки

В следующей таблице перечислены ловушки, доступные для использования в объекте Proxy. Смотрите подробные объяснения и примеры в документации.

Обработчик / ловушка	Перехватываемые методы	Неизменяемые ограничения
`handler.getPrototypeOf()`	`Object.getPrototypeOf()` `Reflect.getPrototypeOf()` `__proto__` `Object.prototype.isPrototypeOf()` `instanceof`	`метод getPrototypeOf` должен вернуть object или `null`. если целевой объект `target` нерасширяем, метод `Object.getPrototypeOf(proxy)` должен возвращать тот же результат что и `Object.getPrototypeOf(target)`.
`handler.setPrototypeOf()`	`Object.setPrototypeOf()` `Reflect.setPrototypeOf()`	если целевой объект `target` нерасширяем, значение параметра `prototype` должно быть равным значению возвращаемому методом `Object.getPrototypeOf(target)`.
`handler.isExtensible()`	`Object.isExtensible()` `Reflect.isExtensible()`	`Object.isExtensible(proxy)` должно возвращать тоже значение, что и `Object.isExtensible(target)`.
`handler.preventExtensions()`	`Object.preventExtensions()` `Reflect.preventExtensions()`	`Object.preventExtensions(proxy)` возвращает `true` только в том случае, если `Object.isExtensible(proxy)` равно `false`.
`handler.getOwnPropertyDescriptor()`	`Object.getOwnPropertyDescriptor()` `Reflect.getOwnPropertyDescriptor()`	`метод getOwnPropertyDescriptor` должен возвращать object или `undefined`. Свойство не может быть описано как несуществующее, если оно существует и является некофигурируемым, собственным свойством целевого объекта `target`. Свойство не может быть описано как несуществующее, если оно существует как собственное свойство целевого объекта `target` и `target` не расширяем. Свойство не может быть описано как существующее, если оно не существует как собственное свойство целевого объекта `target` и `target` не расширяем. Свойство не может быть описано как неизменяемое, если оно не существует как собственное свойство целевого объекта `target` или если оно существует и является изменяемым, собственным свойством целевого объекта `target`. Значение возвращённое методом `Object.getOwnPropertyDescriptor(target)` может быть применено к целевому объекту через метод `Object.defineProperty и э`то не вызовет ошибки.
`handler.defineProperty()`	`Object.defineProperty()` `Reflect.defineProperty()`	Новое свойство не может быть добавлено, если целевой объект не расширяем. Нельзя добавить новое конфигурируемое свойство, или преобразовать существующее свойство в конфигурируемое, если оно не существует как собственное свойство целевого объекта или не является конфигурируемым. Свойство не может быть неконфигурируемым, если целевой объект имеет соответствующее собственное, конфигурируемое свойство. Если объект имеет свойство соответствующее создаваемому свойству, то `Object.defineProperty(target, prop, descriptor)` не вызовет ошибки. В строгом режиме ("use strict";), если обработчик `defineProperty` вернёт `false`, это вызовет ошибку `TypeError`.
`handler.has()`	Property query: `foo in proxy` Inherited property query: `foo in Object.create(proxy)` `Reflect.has()`	Свойство не может быть описано как несуществующее, если оно существует как собственное неконфигурируемое свойство целевого объекта. Свойство не может быть описано как несуществующее, если оно существует как собственное свойство целевого объекта, и целевой объект является нерасширяемым.
`handler.get()`	Property access: `proxy[foo]`and `proxy.bar` Inherited property access: `Object.create(proxy)[foo]` `Reflect.get()`	Значение, возвращаемое для свойства, должно равняться значению соответствующего свойства целевого объекта, если это свойство является доступным только для чтения, неконфигурируемым. Значение, возвращаемое для свойства, должно равняться `undefined,` если соответствующее свойство целевого объекта является неконфигурируемым и обёрнуто в геттер и сеттер, где сеттер равен `undefined`.
`handler.set()`	Property assignment: `proxy[foo] = bar` and `proxy.foo = bar` Inherited property assignment: `Object.create(proxy)[foo] = bar` `Reflect.set()`	Нельзя изменить значение свойства на значение, отличное от значения соответствующего свойства целевого объекта, если это свойство целевого объекта доступно только для чтения, и является неконфигурируемым. Нельзя установить значение свойства, если соответствующее свойство целевого объекта является неконфигурируемым, и обёрнуто в геттер и сеттер, где сеттер равен `undefined`. В строгом режиме, возвращение `false` из обработчика `set` вызовет ошибку `TypeError`.
`handler.deleteProperty()`	Property deletion: `delete proxy[foo]` and `delete proxy.foo` `Reflect.deleteProperty()`	Свойство не может быть удалено, если оно существует в целевом объекте как собственное, неконфигурируемое свойство.
`handler.enumerate()`	Property enumeration / for...in: `for (var name in proxy) {...}` `Reflect.enumerate()`	`Метод enumerate` должен возвращать объект.
`handler.ownKeys()`	`Object.getOwnPropertyNames()` `Object.getOwnPropertySymbols()` `Object.keys()` `Reflect.ownKeys()`	Метод `ownKeys` должен возвращать список. Типом каждого элемента в возвращаемом списке должен быть `String` или `Symbol`. Возвращаемый список должен содержать ключи для всех неконфигурируемых, собственных свойств целевого объекта. Если целевой объект является нерасширяемым, возвращаемый список должен содержать все ключи для собственных полей целевого объекта и больше никаких других значений.
`handler.apply()`	`proxy(..args)` `Function.prototype.apply()` and `Function.prototype.call()` `Reflect.apply()`	Ограничений нет.
`handler.construct()`	`new proxy(...args)` `Reflect.construct()`	Обработчик должен возвращать `Object`.

Отзываемый `Proxy`

Метод Proxy.revocable() создаёт отзываемый объект Proxy. Такой прокси объект может быть отозван функцией revoke, которая отключает все ловушки-обработчики. После этого любые операции над прокси объектом вызовут ошибку TypeError.

js

var revocable = Proxy.revocable(
  {},
  {
    get: function (target, name) {
      return "[[" + name + "]]";
    },
  },
);
var proxy = revocable.proxy;
console.log(proxy.foo); // "[[foo]]"

revocable.revoke();

console.log(proxy.foo); // ошибка TypeError
proxy.foo = 1; // снова ошибка TypeError
delete proxy.foo; // опять TypeError
typeof proxy; // "object", для метода typeof нет ловушек

Рефлексия

Reflect это встроенный объект, предоставляющий методы для перехватываемых операций JavaScript. Это те же самые методы, что имеются в обработчиках Proxy. Объект Reflect не является функцией.

Reflect помогает при пересылке стандартных операций из обработчика к целевому объекту.

Например, метод Reflect.has() это тот же оператор in но в виде функции:

js

Reflect.has(Object, "assign"); // true

Улучшенная функция `apply`

В ES5 обычно используется метод Function.prototype.apply() для вызова функции в определённом контексте (с определённым this) и с параметрами, заданными в виде массива (или массива-подобного объекта).

js

Function.prototype.apply.call(Math.floor, undefined, [1.75]);

С методом Reflect.apply эта операция менее громоздка и более понятна:

js

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. Из-за этого определение свойств требует обработки блоком try...catch для перехвата возможных ошибок. Метод Reflect.defineProperty, в свою очередь, возвращает успешность операции в виде булева значения, благодаря чему возможно использование простого if...else условия:

js

if (Reflect.defineProperty(target, property, attributes)) {
  // успех
} else {
  // что-то пошло не так
}