Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

MessageEvent: source, origin e data

Distingue a referência ao remetente, a origem no momento do envio e os dados a validar antes de processares uma mensagem entre janelas.

Versão: ECMAScript 2024 and the current web platform; runtime support varies

Sintaxe

event.source
 event.origin
 event.data

source, origin e data são propriedades de instância de MessageEvent só de leitura. Pertencem a uma API da plataforma Web, não ao ECMAScript 2024; a disponibilidade depende do ambiente de execução.

Com Window.postMessage(), event.source é o WindowProxy do contexto de navegação do remetente. Quando uma janela envia uma mensagem a si própria, o remetente e o destinatário têm o mesmo WindowProxy. Consoante a API, source também pode ser um MessagePort (por exemplo, no evento connect de um worker partilhado), um ServiceWorker ou null. Num evento message normal recebido através de um MessagePort, source tem o valor null e origin tem o valor "".

Na comunicação entre janelas, event.origin contém a origem serializada do remetente no momento do envio: esquema, anfitrião e, se aplicável, porta, sem caminho, consulta nem fragmento. O mesmo WindowProxy pode referir-se a outro documento após uma navegação, pelo que origin não indica o que está carregado agora. Uma origem opaca é serializada como a cadeia "null", distinta da cadeia vazia "" e do valor null de JavaScript.

event.data contém os dados enviados. Window.postMessage() usa clonagem estruturada, não JSON nem uma referência direta ao objeto original. Enviar um valor que não pode ser clonado, como uma função, lança DataCloneError no lado do remetente.

Antes de usares data, compara origin com a origem exata esperada usando ===, verifica source se souberes qual é a janela esperada e valida a estrutura e os valores dos dados. Ao enviar ou responder, indica um targetOrigin exato se o conheceres. Este restringe o destinatário, mas não substitui as verificações feitas na receção. Não envies dados confidenciais com "*".

Exemplos

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>MessageEvent: source, origin, and data</title>
</head>
<body>
<script>
(() => {
  const expectedOrigin = window.location.origin;
  const expectedSource = window;

  function receive(event) {
    if (event.origin !== expectedOrigin || event.source !== expectedSource) return;

    const data = event.data;
    if (data === null || typeof data !== "object" ||
        data.type !== "cktis:count" || !Number.isInteger(data.count)) return;

    window.removeEventListener("message", receive);
    console.log(`source === window: ${event.source === window}`);
    console.log(`origin === expectedOrigin: ${event.origin === expectedOrigin}`);
    console.log(`data.count: ${data.count}`);
  }

  window.addEventListener("message", receive);
  window.postMessage({ type: "cktis:count", count: 7 }, expectedOrigin);
})();
</script>
</body>
</html>

Resultado

source === window: true
origin === expectedOrigin: true
data.count: 7

Disponibiliza o ficheiro HTML por HTTP(S) e abre-o num separador do navegador sem sandbox. A janela envia uma mensagem a si própria. As três linhas aparecem de forma assíncrona na consola do navegador depois de o manipulador aceitar a mensagem e remover o listener.

Lições relacionadas

  • JavaScript · Lição 5 · Avançado · Versão: 4

Fontes