Получать сообщения в клиенте JavaScript

Поведение сообщений различается в зависимости от того, находится ли страница на переднем плане (имеет фокус) или на заднем плане, скрыта за другими вкладками или полностью закрыта. Во всех случаях страница должна обрабатывать обратный вызов onMessage , но в фоновых случаях вам может также потребоваться обрабатывать onBackgroundMessage или настраивать уведомление на дисплее, чтобы позволить пользователю вывести ваше веб-приложение на передний план.

Состояние приложения Уведомление Данные Оба
Передний план onMessage onMessage onMessage
Фон (работник сферы услуг) onBackgroundMessage (автоматически отображается уведомление) onBackgroundMessage onBackgroundMessage (автоматически отображается уведомление)

Пример быстрого старта JavaScript демонстрирует весь код, необходимый для получения сообщений.

Обрабатывайте сообщения, когда ваше веб-приложение находится на переднем плане

Чтобы получить событие onMessage , ваше приложение должно определить Firebase messaging service worker в firebase-messaging-sw.js . В качестве альтернативы вы можете предоставить существующий service worker в SDK через getToken(): Promise<string> .

Web 

import { initializeApp } from "firebase/app";
import { getMessaging } from "firebase/messaging/sw";

// Initialize the Firebase app in the service worker by passing in
// your app's Firebase config object.
// https://firebase.google.com/docs/web/setup#config-object
const firebaseApp = initializeApp({
  apiKey: 'api-key',
  authDomain: 'project-id.firebaseapp.com',
  databaseURL: 'https://project-id.firebaseio.com',
  projectId: 'project-id',
  storageBucket: 'project-id.appspot.com',
  messagingSenderId: 'sender-id',
  appId: 'app-id',
  measurementId: 'G-measurement-id',
});

// Retrieve an instance of Firebase Messaging so that it can handle background
// messages.
const messaging = getMessaging(firebaseApp);
messaging_init_in_sw.js

Web 

// Give the service worker access to Firebase Messaging.
// Note that you can only use Firebase Messaging here. Other Firebase libraries
// are not available in the service worker.
// Replace 10.13.2 with latest version of the Firebase JS SDK.
importScripts('https://www.gstatic.com/firebasejs/10.13.2/firebase-app-compat.js');
importScripts('https://www.gstatic.com/firebasejs/10.13.2/firebase-messaging-compat.js');

// Initialize the Firebase app in the service worker by passing in
// your app's Firebase config object.
// https://firebase.google.com/docs/web/setup#config-object
firebase.initializeApp({
  apiKey: 'api-key',
  authDomain: 'project-id.firebaseapp.com',
  databaseURL: 'https://project-id.firebaseio.com',
  projectId: 'project-id',
  storageBucket: 'project-id.appspot.com',
  messagingSenderId: 'sender-id',
  appId: 'app-id',
  measurementId: 'G-measurement-id',
});

// Retrieve an instance of Firebase Messaging so that it can handle background
// messages.
const messaging = firebase.messaging();
service-worker.js

Когда ваше приложение находится на переднем плане (пользователь в данный момент просматривает вашу веб-страницу), вы можете получать данные и уведомления непосредственно на странице.

Web 

// Handle incoming messages. Called when:
// - a message is received while the app has focus
// - the user clicks on an app notification created by a service worker
//   `messaging.onBackgroundMessage` handler.
import { getMessaging, onMessage } from "firebase/messaging";

const messaging = getMessaging();
onMessage(messaging, (payload) => {
  console.log('Message received. ', payload);
  // ...
});
messaging_receive_message.js

Web 

// Handle incoming messages. Called when:
// - a message is received while the app has focus
// - the user clicks on an app notification created by a service worker
//   `messaging.onBackgroundMessage` handler.
messaging.onMessage((payload) => {
  console.log('Message received. ', payload);
  // ...
});
index.js

Обрабатывайте сообщения, когда ваше веб-приложение работает в фоновом режиме

Все сообщения, полученные во время работы приложения в фоновом режиме, вызывают отображение уведомления в браузере. Вы можете указать параметры для этого уведомления, такие как заголовок или действие щелчка, либо в запросе отправки с вашего сервера приложений, либо с помощью логики service worker на клиенте.

Настройка параметров уведомлений в запросе на отправку

Для уведомлений, отправляемых с сервера приложений, API JavaScript FCM поддерживает ключ fcm_options.link . Обычно он устанавливается на страницу в вашем веб-приложении:

https://fcm.googleapis.com//v1/projects/<YOUR-PROJECT-ID>/messages:send
Content-Type: application/json
Authorization: bearer <YOUR-ACCESS-TOKEN>

{
  "message": {
    "token": "eEz-Q2sG8nQ:APA91bHJQRT0JJ...",
    "notification": {
      "title": "Background Message Title",
      "body": "Background message body"
    },
    "webpush": {
      "fcm_options": {
        "link": "https://dummypage.com"
      }
    }
  }
}

Если значение ссылки указывает на страницу, которая уже открыта во вкладке браузера, щелчок по уведомлению выводит эту вкладку на передний план. Если страница еще не открыта, щелчок по уведомлению открывает страницу в новой вкладке.

Поскольку сообщения данных не поддерживают fcm_options.link , рекомендуется добавлять полезную нагрузку уведомления ко всем сообщениям данных. В качестве альтернативы вы можете обрабатывать уведомления с помощью service worker.

Объяснение разницы между уведомлениями и сообщениями с данными см. в разделе Типы сообщений .

Настройка параметров уведомлений в сервис-воркере

Для сообщений с данными вы можете установить параметры уведомлений в service worker. Сначала инициализируйте свое приложение в service worker:

Web 

import { initializeApp } from "firebase/app";
import { getMessaging } from "firebase/messaging/sw";

// Initialize the Firebase app in the service worker by passing in
// your app's Firebase config object.
// https://firebase.google.com/docs/web/setup#config-object
const firebaseApp = initializeApp({
  apiKey: 'api-key',
  authDomain: 'project-id.firebaseapp.com',
  databaseURL: 'https://project-id.firebaseio.com',
  projectId: 'project-id',
  storageBucket: 'project-id.appspot.com',
  messagingSenderId: 'sender-id',
  appId: 'app-id',
  measurementId: 'G-measurement-id',
});

// Retrieve an instance of Firebase Messaging so that it can handle background
// messages.
const messaging = getMessaging(firebaseApp);
messaging_init_in_sw.js

Web 

// Give the service worker access to Firebase Messaging.
// Note that you can only use Firebase Messaging here. Other Firebase libraries
// are not available in the service worker.
// Replace 10.13.2 with latest version of the Firebase JS SDK.
importScripts('https://www.gstatic.com/firebasejs/10.13.2/firebase-app-compat.js');
importScripts('https://www.gstatic.com/firebasejs/10.13.2/firebase-messaging-compat.js');

// Initialize the Firebase app in the service worker by passing in
// your app's Firebase config object.
// https://firebase.google.com/docs/web/setup#config-object
firebase.initializeApp({
  apiKey: 'api-key',
  authDomain: 'project-id.firebaseapp.com',
  databaseURL: 'https://project-id.firebaseio.com',
  projectId: 'project-id',
  storageBucket: 'project-id.appspot.com',
  messagingSenderId: 'sender-id',
  appId: 'app-id',
  measurementId: 'G-measurement-id',
});

// Retrieve an instance of Firebase Messaging so that it can handle background
// messages.
const messaging = firebase.messaging();
service-worker.js

Чтобы задать параметры, вызовите onBackgroundMessage в firebase-messaging-sw.js . В этом примере мы создаем уведомление с полями заголовка, текста и значка.

Web 

import { getMessaging } from "firebase/messaging/sw";
import { onBackgroundMessage } from "firebase/messaging/sw";

const messaging = getMessaging();
onBackgroundMessage(messaging, (payload) => {
  console.log('[firebase-messaging-sw.js] Received background message ', payload);
  // Customize notification here
  const notificationTitle = 'Background Message Title';
  const notificationOptions = {
    body: 'Background Message body.',
    icon: '/firebase-logo.png'
  };

  self.registration.showNotification(notificationTitle,
    notificationOptions);
});
messaging_on_background_message.js

Web 

messaging.onBackgroundMessage((payload) => {
  console.log(
    '[firebase-messaging-sw.js] Received background message ',
    payload
  );
  // Customize notification here
  const notificationTitle = 'Background Message Title';
  const notificationOptions = {
    body: 'Background Message body.',
    icon: '/firebase-logo.png'
  };

  self.registration.showNotification(notificationTitle, notificationOptions);
});
service-worker.js

Лучшие практики для уведомлений

Если вы знакомы с push-сообщениями для веба, вы, возможно, уже прочитали общие рекомендации о том, что делает уведомление хорошим . Для разработчиков, отправляющих уведомления через FCM для веба, наиболее важными соображениями являются точность и релевантность. Вот несколько конкретных рекомендаций по поддержанию точности и релевантности ваших уведомлений:

  • Используйте поле значка, чтобы отправить осмысленное изображение. Во многих случаях это должен быть логотип компании или приложения, который ваши пользователи сразу узнают. Или, для приложения чата, это может быть изображение профиля отправляющего пользователя.
  • Используйте поле заголовка, чтобы выразить точную суть сообщения. Например, «Джимми ответил» передает более точную информацию, чем «Новое сообщение». Не используйте это ценное пространство для названия вашей компании или приложения — используйте для этой цели значок.
  • Не используйте заголовок или текст уведомления для отображения имени вашего веб-сайта или домена; уведомления уже содержат ваше доменное имя.
  • Добавьте fcm_options.link , обычно для того, чтобы связать пользователя с вашим веб-приложением и сделать его фокусом в браузере. В редких случаях, когда вся информация, которую вам нужно передать, может быть помещена в уведомление, вам может не понадобиться ссылка.