ServiceWorkerContainer:message 事件

Baseline 已廣泛支援

此功能已成熟,可跨多種裝置和瀏覽器版本工作。它自 ⁨2018 年 4 月⁩ 起已在所有瀏覽器中可用。

安全上下文: 此功能僅在安全上下文(HTTPS)中可用,且支援此功能的瀏覽器數量有限。

注意:此功能在 Web Workers 中可用。

message 事件用於由 service worker 控制的頁面接收來自 service worker 的訊息。

此事件不可取消,也不會冒泡。

語法

在諸如 addEventListener() 之類的方法中使用事件名稱,或設定事件處理程式屬性。

js
addEventListener("message", (event) => { })

onmessage = (event) => { }

事件型別

一個 MessageEvent。繼承自 Event

Event MessageEvent

事件屬性

此介面還繼承了其父級 Event 的屬性。

MessageEvent.data 只讀

由訊息傳送者傳送的資料。

MessageEvent.origin 只讀

一個字串,表示訊息傳送者的源。

MessageEvent.lastEventId 只讀

一個字串,表示事件的唯一 ID。

MessageEvent.source 只讀

一個 MessageEventSource(可以是 WindowProxyMessagePortServiceWorker 物件),表示訊息傳送者。

MessageEvent.ports 只讀

一個 MessagePort 物件陣列,表示訊息傳送通道(如果適用,例如在通道訊息傳遞或向共享工作者傳送訊息時)關聯的埠。

示例

在此示例中,service worker 從 fetch 事件中獲取客戶端 ID,然後使用 Client.postMessage 向其傳送訊息。

js
// service-worker.js
async function messageClient(clientId) {
  const client = await clients.get(clientId);
  client.postMessage("Hi client!");
}

addEventListener("fetch", (event) => {
  messageClient(event.clientId);
  event.respondWith(() => {
    // …
  });
});

客戶端可以透過監聽 message 事件來接收訊息。

js
// main.js
navigator.serviceWorker.addEventListener("message", (message) => {
  console.log(message);
});

或者,客戶端也可以使用 onmessage 事件處理程式來接收訊息。

js
// main.js
navigator.serviceWorker.onmessage = (message) => {
  console.log(message);
};

規範

規範
Service Workers
# dom-serviceworkercontainer-onmessage

瀏覽器相容性

另見