CKTIS / JavaScript
Прехвърляне на ArrayBuffer с postMessage: собственост и отделяне
При прехвърляне на `ArrayBuffer` чрез `postMessage()` буферът на подателя се отделя преди доставката. Без списък за прехвърляне байтовете се копират.
Версия: ECMAScript 2024 and the current web platform; runtime support varies
Синтаксис
worker.postMessage(message)
worker.postMessage(message, [buffer])
worker.postMessage(message, { transfer: [buffer] })
self.postMessage(message, [buffer]) // Dedicated worker global scope
port.postMessage(message, [buffer])
port.postMessage(message, { transfer: [buffer] })
targetWindow.postMessage(message, targetOrigin, [buffer])
targetWindow.postMessage(message, { targetOrigin, transfer: [buffer] })Ако обикновен ArrayBuffer е в съобщението, но не и в списъка за прехвърляне, структурираното клониране копира байтовете му и подателят може да продължи да използва своя буфер. Включването му в списъка прехвърля собствеността върху паметта, вместо тя да се споделя. При успешно прехвърляне буферът на подателя вече е отделен, когато извикването приключи. Ако съобщението пристигне, при последващо събитие message получателят получава в event.data нов буферен обект с първоначалните байтове. Отделянето не потвърждава доставката.
Постави същия буфер и в съобщението, например { buffer }, и в списъка за прехвърляне [buffer]. Посочването му само в списъка може да го отдели, без да го направи достъпен в данните на съобщението. Изглед Uint8Array или DataView може да се клонира, но не може да се постави директно в списъка за прехвърляне. Използвай view.buffer: прехвърля се целият базов буфер, а не само диапазонът на изгледа.
Отделянето не изтрива обекта или препратките към него. buffer.byteLength и свойството byteLength на съществуващите типизирани масиви върху този буфер връщат 0, но прочитането на byteLength на DataView върху него предизвиква TypeError. Стойност 0 сама по себе си не доказва отделяне: неотделен буфер също може да е празен. Ако средата поддържа гетъра ArrayBuffer.prototype.detached от ECMAScript 2024, провери buffer.detached.
Повторен или вече отделен буфер, изглед или SharedArrayBuffer в списъка за прехвърляне, както и стойност в съобщението, която не може да се клонира, например функция, могат синхронно да предизвикат изключение DOMException с име DataCloneError. Когато изпращането на SharedArrayBuffer е разрешено, паметта се споделя, вместо собствеността върху нея да се прехвърля.
Worker, MessagePort и глобалният контекст на специализиран worker приемат след съобщението списък или опции { transfer }. За прозорец посочи targetOrigin преди списъка или използвай { targetOrigin, transfer }. Стойността по подразбиране "/" означава произхода на подателя. Ако знаеш целевия произход, посочи го точно вместо "*". При получаване провери event.origin, при необходимост event.source, и валидността на данните. postMessage() е API на уеб платформата, а не част от ECMAScript; поддръжката зависи от средата за изпълнение.
Примери
(() => {
const { port1, port2 } = new MessageChannel();
const view = new Uint8Array([7, 42, 255]);
const buffer = view.buffer;
port2.onmessage = ({ data }) => {
const bytes = new Uint8Array(data.buffer);
console.log(`received: ${bytes.byteLength} bytes (${bytes.join(', ')})`);
port1.close();
port2.close();
};
console.log(`before: buffer=${buffer.byteLength}, view=${view.byteLength}`);
port1.postMessage({ buffer }, [buffer]);
console.log(`after: buffer=${buffer.byteLength}, view=${view.byteLength}`);
})();Резултат
before: buffer=3, view=3 after: buffer=0, view=0 received: 3 bytes (7, 42, 255)
Изпълни кода в конзолата за разработчици на браузъра. Двата порта работят на една и съща страница без worker. Очакват се първо двата реда на подателя, а след това редът на получателя с трите непроменени байта.
Свързани уроци
- JavaScript · Урок 5 · Напреднало · Версия: 4
Източници
- HTML Standard — Safe passing of structured data
- HTML Standard — StructuredSerializeWithTransfer (value, transferList)
- HTML Standard — Cross-document messaging
- HTML Standard — Channel messaging
- HTML Standard — Dedicated workers and the Worker interface
- ECMAScript 2024 Language Specification — Properties of the ArrayBuffer Prototype Object
- ECMAScript 2024 Language Specification — get DataView.prototype.byteLength
- ECMAScript 2024 Language Specification — Properties of the %TypedArray% Prototype Object