이 Codelab에서는 푸시 알림 클라이언트를 빌드하는 방법을 단계별로 보여줍니다. Codelab을 마치면 다음과 같은 클라이언트가 생성됩니다.
- 사용자가 푸시 알림을 구독합니다.
- 푸시 메시지를 수신하고 알림으로 표시합니다.
- 사용자의 푸시 알림 수신을 취소합니다.
이 Codelab은 직접 해보면서 학습하는 데 중점을 두며 개념에 관해서는 많이 다루지 않습니다. 푸시 알림 개념에 대해 알아보려면 푸시 작동 방식을 읽어보세요.
이 Codelab의 서버 코드는 이미 완성되어 있습니다. 이 Codelab에서는 클라이언트만 구현합니다. 푸시 알림 서버를 구현하는 방법을 알아보려면 Codelab: 푸시 알림 서버 빌드를 참고하세요.
브라우저 호환성
이 Codelab은 다음 운영체제 및 브라우저 조합에서 작동하는 것으로 알려져 있습니다.
- Windows: Chrome, Edge
- macOS: Chrome, Firefox
- Android: Chrome, Firefox
이 Codelab은 다음 운영체제(또는 운영체제와 브라우저 조합)에서 작동하지 않는 것으로 알려져 있습니다.
- macOS: Brave, Edge, Safari
- iOS
설정
인증 설정
푸시 알림을 작동하려면 먼저 인증 키를 사용하여 서버와 클라이언트를 설정해야 합니다.
이유는 웹 푸시 프로토콜 요청 서명을 참고하세요. 일반적으로 보안 비밀은 이와 유사한 .env 파일에 저장합니다.
VAPID_PUBLIC_KEY="BKiwTvD9HA…"
VAPID_PRIVATE_KEY="4mXG9jBUaU…"
VAPID_SUBJECT="mailto:test@test.test"
public/index.js를 엽니다.VAPID_PUBLIC_KEY_VALUE_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);Chrome에서 DevTools 콘솔을 엽니다.
Service worker was registered.메시지가 Console에 로깅됩니다.
푸시 알림 권한 요청
페이지 로드 시 푸시 알림 전송 권한을 요청해서는 안 됩니다. 대신 UI에서 사용자에게 푸시 알림을 수신할지 물어야 합니다. 사용자가 명시적으로 확인하면(예: 버튼 클릭) 브라우저에서 푸시 알림 권한을 가져오는 공식 프로세스를 시작할 수 있습니다.
public/index.js에서subscribeButtonHandler()의// 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.'); }앱 탭으로 돌아가서 푸시 구독을 클릭합니다. 브라우저 또는 운영체제에서 웹사이트가 푸시 알림을 보내도록 허용할지 묻는 메시지가 표시됩니다.
허용(또는 브라우저나 운영체제에서 사용하는 이와 동등한 문구)을 선택합니다. 콘솔에 요청이 수락되었는지 또는 거부되었는지를 나타내는 메시지가 표시됩니다.
푸시 알림 구독
구독 프로세스에는 푸시 서비스라고 하는 브라우저 공급업체에서 제어하는 웹 서비스와의 상호작용이 포함됩니다. 푸시 알림 구독 정보를 가져오면 이를 서버로 전송하고 서버가 데이터베이스에 장기적으로 저장하도록 해야 합니다.
강조표시된 다음 코드를
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로 변환하는 유틸리티 함수를 사용합니다. 이 값은 서버와 푸시 서비스 간의 인증에 사용됩니다.
푸시 알림 수신 거부
사용자가 푸시 알림을 구독한 후에는 사용자가 마음을 바꿔 더 이상 푸시 알림을 받고 싶지 않은 경우에 대비하여 UI에서 구독 취소 방법을 제공해야 합니다.
unsubscribeButtonHandler()의// 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;
}
푸시 메시지를 수신하고 알림으로 표시
앞서 언급했듯이 서버에서 클라이언트로 푸시된 메시지를 수신하고 표시하려면 서비스 워커가 필요합니다. 자세한 내용은 푸시된 메시지를 알림으로 수신 및 표시를 참조하세요.
public/service-worker.js를 열고 서비스 워커의push이벤트 핸들러에 있는// TODO주석을 다음 코드로 바꿉니다.let data = event.data.json(); const image = 'logo.png'; const options = { body: data.options.body, icon: image } self.registration.showNotification( data.title, options );앱 탭으로 돌아갑니다.
알림 받기를 클릭합니다. 푸시 알림이 전송됩니다.
지원되는 다른 브라우저에서 앱 탭의 URL을 엽니다. 구독 워크플로를 진행하고 모두 알림을 클릭합니다. 각각에 동일한 푸시 알림이 수신됩니다.
다양한 방법으로 알림을 맞춤설정할 수 있습니다. 자세한 내용은 ServiceWorkerRegistration.showNotification()의 매개변수를 참고하세요.
사용자가 알림을 클릭할 때 URL 열기
실제로는 알림을 사용하여 사용자의 재참여를 유도하고 사이트를 방문하도록 유도할 수 있습니다. 이렇게 하려면 서비스 워커를 조금 더 구성해야 합니다.
서비스 워커의
notificationclick이벤트 핸들러에 있는// TODO주석을 다음 코드로 바꿉니다.event.notification.close(); event.waitUntil(self.clients.openWindow('https://web.dev'));앱 탭으로 돌아가서 다른 알림을 보낸 다음 알림을 클릭합니다. 브라우저에서 새 탭이 열리고
https://web.dev가 로드됩니다.
다음 단계
ServiceWorkerRegistration.showNotification()에서 알림을 맞춤설정할 수 있는 다양한 방법을 모두 확인하세요.- 푸시 알림의 작동 방식을 개념적으로 더 깊이 이해하려면 푸시 알림 개요를 읽어보세요.
- Codelab: 푸시 알림 서버 빌드를 확인하여 구독을 관리하고 웹 푸시 프로토콜 요청을 전송하는 서버를 빌드하는 방법을 알아보세요.
- 알림 생성기를 사용해 보고 알림을 맞춤설정할 수 있는 모든 방법을 테스트해 보세요.