В этой практической работе вы узнаете, как создать клиент push-уведомлений. В конце практической работы у вас будет клиент, который:
- Подписывает пользователя на push-уведомления.
- Получает push-сообщения и показывает их в виде уведомлений.
- Отменяет подписку пользователя на push-уведомления.
Эта практическая работа ориентирована на обучение на практике и не содержит много теории. Прочитайте статью Как работают push-уведомления.
Код сервера для этой практической работы уже готов. В этой практической работе вы будете реализовывать только клиент. Чтобы узнать, как реализовать сервер push-уведомлений, ознакомьтесь с практической работой по созданию сервера push-уведомлений.
Совместимость браузеров
Эта практическая работа совместима со следующими операционными системами и браузерами:
- Windows: Chrome, Edge.
- macOS: Chrome, Firefox;
- Android: Chrome, Firefox.
Эта практическая работа не работает в следующих операционных системах (или сочетаниях операционной системы и браузера):
- macOS: Brave, Edge, Safari.
- iOS
Настройка
Как настроить аутентификацию
Чтобы push-уведомления работали, необходимо настроить ключи аутентификации на сервере и клиенте.
Подробнее о том, зачем подписывать запросы протокола веб-push… Обычно секреты хранятся в файле .env, как показано ниже.
VAPID_PUBLIC_KEY="BKiwTvD9HA…"
VAPID_PRIVATE_KEY="4mXG9jBUaU…"
VAPID_SUBJECT="mailto:test@test.test"
- Открыть чат "
public/index.js". - Замените
VAPID_PUBLIC_KEY_VALUE_HEREзначением своего открытого ключа.
Зарегистрируйте сервис-воркер
Чтобы получать и показывать уведомления, клиенту нужен сервис-воркер. Рекомендуем регистрировать сервис-воркер как можно раньше. Подробнее о том, как получать и показывать push-сообщения в виде уведомлений…
Замените комментарий
// 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);В консоли должно появиться сообщение
Service worker was registered..
Запрос разрешения на отправку push-уведомлений
Никогда не запрашивайте разрешение на отправку push-уведомлений при загрузке страницы. Вместо этого в интерфейсе должен быть вопрос о том, хочет ли пользователь получать push-уведомления. После того как пользователь явно подтвердит свое согласие (например, нажав кнопку), вы можете начать формальный процесс получения разрешения на push-уведомления от браузера.
В файле
public/index.jsзамените комментарий// TODOвsubscribeButtonHandler()следующим кодом:// 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.'); }Вернитесь на вкладку приложения и нажмите Subscribe to push (Подписаться на push-уведомления). Браузер или операционная система спросит, хотите ли вы разрешить сайту отправлять вам push-уведомления.
Выберите Разрешить (или аналогичный вариант, используемый в вашем браузере или операционной системе). В консоли появится сообщение о том, был ли запрос принят или отклонен.
Включить push-уведомления.
Процесс подписки включает взаимодействие с веб-сервисом, управляемым поставщиком браузера, который называется сервисом push-уведомлений. Получив информацию о подписке на push-уведомления, вы должны отправить ее на сервер и сохранить в базе данных.
Добавьте в файл
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. Возможно, когда-нибудь станет возможным отправлять сообщения без показа уведомлений пользователю (тихие push-уведомления), но сейчас браузеры не позволяют этого делать из соображений конфиденциальности.
Значение applicationServerKey зависит от служебной функции, которая преобразует строку base64 в Uint8Array. Это значение используется для аутентификации между вашим сервером и сервисом push-уведомлений.
Как отключить push-уведомления
После того как пользователь подписался на push-уведомления, в вашем интерфейсе должен быть предусмотрен способ отмены подписки на случай, если пользователь передумает и больше не захочет получать push-уведомления.
- Замените комментарий
// TODOв файлеunsubscribeButtonHandler()следующим кодом:
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-сообщения и его показ в виде уведомления
Как упоминалось ранее, вам нужен сервис-воркер для обработки получения и отображения сообщений, которые были отправлены клиенту с вашего сервера. Подробнее о том, как получать и показывать push-сообщения в виде уведомлений…
Откройте файл
public/service-worker.jsи замените комментарий// TODOв обработчике событийpushсервисного скрипта следующим кодом:let data = event.data.json(); const image = 'logo.png'; const options = { body: data.options.body, icon: image } self.registration.showNotification( data.title, options );Вернитесь на вкладку приложения.
Нажмите Уведомить меня. Вы должны получить push-уведомление.
Откройте URL вкладки приложения в другом поддерживаемом браузере. Выполните необходимые действия и нажмите Уведомить всех. Вы должны получить одинаковые push-уведомления в каждом из них.
Уведомление можно настроить разными способами. Подробнее о параметрах ServiceWorkerRegistration.showNotification()…
Как настроить переход по URL при нажатии на уведомление
В реальном мире вы, вероятно, будете использовать уведомление как способ повторно привлечь пользователя и побудить его посетить ваш сайт. Для этого вам нужно немного настроить сервис-воркер.
Замените комментарий
// TODOв обработчике событийnotificationclickсервисного работника следующим кодом:event.notification.close(); event.waitUntil(self.clients.openWindow('https://web.dev'));Вернитесь на вкладку приложения, отправьте себе ещё одно уведомление и нажмите на него. В браузере должна открыться новая вкладка с адресом
https://web.dev.
Дальнейшие действия
- Ознакомьтесь с
ServiceWorkerRegistration.showNotification(), чтобы узнать обо всех способах настройки уведомлений. - Чтобы лучше понять, как работают push-уведомления, прочитайте обзорную статью.
- Чтобы узнать, как создать сервер, который управляет подписками и отправляет запросы по протоколу Web Push, ознакомьтесь с практической работой по созданию сервера push-уведомлений.
- Попробуйте Notification Generator, чтобы протестировать все способы настройки уведомлений.