Введення в JavaScript Proxy
Сьогодні розглянемо JavaScript Proxy: що це таке, як вони працюють, і для чого вони можуть знадобитися.
Зміст
Що таке Proxy
Об'єкт Proxy дозволяє виявити, коли хтось взаємодіє з властивістю масиву або об'єкта, і виконати у відповідь код.
Для створення нового об'єкта Proxy можна використовувати конструктор new Proxy() . .
У цьому прикладі з об'єкта wizards створюється Proxy , а як обробник передається порожній об'єкт.
let wizard =
name:
'Merlin',
tool:
'Wand'
>;
// Створення Proxy об'єкта
let wizardProxy =
new
Proxy(wizard,
>);
Об'єкт обробник та пастки
Об'єкт обробник вказує Proxy , як реагувати на взаємодію з об'єктом або властивостями масиву. пастками, які запускаються як зворотні дзвінки для різних типів взаємодій.
Існує більше десятка різних методів пасток, але три найбільш поширені — це методи get() , set() і deleteProperty() .
У цьому прикладі одержання, встановлення та видалення властивостей об'єкта відбувається у звичайному режимі.
// Створення Proxy об'єкта
let wizardProxy =
new
Proxy(wizard,
/**
* Виконується при отриманні значення властивості
* @param
get
(obj, key)
console.log('get', obj, key, obj[key]);
return obj[key];
>,
/**
* Виконується при визначенні чи оновленні властивості
* @param
set
(obj, key, value)
console.log('set', obj, key, value);
// Оновлення якості
obj[key]
= value;
// Індикація успіху
return
true;
>,
/**
* Виконується при видаленні властивості
* @param
deleteProperty
(obj, key)
console.log('delete', obj, key, obj[key]);
// Видалення якості
delete obj[key];
// Індикація успіху
return
true;
>
>);
Тепер можна змінювати об'єкт Proxy так само, як і звичайний об'єкт, а методи пастки обробника Proxy у відповідь виконуватимуть код.
// Запускає пастку get() і виводить у балку.
// "get" "name" "Merlin"
let name = wizardProxy.name;
// Запускає пастку deleteProperty() і виводить у балку.
// "set" "age" 172
wizardProxy.age =
172;
// Запускає пастку get() і виводить у балку.
// "delete" "tool" "Wand"
delete wizardProxy.tool;
Proxy та вкладеність
Одна з проблем із проксі полягає в тому, що вони виявляють зміни лише у властивостях першого рівня об'єкта чи масиву. Властивості, що є вкладеними об'єктами та масивами об'єкта Proxy , власними силами не є Proxy і детектируются.
В даному випадку є об'єкт wizard з вкладеним масивом spells. Також є об'єкт handler з методами get() та set(). Вони обидва виводять повідомлення в консоль, а в іншому зберігають стандартну поведінку.
Створимо об'єкт Proxy з об'єктами wizard і handler і надамо його змінній wizardProxy.
// Об'єкт із вкладеним масивом
let wizard =
name:
'Merlin',
tool:
'wand',
spells:
['Abbracadabra',
'Disappear']
>;
// Об'єкт handler
let handler =
get
(obj, key)
console.log('get', key);
return obj[key];
>,
set
(obj, key, value)
console.log('set', key);
obj[key]
= value;
return
true;
>
>;
// Створюємо Proxy
let wizardProxy =
new
Proxy(wizard, handler);
Якщо wizardProxy додати властивість або отримати значення властивості з нього, в консоль буде виведено повідомлення, як і очікувалося.
// Виводить "get" "name" і "set" "age" відповідно
let name = wizardProxy.name;
wizardProxy.age =
172;
Але якщо отримати властивість з масиву wizardProxy.spells , метод handler.get() виконається при отриманні масиву spells , але не конкретних властивостей з нього.
Але якщо використовувати метод Array.prototype.push() для додавання властивості масив wizardProxy.spells , то метод handler.get() виконується, при отриманні масиву spells , але метод handler.set() ніколи не виконується.
// Оновлення вкладеного масиву
// виводить "get" "spells"
wizardProxy.spells.push('Heal');
Як обробляти вкладені масиви та об'єкти в об'єкті Proxy
Щоб знайти вкладені масиви та об'єкти всередині об'єкта Proxy , спочатку потрібно перемістити об'єкт handler у функцію, що повертає об'єкт.
function
handler
()
return
get
(obj, key)
console.log('get', key);
return obj[key];
>,
set
(obj, key, value)
console.log('set', key);
obj[key]
= value;
return
true;
>
>;
>
// Створюємо Proxy
let wizardProxy =
new
Proxy(wizard,
handler());
Всередині методу handler.get() необхідно перевірити, чи є значення властивості (obj[key]) масивом чи об'єктом.
Якщо так, то передаємо його в конструктор new Proxy() і повертаємо назад, рекурсивно передаючи функцію handler() . Якщо ні, то повертаємо його як є.
Оператор типуповертає об'єкт для всіх видів елементів, що не є простими об'єктами ( <> ), тому використовуємо інший підхід, щоб з'ясувати це. Можна використовувати метод call() методу Object.prototype.toString() і передати до нього елемент, який хочемо перевірити. Він поверне ім'я прототипу.
// Повертає [object Array]
Object.prototype.toString.call([]);
// [Object Object]
Object.prototype.toString.call(>);
Створимо масив з [object Object] і [object Array] , потім використовуємо метод Array.prototype.includes() , щоб перевірити, чи є рядок, повернутий Object.prototype.toString.call(obj[key]) одним з цих значень .
Якщо так, то повернемо new Proxy() , передавши як аргументи obj[key] і handler() .
function
handler
()
return
get
(obj, key)
console.log('get', key);
// Якщо елемент є об'єктом або масивом, повертається proxy
let nested =
['[object Object]',
'[object Array]'];
let type =
Object.prototype.toString.call(obj[key]);
if
(nested.includes(type))
return
new
Proxy(obj[key],
handler());
>
return obj[key];
>,
set
(obj, key, value)
console.log('set', key);
obj[key]
= value;
return
true;
>
>;
>
Тепер, коли Array.prototype.push() елемент в масив wizardProxy.spells метод handler.set() дійсно виконується.
wizardProxy.spells.push('Heal');
Як уникнути створення Proxy з Proxy
Проксі непрозорі. Немає жодної нативної властивості, за якою можна визначити, чи є об'єкт уже Proxy чи ні.
У поточному коді можна створити Proxy з Proxy , в результаті чого функція handler() буде виконуватися для одного і того ж масиву або об'єкта кілька разів. Якщо це станеться кілька разів, браузер може зависнути або навіть упасти.
let data =
new
Proxy(
wizards:
list:
['Gandalf',
'Radagast',
'Merlin']
>,
witches:
list:
['Ursula',
'Wicked Witch Of The West',
'Malificent']
>
>,
handler());
/**
* Реверс witches та wizards
* Після кількох десятків замін браузер почне гальмувати або впаде.
*/
function
swapMagic
()
let tempCache = data.wizards.list;
data.wizards.list = data.witches.list;
data.witches.list = tempCache;
>
Хоча в браузері немає способу перевірити, чи є масив або об'єкт Proxy, його можна додати за допомогою об'єкта handler.
У методі handler.get() спочатку перевіримо, чи є видобутий ключ _isProxy . Якщо так, то повертаємо true.
Не реальне властивість об'єкта.Це внутрішня фіктивна властивість, що повертає true тільки в тому випадку, якщо метод handler.get() . Якщо це відбувається, ми знаємо, що властивість є об'єктом Proxy .
// Об'єкт handler
function
handler
()
return
get
(obj, key)
// Якщо ключ "_isProxy", повертаємо true
// Це станеться лише у випадку, якщо властивість вже є Proxy
if
(key ===
'_isProxy')
return
true;
// .
>,
// .
>;
>
Якщо властивість є масивом або об'єктом, ми перевіряємо, чи властивість _isProxy повертає значення true .
Якщо це так, то масив чи об'єкт вже керується об'єктом handler і вже став Proxy, тому можна повернути його як є. Якщо ні, це звичайний масив або об'єкт, і можна сміливо повертати new Proxy() .
// Об'єкт handler
function
handler
()
return
get
(obj, key)
// Якщо ключ "_isProxy", повертаємо true
// Це станеться лише у випадку, якщо властивість вже є Proxy
if
(key ===
'_isProxy')
return
true;
// Якщо елемент є об'єктом чи масивом і ще є Proxy, повертаємо new Proxy
let nested =
['[object Object]',
'[object Array]'];
let type =
Object.prototype.toString.call(obj[key]);
if
(nested.includes(type)
&&
!obj[key]._isProxy)
return
new
Proxy(obj[key],
handler());
>
// Інакше повертаємо властивість
return obj[key];
>,
// .
>;
>
Ці два невеликі доповнення дозволяють уникнути вкладеності масивів та об'єктів у кілька обробників Proxy, а також пов'язаних із цим проблем із продуктивністю.
Проксі
Ця особливість є добре створеною і роботою, пов'язаною з багатьма пристроями і розробниками версій. It's been available across browsers since September 2016 .
Об'єкт Proxy дозволяє створити проксі для іншого об'єкта, може перехоплювати та перевизначити основні операції для цього об'єкта.
Вступ
Проксі використовуються програмістами для оголошення розширеної семантики об'єктів JavaScript. Стандартна семантика реалізована в движку JavaScript, який зазвичай написаний низькорівневою мовою програмування, наприклад, C++.Проксі дозволяють програмісту визначити поведінку об'єкта за допомогою JavaScript. Іншими словами вони є інструментом метапрограмування.
Примітка: реалізація проксі SpiderMonkey є прототипом, в якому проксі API і семантика не стабільні. Також, реалізація SpiderMonkey може не відповідати останній версії специфікації. Вона може бути змінена будь-якої миті і надається виключно як експериментальна функція. Не покладайтеся на неї у коді виробництва.
Ця сторінка описує новий API (називається «безпосереднім проксуванням»), який є частиною Firefox 18. Для перегляду старого API (Firefox 17 і нижче) відвідайте сторінку опису старого проксі API.
Термінологія
Технічний термін цієї функції.
Об'єкт, що обертає вихідний об'єкт.
Об'єкт-замінник, що містить пастки. Визначає, які операції будуть перехоплені, а також перевизначає перехоплені операції.
Методи, що надають доступ до властивостей. Це аналогічно до концепції пасток в операційних системах.
Початковий об'єкт, який віртуалізується проксі. Він часто використовується як джерело даних у проксі. Для нього перевіряються інваріанти щодо розширюваності та настроюваності властивостей.
Проксі
Проксі – це нові об'єкти; неможливо виконати "проксування" існуючого об'єкта. Приклад створення проксі:
var p = new Proxy (target, handler);
- target — вихідний об'єкт (може бути об'єктом будь-якого типу, включаючи масив, функцію та навіть інший проксі об'єкт).
- handler - об'єкт-обробник, методи (пастки) якого визначають поведінку проксі під час операції над ним.
Обробник
Усі пастки опціональні. Якщо пастка не задана, то стандартною поведінкою буде перенаправлення операції до об'єкта-мети.
| JavaScript-код |
Метод оброблювача |
Опис |
| Object.getOwnPropertyDescriptor(proxy, name) |
getOwnPropertyDescriptor function(target, name) -> PropertyDescriptor | undefined |
Повинен повертати вірний об'єкт-опис властивості або undefined , щоб показати, що властивість з ім'ям name існує в емульованому об'єкті. |
| Object.getOwnPropertyNames(proxy) Object.getOwnPropertySymbols(proxy) Object.keys(proxy) |
ownKeys function(target) -> [string | symbol] |
Повертає масив всіх власних (не успадкованих) імен властивостей емульованого об'єкта. |
| Object.defineProperty(proxy,name,pd) |
defineProperty function(target, name, propertyDescriptor) -> any |
Задає нову властивість, атрибути якої визначаються наданою propertyDescriptor . Значення методу, що повертається, ігнорується. |
| delete proxy.name |
deleteProperty function(target, name) -> boolean |
Видаляє назву з проксі. Повертає true у разі успішного видалення властивості name. |
| Object.preventExtensions(proxy) |
preventExtensions function(target) -> boolean |
Робить об'єкт нерозширюваним. Повертає true при успішному виконанні. |
| name in proxy |
has function(target, name) -> boolean |
| proxy.name (в контексті "відповідно до рівня") receiver.name (якщо receiver inherits from a proxy and does not override name ) |
get function(target, name, receiver) -> any |
receiver – це проксі або об'єкт, успадкований від проксі. |
| прокс. |
set function(target, name, val, receiver) -> boolean |
receiver – це проксі або об'єкт, успадкований від проксі. |
| proxy(. args) proxy.apply(thisValue, args) proxy.call(thisValue, . args) |
apply function(target, thisValue, args) -> any |
target має бути функцією. |
| new proxy(. args) |
construct function(target, args) -> object |
target має бути функцією. |
Інваріанти
Незважаючи на те, що проксі надають багато можливостей користувачам, деякі операції не перехоплюються для збереження сталості мови:
- Простий і суворий оператор рівності ( == , === ) не перехоплюється.p1 === p2 рівні, тільки якщо p1 і p2 посилаються на той самий проксі.
- Поточна реалізація Object.getPrototypeOf(proxy) завжди повертає Object.getPrototypeOf(target) , тому що ES2015 перехоплювач getPrototypeOf поки не реалізований.
- typeof proxy завжди повертає typeof target. Зокрема, proxy може бути використаний як функція лише якщо target є функцією.
- Array.isArray(proxy) завжди повертає Array.isArray(target) .
- Object.prototype.toString.call(proxy) завжди повертає Object.prototype.toString.call(target) , тому що в ES2015 перехоплювач Symbol.toStringTag поки не реалізований.
Приклади
Простий приклад
Об'єкт, що повертає значення 37 у разі відсутності властивості із зазначеним ім'ям:
var handler = < get: function (target, name) < return name in target ? target[name]: 37; >, >; var p = new Proxy(<>, handler); p.a = 1; p.b = undefined; console.log(p.a, p.b); // 1, undefined console.log("c" in p, p.c); // false, 37
Перенаправляючий проксі
У цьому прикладі ми використовуємо JavaScript об'єкт, до якого наш проксі спрямовує всі запити:
var target = <>; var p = New Proxy (target, <>); p.a = 37; // Операція перенаправлена проксі console.log(target.a); // 37. Операція успішно перенаправлена
Перевірка
За допомогою 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"); >> // Стандартне збереження значення obj[prop] = value; // Визначити успіх return true; >, >; let person = new Proxy(<>, validator); person.age = 100; console.log(person.age); //100 person.age = "young"; // Викличе виняток person.age = 300; // Викличе виняток
Доповнення конструктора
Функція проксі може легко доповнити конструктор новим:
function extend(sup, base) < var descriptor = Object.getOwnPropertyDescriptor( base.prototype, "constructor", ); const prototype = < . base.prototype >; base.prototype = Object.create(sup.prototype); base.prototype = Object.assign(base.prototype, prototype); var handler = < construct: function (target, args) < var obj = Object.create(base.prototype); this.apply(target, obj, args); return obj; >, apply: function (target, that, args) < sup.apply(that, args); base.apply(that, args); >, >; var proxy = new Proxy(base, handler); descriptor.value = proxy; Object.defineProperty(base.prototype, "constructor", descriptor); return proxy; > var Person = function (name) < this.name = name; >; var Boy = extend (Person, function (name, age) <this.age = age; >); Boy.prototype.sex = "M"; var Peter = New Boy ("Peter", 13); console.log(Peter.sex); // "M" console.log(Peter.name); // "Peter" console.log(Peter.age); // 13
Маніпуляція DOM елементами
Іноді виникає потреба переключити атрибут або ім'я класу у двох різних елементів:
let view = new Proxy( < selected: null, >, < set: function (obj, prop, newval) < let oldval = obj[prop]; if (prop === "selected") < if (oldval) < oldval .setAttribute("aria-selected", "false"); >if (newval) < newval.setAttribute("aria-selected", "true"); >> >> Стандартне збереження значення obj [prop] = newval; let i1 = (view.selected = document.getElementById("item-1")); console.log(i1.getAttribute("aria-selected")); // 'true' let i2 = (view.selected = document.getElementById("item-2")); console.log(i1.getAttribute("aria-selected")); // 'false' console.log(i2.getAttribute("aria-selected")); // 'true'
Зміна значень та додаткові властивості
Проксі об'єкт products перевіряє передані значення і перетворює їх на масив у разі потреби. Об'єкт також підтримує додаткову властивість latestBrowser для читання та запису.
let products = new Proxy( < browsers: ["Internet Explorer", "Netscape"], >, < get: function (obj, prop) < // Додаткова властивість if (prop === "latestBrowser") < return obj. browsers[obj.browsers.length - 1]; >// Стандартне повернення значення return obj[prop]; function (obj, prop, value) < // Додаткова властивість if (prop === "latestBrowser") < obj.browsers.push(value); return; == "string") < value = [value]; >// Стандартне збереження значення obj[prop] = value; ); console.log(products.browsers); //['Internet Explorer', 'Netscape'] products.browsers = "Firefox"; // передається як рядок (по помилці) console.log(products.browsers); // ['Firefox']
Пошук елемента масиву за його властивістю
Цей проксі розширює масив додатковими можливостями. Як ви бачите, ви можете гнучко "задавати" властивості без використання Object.defineProperties. Даний приклад також може бути використаний для пошуку рядка таблиці за її коміркою. У цьому випадку метою буде table.rows.
let products = new Proxy( [ < name: "Firefox", type: "browser" >, < name: "SeaMonkey", type: "browser" >, < name: "Thunderbird", type: "mailer" >, ] , < get: function (obj, prop) < // Стандартне повернення значення; return obj[prop]; >// Отримання кількості продуктів; if (product.name === prop) < result = product; >if (types[product.type]) < types[product.type].push(product); >else < types[product.type] = [product]; >> // Отримання продукту по імені if (result) < return result; >// Отримання типів продуктів if (prop === "types") < return Object.keys(types); >return undefined; console.log(products[0]); // <name: 'Firefox', type: 'browser' >console.log(products["Firefox"]); // < name: 'Firefox', type: 'browser' >console.log(products["Chrome"]); // undefined console.log(products.browser); // [< name: 'Firefox', type: 'browser' >, < name: 'SeaMonkey', type: 'browser' >] console.log(products.types); //['browser', 'mailer'] console.log(products.number); // 3
Приклад використання всіх перехоплювачів
У цьому прикладі, який використовує всі види перехоплювачів, ми спробуємо проксувати не нативний об'єкт, який частково пристосований для цього - docCookies, створений у розділі "little framework" та опублікований на сторінці document.cookie.
/* var docCookies = . отримати об'єкт "docCookies" можна тут: https://developer.mozilla.org/ru/docs/DOM/document.cookie#A_little_framework.3A_a_complete_cookies_reader.2Fwriter_with_full_unicode_support *( var docCookies = New Proxy sKey) < return oTarget[sKey] || oTarget.getItem(sKey) || , vValue); >, deleteProperty: function (oTarget, sKey) < if (sKey in oTarget) < return false; >return oTarget.removeItem(sKey); > enumerate: function (oTarget, sKey) < return oTarget.keys(); < return oTarget.keys(); > ownKeys: function (oTarget, sKey) < return oTarget.keys(); has: function (oTarget, sKey) < return sKey in oTarget || .hasItem(sKey); > defineProperty: function (oTarget, sKey, oDesc) < if (oDesc && "value" in oDesc) < oTarget.setItem(sKey, oDesc.value); >return oTarget; >, getPropertyNames: function (oTarget) < return Object.getPropertyNames(oTarget).concat(oTarget.keys()); >, getOwnPropertyNames: function (oTarget) < return Object.getOwnPropertyNames(oTarget).concat(oTarget.keys()); >, getPropertyDescriptor: function (oTarget, sKey) < var vValue = oTarget[sKey] || oTarget.getItem(sKey); return vValue? < value: vValue, writable: true, enumerable: true, configurable: false, >: undefined; >, getOwnPropertyDescriptor: function (oTarget, sKey) < var vValue = oTarget.getItem(sKey); return vValue? < value: vValue, writable: true, enumerable: true, configurable: false, >: undefined; >, fix: function (oTarget) < return "не implemented yet!"; >, >); /* Перевірка cookies */ alert((docCookies.my_cookie1 = "First value")); alert(docCookies.getItem("my_cookie1")); docCookies.setItem("my_cookie1", "Changed value"); alert(docCookies.my_cookie1);
Дивіться також
- "Proxies are awesome" презентація Brendan Eich на JSConf (слайди)
- Сторінка пропозиції ECMAScript Harmony Proxy та сторінка ECMAScript Harmony proxy semantics
- Посібник з проксі
- Стара сторінка Proxy API
- Object.watch - не стандартна можливість, підтримується тільки в двигуні Gecko.
Ліцензійні примітки
Деякий вміст (текст, приклади) цієї сторінки було скопійовано або адаптовано зі сторінок вікі ECMAScript, що має ліцензію CC 2.0 BY-NC-SA