推送事件

Matt Gaunt

到目前為止,我們已介紹如何讓使用者訂閱及傳送推播訊息。下一步是在使用者裝置上接收這則推播訊息,並顯示通知 (以及執行任何其他可能需要執行的工作)。

推送事件

收到訊息時,系統會在 Service Worker 中調度推送事件。

設定推送事件監聽器的程式碼,與您在 JavaScript 中編寫的其他事件監聽器非常相似:

self.addEventListener('push', function(event) {
    if (event.data) {
    console.log('This push event has data: ', event.data.text());
    } else {
    console.log('This push event has no data.');
    }
});

對大多數剛接觸 Service Worker 的開發人員來說,這段程式碼最奇怪的部分是 self 變數。self 通常用於網路 worker,也就是 Service Worker。self 是指全域範圍,類似於網頁中的 window。但對於網路 worker 和 service worker,self 則是指 worker 本身。

在上述範例中,self.addEventListener() 可視為在 Service Worker 本身新增事件監聽器。

在推送事件範例中,我們會檢查是否有任何資料,並在控制台中輸出內容。

您也可以透過其他方式剖析推送事件的資料:

// Returns string
event.data.text()

// Parses data as JSON string and returns an Object
event.data.json()

// Returns blob of data
event.data.blob()

// Returns an arrayBuffer
event.data.arrayBuffer()

大多數使用者會根據對應用程式的期望,使用 json() 或 text()。

這個範例說明如何新增推送事件監聽器,以及如何存取資料,但缺少兩項非常重要的功能。不會顯示通知,也不會使用 event.waitUntil()。

等到

關於 Service Worker,您需要瞭解的一點是,您幾乎無法控制 Service Worker 程式碼的執行時間。瀏覽器會決定何時喚醒和終止。如要告知瀏覽器「我正在忙著處理重要事務」,唯一的方法是將 Promise 傳遞至 event.waitUntil() 方法。這樣一來,瀏覽器就會持續執行 Service Worker,直到傳入的 Promise 解決為止。

如果是推送事件,則有額外規定:您必須在傳入的 Promise 結算前顯示通知。

以下是顯示通知的基本範例:

self.addEventListener('push', function(event) {
    const promiseChain = self.registration.showNotification('Hello, World.');

    event.waitUntil(promiseChain);
});

呼叫 self.registration.showNotification() 是向使用者顯示通知的方法,並會傳回在通知顯示後解析的 Promise。

為了盡可能清楚說明這個範例,我將這個 Promise 指派給名為 promiseChain 的變數。接著,這個值會傳入 event.waitUntil()。我知道這很冗長,但我看過許多問題,都是因為誤解應傳入 waitUntil() 的內容,或承諾鏈中斷而造成。

以下是更複雜的範例,其中包含資料網路要求,以及使用數據分析追蹤推送事件:

self.addEventListener('push', function(event) {
    const analyticsPromise = pushReceivedTracking();
    const pushInfoPromise = fetch('/api/get-more-data')
    .then(function(response) {
        return response.json();
    })
    .then(function(response) {
        const title = response.data.userName + ' says...';
        const message = response.data.message;

        return self.registration.showNotification(title, {
        body: message
        });
    });

    const promiseChain = Promise.all([
    analyticsPromise,
    pushInfoPromise
    ]);

    event.waitUntil(promiseChain);
});

這裡我們呼叫會傳回 Promise pushReceivedTracking() 的函式,在本範例中,我們假設這個函式會向數據分析供應商發出網路要求。我們也會提出網路要求、取得回應,並使用回應資料顯示通知,做為通知的標題和訊息。

只要將這些 Promise 與 Promise.all() 結合,就能確保 Service Worker 在這兩項工作完成時保持運作。產生的 Promise 會傳遞至 event.waitUntil(),這表示瀏覽器會等到兩個 Promise 都完成後,再檢查是否已顯示通知並終止 Service Worker。

我們之所以要關注 waitUntil() 及其使用方式,是因為開發人員最常遇到的問題之一,就是當 Promise 鏈結不正確/中斷時,Chrome 會顯示以下「預設」通知:

Chrome 預設通知的圖片

只有在收到推播訊息,且 Service Worker 中的推播事件在傳遞至 event.waitUntil() 的 Promise 完成後「未」顯示通知時,Chrome 才會顯示「這個網站在背景更新」通知。

開發人員之所以會遇到這個問題,主要是因為程式碼通常會呼叫 self.registration.showNotification(),但不會對傳回的 Promise 執行任何操作。這會導致系統間歇性顯示預設通知。舉例來說,如果我們在上述範例中移除 self.registration.showNotification() 的傳回值,就有可能看到這則通知。

self.addEventListener('push', function(event) {
    const analyticsPromise = pushReceivedTracking();
    const pushInfoPromise = fetch('/api/get-more-data')
    .then(function(response) {
        return response.json();
    })
    .then(function(response) {
        const title = response.data.userName + ' says...';
        const message = response.data.message;

        self.registration.showNotification(title, {
        body: message
        });
    });

    const promiseChain = Promise.all([
    analyticsPromise,
    pushInfoPromise
    ]);

    event.waitUntil(promiseChain);
});

這很容易忽略。

請注意,如果看到這則通知,請檢查 Promise 鏈結和 event.waitUntil()。

在下一節中,我們將探討如何設定通知樣式,以及可以顯示哪些內容。

後續步驟

程式碼研究室