Ćwiczenia z programowania: tworzenie klienta powiadomień push

Kate Jeffreys
Kate Jeffreys
Kayce Basques
Kayce Basques

To ćwiczenie pokazuje krok po kroku, jak utworzyć klienta powiadomień push. Po ukończeniu tego ćwiczenia będziesz mieć klienta, który:

  • Subskrybuje powiadomienia push dla użytkownika.
  • Odbiera wiadomości push i wyświetla je jako powiadomienia.
  • Anuluje subskrypcję powiadomień push przez użytkownika.

To ćwiczenie koncentruje się na nauce przez praktykę i nie omawia zbyt wielu pojęć. Aby dowiedzieć się więcej o powiadomieniach push, przeczytaj artykuł Jak działają powiadomienia push.

Kod serwera w tym ćwiczeniu z programowania jest już gotowy. W tym ćwiczeniu wdrożysz tylko klienta. Aby dowiedzieć się, jak wdrożyć serwer powiadomień push, zapoznaj się z kursem programowania: Tworzenie serwera powiadomień push.

Zgodność z przeglądarką

Ten ćwiczenie działa z tymi kombinacjami systemów operacyjnych i przeglądarek:

  • Windows: Chrome, Edge
  • macOS: Chrome, Firefox
  • Android: Chrome, Firefox

To ćwiczenie nie działa w tych systemach operacyjnych (lub kombinacjach systemów operacyjnych i przeglądarek):

  • macOS: Brave, Edge, Safari
  • iOS

Konfiguracja

Konfigurowanie uwierzytelniania

Zanim zaczniesz korzystać z powiadomień push, musisz skonfigurować serwer i klienta za pomocą kluczy uwierzytelniania. Aby dowiedzieć się, dlaczego, przeczytaj artykuł Podpisywanie żądań protokołu Web Push. Zwykle obiekty tajne przechowuje się w pliku .env, podobnym do tego.

VAPID_PUBLIC_KEY="BKiwTvD9HA…"
VAPID_PRIVATE_KEY="4mXG9jBUaU…"
VAPID_SUBJECT="mailto:test@test.test"
  1. Otwórz pokój public/index.js.
  2. Zastąp VAPID_PUBLIC_KEY_VALUE_HERE wartością klucza publicznego.

Rejestrowanie skryptu service worker

Klient potrzebuje skryptu service worker, aby otrzymywać i wyświetlać powiadomienia. Najlepiej zarejestrować go jak najszybciej. Więcej informacji znajdziesz w artykule Odbieranie i wyświetlanie wiadomości push jako powiadomień.

  1. Zastąp komentarz // TODO add startup logic here tym kodem:

    if ('serviceWorker' in navigator && 'PushManager' in window) {
      navigator.serviceWorker.register('./service-worker.js').then(serviceWorkerRegistration => {
        console.info('Service worker was registered.');
        console.info({serviceWorkerRegistration});
      }).catch(error => {
        console.error('An error occurred while registering the service worker.');
        console.error(error);
      });
      subscribeButton.disabled = false;
    } else {
      console.error('Browser does not support service workers or push messages.');
    }
    
    subscribeButton.addEventListener('click', subscribeButtonHandler);
    unsubscribeButton.addEventListener('click', unsubscribeButtonHandler);
    
  2. W Chrome otwórz konsolę Narzędzi deweloperskich.

  3. W konsoli powinien pojawić się komunikat Service worker was registered..

Prośba o zgodę na wyświetlanie powiadomień push

Nigdy nie proś o zgodę na wysyłanie powiadomień push podczas wczytywania strony. Zamiast tego interfejs powinien pytać użytkownika, czy chce otrzymywać powiadomienia push. Gdy użytkownik wyraźnie potwierdzi zgodę (np. klikając przycisk), możesz rozpocząć formalny proces uzyskiwania zgody na wyświetlanie powiadomień push w przeglądarce.

  1. W pliku public/index.js zastąp komentarz // TODO w subscribeButtonHandler() tym kodem:

    // Prevent the user from clicking the subscribe button multiple times.
    subscribeButton.disabled = true;
    const result = await Notification.requestPermission();
    if (result === 'denied') {
      console.error('The user explicitly denied the permission request.');
      return;
    }
    if (result === 'granted') {
      console.info('The user accepted the permission request.');
    }
    
  2. Wróć na kartę aplikacji i kliknij Subscribe to push (Zasubskrybuj powiadomienia push). Przeglądarka lub system operacyjny zapyta, czy chcesz zezwolić witrynie na wysyłanie powiadomień push.

  3. Wybierz Zezwól (lub odpowiednik tego sformułowania używany przez przeglądarkę lub system operacyjny). W konsoli powinien pojawić się komunikat informujący, czy prośba została zaakceptowana czy odrzucona.

Subskrybuj powiadomienia push

Proces subskrypcji obejmuje interakcję z usługą internetową kontrolowaną przez dostawcę przeglądarki, która nazywa się usługą push. Po uzyskaniu informacji o subskrypcji powiadomień push musisz wysłać je na serwer i zapisać w bazie danych na dłuższy czas.

  1. Dodaj do pliku subscribeButtonHandler() ten wyróżniony kod:

    subscribeButton.disabled = true;
    const result = await Notification.requestPermission();
    if (result === 'denied') {
      console.error('The user explicitly denied the permission request.');
      return;
    }
    if (result === 'granted') {
      console.info('The user accepted the permission request.');
    }
    const registration = await navigator.serviceWorker.getRegistration();
    const subscribed = await registration.pushManager.getSubscription();
    if (subscribed) {
      console.info('User is already subscribed.');
      notifyMeButton.disabled = false;
      unsubscribeButton.disabled = false;
      return;
    }
    const subscription = await registration.pushManager.subscribe({
      userVisibleOnly: true,
      applicationServerKey: urlB64ToUint8Array(VAPID_PUBLIC_KEY)
    });
    notifyMeButton.disabled = false;
    fetch('/add-subscription', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json'
      },
      body: JSON.stringify(subscription)
    });
    

Opcja userVisibleOnly musi mieć wartość true. W przyszłości może być możliwe wysyłanie wiadomości push bez wyświetlania powiadomień widocznych dla użytkownika (ciche powiadomienia push), ale przeglądarki nie zezwalają na tę funkcję ze względu na kwestie dotyczące prywatności.

Wartość applicationServerKey opiera się na funkcji użytkowej, która konwertuje ciąg znaków Base64 na Uint8Array. Ta wartość jest używana do uwierzytelniania między serwerem a usługą push.

Anulowanie subskrypcji powiadomień push

Gdy użytkownik zasubskrybuje powiadomienia push, interfejs musi umożliwiać mu anulowanie subskrypcji, jeśli zmieni zdanie i nie będzie już chciał otrzymywać powiadomień push.

  • Zastąp komentarz // TODO w pliku unsubscribeButtonHandler() tym kodem:
const registration = await navigator.serviceWorker.getRegistration();
const subscription = await registration.pushManager.getSubscription();
fetch('/remove-subscription', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({endpoint: subscription.endpoint})
});
const unsubscribed = await subscription.unsubscribe();
if (unsubscribed) {
  console.info('Successfully unsubscribed from push notifications.');
  unsubscribeButton.disabled = true;
  subscribeButton.disabled = false;
  notifyMeButton.disabled = true;
}

Odbieranie wiadomości push i wyświetlanie jej jako powiadomienia

Jak wspomnieliśmy wcześniej, potrzebujesz skryptu service worker do obsługi odbierania i wyświetlania wiadomości, które zostały przesłane do klienta z serwera. Więcej informacji znajdziesz w sekcji Odbieranie i wyświetlanie wiadomości push jako powiadomień.

  1. Otwórz plik public/service-worker.js i zastąp komentarz // TODO w module obsługi zdarzeń push skryptu service worker tym kodem:

    let data = event.data.json();
    const image = 'logo.png';
    const options = {
      body: data.options.body,
      icon: image
    }
    self.registration.showNotification(
      data.title,
      options
    );
    
  2. Wróć do karty aplikacji.

  3. Kliknij Powiadom mnie. Powinno pojawić się powiadomienie push.

  4. Otwórz adres URL karty aplikacji w innych obsługiwanych przeglądarkach. Wykonaj czynności związane z subskrypcją i kliknij Powiadom wszystkich. W każdym z nich powinno pojawić się to samo powiadomienie push.

Powiadomienie możesz dostosować na wiele sposobów. Więcej informacji znajdziesz w parametrach ServiceWorkerRegistration.showNotification().

Otwieranie adresu URL po kliknięciu powiadomienia przez użytkownika

W rzeczywistości prawdopodobnie użyjesz powiadomienia, aby ponownie zaangażować użytkownika i zachęcić go do odwiedzenia Twojej witryny. Aby to zrobić, musisz nieco bardziej skonfigurować skrypt service worker.

  1. Zastąp komentarz // TODO w module obsługi zdarzeń notificationclick skryptu service worker tym kodem:

    event.notification.close();
    event.waitUntil(self.clients.openWindow('https://web.dev'));
    
  2. Wróć na kartę aplikacji, wyślij sobie kolejne powiadomienie, a następnie kliknij je. Przeglądarka powinna otworzyć nową kartę i załadować stronę https://web.dev.

Dalsze kroki