Codelab：构建推送通知客户端

Kate Jeffreys
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 界面。

  1. 点击 Remix to Edit 以使项目可修改。

设置身份验证

您需要先使用身份验证密钥设置服务器和客户端，然后推送通知才能正常运行。如需了解原因，请参阅对 Web 推送协议请求进行签名。

  1. 在 Glitch 界面中，点击 Tools（工具），然后点击 Terminal（终端）以打开 Glitch 终端。
  2. 在 Glitch 终端中，运行 npx web-push generate-vapid-keys。复制私钥和公钥值。
  3. 在 Glitch 界面中，打开 .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。如需了解更多背景信息，请参阅接收推送的消息并将其显示为通知。

  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`）打开开发者工具。
  2. 点击 Console（控制台）标签。您应该会看到 Service worker was registered. 消息已记录到控制台。

请求推送通知权限

您绝不能请求在网页加载时发送推送通知的权限。 相反，您的界面应询问用户是否要接收推送通知。一旦他们明确确认（例如，点击按钮），您就可以启动从浏览器获取推送通知权限的正式流程。

  1. 在 Glitch 界面中，点击 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. 返回应用标签页，然后点击订阅以推送。您的浏览器或操作系统可能会询问您是否允许网站向您发送推送通知。点击允许（或您的浏览器/操作系统使用的任何等效短语）。在控制台中，您应该会看到一条消息，指示请求是被接受还是被拒绝。

订阅推送通知

订阅流程涉及与由浏览器供应商控制的网络服务交互，该服务称为“推送服务”。获得推送通知订阅信息后，您需要将其发送到服务器，并让服务器长期将其存储在数据库中。如需详细了解订阅流程，请参阅为客户端订阅推送通知。

  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 的实用函数。此值用于在服务器与推送服务之间进行身份验证。

退订推送通知

用户订阅推送通知后，您的界面需要提供退订方法，以防用户改变主意，不想再接收推送通知。

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

接收推送消息并将其显示为通知

如前所述，您需要一个 Service Worker 来接收和显示从服务器推送到客户端的消息。如需了解详情，请参阅接收推送的消息并将其显示为通知。

  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. 尝试在其他浏览器（甚至其他设备）上打开您的应用标签页的网址，完成订阅工作流，然后点击全部通知。您应该会在订阅的所有浏览器上收到相同的推送通知如需查看已知可正常运行或无效的浏览器/操作系统组合列表，请参阅浏览器兼容性部分。

您可以通过多种方式自定义通知。如需了解详情，请参阅 ServiceWorkerRegistration.showNotification() 的参数。

在用户点击通知时打开网址

在现实世界中，您可能会使用通知作为一种重新吸引用户的方式，并提示他们访问您的网站。为此，您需要进一步配置 Service Worker。

  1. 将 Service Worker 的 notificationclick 事件处理脚本中的 // TODO 注释替换为以下代码：
// TODO
event.notification.close();
event.waitUntil(self.clients.openWindow('https://web.dev'));
  1. 返回“应用”标签页，向自己发送另一条通知，然后点击该通知。您的浏览器应该会打开一个新标签页并加载 https://web.dev。

后续步骤