Codelab: プッシュ通知クライアントを作成する

Kate Jeffreys

Kayce Basques

この Codelab では、プッシュ通知クライアントの作成手順を説明します。この Codelab を修了すると、次のようなクライアントが作成されます。

• ユーザーをプッシュ通知に登録します。
• プッシュ メッセージを受信し、通知として表示します。
• ユーザーのプッシュ通知の登録を解除します。

この Codelab は、実際にやって学ぶことに焦点を当てており、コンセプトについてはあまり説明しません。プッシュ通知のコンセプトについては、プッシュ通知の仕組みをご覧ください。

この Codelab のサーバーコードはすでに完成しています。この Codelab ではクライアントのみを実装します。プッシュ通知サーバーの実装方法については、Codelab: プッシュ通知サーバーを構築するをご覧ください。

完全なコードについては、push-notifications-client-codelab-complete（ソース）をご覧ください。

ブラウザの互換性

この Codelab は、次のオペレーティング システムとブラウザの組み合わせで動作することが確認されています。

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

この Codelab は、次のオペレーティング システム（またはオペレーティング システムとブラウザの組み合わせ）では動作しないことが確認されています。

• macOS: Brave、Edge、Safari
• iOS

設定

コードの編集可能なコピーを取得する

この手順の右側に表示されるコードエディタは、この Codelab では Glitch UI と呼びます。

1. [Remix to Edit] をクリックしてプロジェクトを編集可能にします。

認証の設定

プッシュ通知を機能させるには、サーバーとクライアントに認証キーを設定する必要があります。理由については、ウェブ push プロトコル リクエストに署名するをご覧ください。

1. Glitch UI で [Tools] をクリックし、[Terminal] をクリックして Glitch ターミナルを開きます。
2. Glitch ターミナルで npx web-push generate-vapid-keys を実行します。秘密鍵と公開鍵の値をコピーします。
3. Glitch UI で .env を開き、VAPID_PUBLIC_KEY と VAPID_PRIVATE_KEY を更新します。VAPID_SUBJECT を mailto:test@test.test に設定します。これらの値はすべて二重引用符で囲む必要があります。更新を行うと、.env ファイルは次のようになります。

VAPID_PUBLIC_KEY="BKiwTvD9HA…"
VAPID_PRIVATE_KEY="4mXG9jBUaU…"
VAPID_SUBJECT="mailto:test@test.test"

1. Glitch ターミナルを閉じます。

1. public/index.js を開きます。
2. VAPID_PUBLIC_KEY_VALUE_HERE は、公開鍵の値に置き換えます。

Service Worker を登録する

クライアントが通知を受信して表示するには、最終的に Service Worker が必要になります。Service Worker はできるだけ早く登録することをおすすめします。詳細については、push されたメッセージを通知として受信して表示するをご覧ください。

1. // TODO add startup logic here コメントを次のコードに置き換えます。

// TODO add startup logic here
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);

1. サイトをプレビューするには、[アプリを表示] を押してから、全画面表示 を押します。

1. Ctrl+Shift+J キー（Mac の場合は Command+Option+J キー）を押して DevTools を開きます。
2. [Console]（コンソール）タブをクリックします。コンソールに Service worker was registered. というメッセージが表示されます。

プッシュ通知権限をリクエストする

ページの読み込み時にプッシュ通知を送信する権限をリクエストしないでください。代わりに、プッシュ通知を受信するかどうかを UI でユーザーに確認する必要があります。ユーザーが明示的に（たとえばボタンをクリックする）確認したら、ブラウザからプッシュ通知の権限を取得するための正式なプロセスを開始できます。

1. Glitch の UI で [View Source] をクリックしてコードに戻ります。
2. public/index.js で、subscribeButtonHandler() の // TODO コメントを次のコードに置き換えます。

// TODO
// 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.');
}

1. アプリのタブに戻り、[Subscribe to push] をクリックします。ブラウザやオペレーティング システムによって、ウェブサイトからプッシュ通知の送信を許可するかどうかを尋ねられることがあります。[許可]（またはブラウザや OS で使用されている同等のフレーズ）をクリックします。リクエストが承認または拒否されたことを示すメッセージがコンソールに表示されます。

プッシュ通知に登録する

サブスクリプション プロセスには、ブラウザ ベンダーが制御する push サービスと呼ばれるウェブサービスとのインタラクションが含まれます。プッシュ通知の購読情報を取得したら、それをサーバーに送信し、サーバーがデータベースに長期間保存する必要があります。購読プロセスの詳細なコンテキストについては、クライアントをプッシュ通知に登録するをご覧ください。

1. 以下のハイライト表示されたコードを subscribeButtonHandler() に追加します。

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)
});

userVisibleOnly オプションは true にする必要があります。ユーザーに表示される通知（サイレント プッシュ）を表示せずにメッセージをプッシュすることもできるかもしれませんが、現在のところ、ブラウザではプライバシーに関する懸念から、この機能は許可されていません。

applicationServerKey 値は、base64 文字列を Uint8Array に変換するユーティリティ関数に依存しています。この値は、サーバーと push サービス間の認証に使用されます。

プッシュ通知の登録を解除

ユーザーがプッシュ通知にサブスクライブした後、ユーザーが気が変わり、プッシュ通知の受信をやめた場合に備えて、サブスクライブする方法を UI で提供する必要があります。

1. unsubscribeButtonHandler() の // TODO コメントを次のコードに置き換えます。

// TODO
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;
}

プッシュ メッセージを受信して通知として表示する

前述のように、サーバーからクライアントに push されたメッセージの受信と表示を処理する Service Worker が必要です。詳細については、push されたメッセージを通知として受信して表示するをご覧ください。

1. public/service-worker.js を開き、Service Worker の push イベント ハンドラの // TODO コメントを次のコードに置き換えます。

// TODO
let data = event.data.json();
const image = 'https://cdn.glitch.com/614286c9-b4fc-4303-a6a9-a4cef0601b74%2Flogo.png?v=1605150951230';
const options = {
  body: data.options.body,
  icon: image
}
self.registration.showNotification(
  data.title, 
  options
);

1. アプリのタブに戻ります。
2. [通知を受け取る] をクリックします。プッシュ通知が送信されます。
3. 他のブラウザ（または他のデバイス）でアプリタブの URL を開き、定期購入ワークフローを実行してから、[すべて通知] をクリックします。登録したすべてのブラウザで同じプッシュ通知が届くはずです。動作することが確認されているブラウザと OS の組み合わせの一覧については、ブラウザの互換性を再度ご確認ください。

通知はさまざまな方法でカスタマイズできます。詳しくは、ServiceWorkerRegistration.showNotification() のパラメータをご覧ください。

ユーザーが通知をクリックしたときに URL を開く

実際には、ユーザーに再度働きかけてサイトへの訪問を促す手段として通知を利用することになるでしょう。そのためには、Service Worker をもう少し構成する必要があります。

1. Service Worker の notificationclick イベント ハンドラの // TODO コメントを次のコードに置き換えます。

// TODO
event.notification.close();
event.waitUntil(self.clients.openWindow('https://web.dev'));

1. アプリのタブに戻り、別の通知を自分自身に送信して、その通知をクリックします。ブラウザで新しいタブが開き、https://web.dev が読み込まれます。

次のステップ

• 通知をカスタマイズするさまざまな方法については、ServiceWorkerRegistration.showNotification() をご覧ください。
• プッシュ通知の概要で、プッシュ通知の仕組みをより深く理解する。
• Codelab: プッシュ通知サーバーを構築するを参照して、購読を管理し、ウェブ push プロトコル リクエストを送信するサーバーを構築する。
• 通知生成ツールで通知のカスタマイズ方法をすべて試してみてください。