與服務工作人員之間的雙向通訊

Andrew Guan
Andrew Guan
Demián Renzulli
Demián Renzulli

在某些情況下,網頁應用程式可能需要在網頁和 Service Worker 之間建立雙向通訊管道。

舉例來說,在 Podcast PWA 中,可以建構一項功能,讓使用者下載節目以供離線收聽,並允許 Service Worker 定期通知頁面進度,以便主執行緒更新 UI。

本指南將探討在 Window 和 Service Worker 情境之間實作雙向通訊的不同方式,包括探索不同的 API、Workbox 程式庫,以及一些進階案例。

顯示 Service Worker 和網頁交換訊息的圖表。

使用 Workbox

workbox-window 是 Workbox 程式庫的一組模組,可在視窗環境中執行。Workbox 類別提供 messageSW() 方法,可將訊息傳送至執行個體註冊的 Service Worker,並等待回應。

下列網頁程式碼會建立新的 Workbox 例項,並傳送訊息給 Service Worker,以取得其版本:

const wb = new Workbox('/sw.js');
wb.register();

const swVersion = await wb.messageSW({type: 'GET_VERSION'});
console.log('Service Worker version:', swVersion);

Service Worker 會在另一端實作訊息事件監聽器,並回應已註冊的 Service Worker:

const SW_VERSION = '1.0.0';

self.addEventListener('message', (event) => {
  if (event.data.type === 'GET_VERSION') {
    event.ports[0].postMessage(SW_VERSION);
  }
});

在幕後,程式庫會使用瀏覽器 API,我們將在下一節中介紹:訊息管道,但會抽象化許多實作細節,讓使用更輕鬆,同時利用此 API 具有的廣泛瀏覽器支援。

這張圖表顯示網頁和 Service Worker 之間使用 Workbox Window 進行雙向通訊。

使用瀏覽器 API

如果 Workbox 程式庫無法滿足您的需求,您可以使用多個較低層級的 API,在網頁和 Service Worker 之間實作「雙向」通訊。兩者有部分異同之處:

相似處:

  • 在所有情況下,通訊都會透過 postMessage() 介面從一端開始,並透過實作 message 處理常式在另一端接收。
  • 實際上,所有可用的 API 都能用來實作相同用途,但部分 API 可能會簡化某些情境的開發作業。

差異點:

  • 這些方法有不同的方式來識別通訊的另一端:有些方法會明確參照另一個結構定義,有些方法則可透過在每一端例項化的 Proxy 物件進行隱含通訊。
  • 各項服務支援的瀏覽器不盡相同。
這張圖表顯示網頁和 Service Worker 之間的雙向通訊,以及可用的瀏覽器 API。

Broadcast Channel API

Browser Support

  • Chrome: 54.
  • Edge: 79.
  • Firefox: 38.
  • Safari: 15.4.

Source

Broadcast Channel API 可透過 BroadcastChannel 物件,在瀏覽情境之間進行基本通訊。

如要實作,首先每個情境都必須例項化具有相同 ID 的 BroadcastChannel 物件,並從中傳送及接收訊息:

const broadcast = new BroadcastChannel('channel-123');

BroadcastChannel 物件會公開 postMessage() 介面,將訊息傳送至任何監聽情境:

//send message
broadcast.postMessage({ type: 'MSG_ID', });

任何瀏覽器情境都可以透過 BroadcastChannel 物件的 onmessage 方法監聽訊息:

//listen to messages
broadcast.onmessage = (event) => {
  if (event.data && event.data.type === 'MSG_ID') {
    //process message...
  }
};

如您所見,這裡並未明確參照特定情境,因此不需要先取得 Service Worker 或任何特定用戶端的參照。

這張圖表顯示網頁和 Service Worker 之間使用 Broadcast Channel 物件進行雙向通訊。

缺點是,截至本文撰寫時,API 支援 Chrome、Firefox 和 Edge,但 Safari 等其他瀏覽器尚未支援。

Client API

Browser Support

  • Chrome: 40.
  • Edge: 17.
  • Firefox: 44.
  • Safari: 11.1.

Source

Client API 可讓您取得所有 WindowClient 物件的參照,這些物件代表 Service Worker 控制中的有效分頁。

由於網頁是由單一 Service Worker 控制,因此會透過 serviceWorker 介面直接監聽並傳送訊息給執行中的 Service Worker:

//send message
navigator.serviceWorker.controller.postMessage({
  type: 'MSG_ID',
});

//listen to messages
navigator.serviceWorker.onmessage = (event) => {
  if (event.data && event.data.type === 'MSG_ID') {
    //process response
  }
};

同樣地,Service Worker 會實作 onmessage 監聽器來監聽訊息:

//listen to messages
self.addEventListener('message', (event) => {
  if (event.data && event.data.type === 'MSG_ID') {
    //Process message
  }
});

如要與任何用戶端通訊,Service Worker 會執行 Clients.matchAll() 和 Clients.get() 等方法,取得 WindowClient 物件陣列。接著,系統可以對其中任何一個執行 postMessage():

//Obtain an array of Window client objects
self.clients.matchAll(options).then(function (clients) {
  if (clients && clients.length) {
    //Respond to last focused tab
    clients[0].postMessage({type: 'MSG_ID'});
  }
});
這張圖表顯示 Service Worker 與一系列用戶端通訊。

Client API 是個不錯的選擇,可讓您以相對簡單的方式,輕鬆與 Service Worker 的所有有效分頁通訊。所有主要瀏覽器都支援這個 API,但可能不支援所有方法,因此請務必先確認瀏覽器支援情形,再於網站中導入。

訊息管道

Browser Support

  • Chrome: 2.
  • Edge: 12.
  • Firefox: 41.
  • Safari: 5.

Source

訊息管道需要定義並傳遞通訊埠,從一個情境傳遞到另一個情境,以建立雙向通訊管道。

為初始化管道,頁面會例項化 MessageChannel 物件,並使用該物件將通訊埠傳送至已註冊的 Service Worker。該頁面也會實作 onmessage 事件監聽器,接收來自其他情境的訊息:

const messageChannel = new MessageChannel();

//Init port
navigator.serviceWorker.controller.postMessage({type: 'PORT_INITIALIZATION'}, [
  messageChannel.port2,
]);

//Listen to messages
messageChannel.port1.onmessage = (event) => {
  // Process message
};
這張圖表顯示網頁將通訊埠傳遞至 Service Worker,以建立雙向通訊。

Service Worker 會接收通訊埠、儲存通訊埠的參照,並使用該通訊埠將訊息傳送至另一端:

let communicationPort;

//Save reference to port
self.addEventListener('message', (event) => {
  if (event.data && event.data.type === 'PORT_INITIALIZATION') {
    communicationPort = event.ports[0];
  }
});

//Send messages
communicationPort.postMessage({type: 'MSG_ID'});

MessageChannel 目前支援所有主要瀏覽器。

進階 API:背景同步和背景擷取

在本指南中,我們探討了實作雙向通訊技術的方法,適用於相對簡單的情況,例如傳遞描述要執行的作業的字串訊息,或從一個內容快取到另一個內容的網址清單。本節將探討兩個 API,用於處理特定情境:連線中斷和下載時間過長。

背景同步處理

Browser Support

  • Chrome: 49.
  • Edge: 79.
  • Firefox: not supported.
  • Safari: not supported.

Source

即時通訊應用程式可能需要確保訊息不會因連線不佳而遺失。Background Sync API 可讓您延後動作,等到使用者連線穩定時再重試。這有助於確保使用者想傳送的內容確實傳送出去。

該頁面會註冊 sync,而非 postMessage() 介面:

navigator.serviceWorker.ready.then(function (swRegistration) {
  return swRegistration.sync.register('myFirstSync');
});

接著,Service Worker 會監聽 sync 事件,處理訊息:

self.addEventListener('sync', function (event) {
  if (event.tag == 'myFirstSync') {
    event.waitUntil(doSomeStuff());
  }
});

doSomeStuff() 函式應傳回一個 Promise,指出嘗試執行的作業成功/失敗。如果作業完成,同步處理就會完成。如果失敗,系統會排定另一次同步處理作業。重試同步作業也會等待連線能力,並採用指數輪詢。

作業執行完畢後,Service Worker 就能使用先前介紹的任何通訊 API,與頁面通訊並更新 UI。

Google 搜尋會使用背景同步功能,保留因連線不佳而失敗的查詢,並在使用者上線後重試。作業完成後,系統會透過網路推播通知向使用者傳達結果:

這張圖表顯示網頁將通訊埠傳遞至 Service Worker,以建立雙向通訊。

背景擷取

Browser Support

  • Chrome: 74.
  • Edge: 79.
  • Firefox: not supported.
  • Safari: not supported.

Source

對於傳送訊息或快取網址清單等相對簡短的工作,目前探討的選項是不錯的選擇。如果工作耗時過長,瀏覽器會終止 Service Worker,否則會對使用者的隱私權和電池造成風險。

Background Fetch API 可讓您將長時間任務 (例如下載電影、Podcast 或遊戲關卡) 卸載至 Service Worker。

如要從頁面與 Service Worker 通訊,請使用 backgroundFetch.fetch,而非 postMessage():

navigator.serviceWorker.ready.then(async (swReg) => {
  const bgFetch = await swReg.backgroundFetch.fetch(
    'my-fetch',
    ['/ep-5.mp3', 'ep-5-artwork.jpg'],
    {
      title: 'Episode 5: Interesting things.',
      icons: [
        {
          sizes: '300x300',
          src: '/ep-5-icon.png',
          type: 'image/png',
        },
      ],
      downloadTotal: 60 * 1024 * 1024,
    },
  );
});

BackgroundFetchRegistration 物件可讓頁面監聽 progress 事件,追蹤下載進度:

bgFetch.addEventListener('progress', () => {
  // If we didn't provide a total, we can't provide a %.
  if (!bgFetch.downloadTotal) return;

  const percent = Math.round(
    (bgFetch.downloaded / bgFetch.downloadTotal) * 100,
  );
  console.log(`Download progress: ${percent}%`);
});
這張圖表顯示網頁將通訊埠傳遞至 Service Worker,以建立雙向通訊。
UI 經過更新,可顯示下載進度 (左)。多虧有 Service Worker,即使所有分頁都已關閉,作業仍可繼續執行 (右)。

後續步驟

在本指南中,我們探討了網頁和 Service Worker 之間最常見的通訊案例 (雙向通訊)。

很多時候,可能只需要一個情境與另一個情境通訊,而不需要接收回應。請參閱下列指南,瞭解如何在網頁中實作單向技術,以及如何與 Service Worker 互動,並查看用途和實際範例:

  • 強制快取指南:從網頁呼叫 Service Worker,預先快取資源 (例如在預先擷取情境中)。
  • 廣播更新:從 Service Worker 呼叫頁面,通知重要更新 (例如有新版網頁應用程式)。