Получение сообщений в клиенте JavaScript

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

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

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

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

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

Web version 9

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

Web version 8

// 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.
importScripts('https://www.gstatic.com/firebasejs/8.10.0/firebase-app.js');
importScripts('https://www.gstatic.com/firebasejs/8.10.0/firebase-messaging.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();

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

Web version 9

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

Web version 8

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

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

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

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

Для уведомлений, отправляемых с сервера приложений, FCM JavaScript API поддерживает ключ 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 , рекомендуется добавлять полезную нагрузку уведомления ко всем сообщениям с данными. Кроме того, вы можете обрабатывать уведомления с помощью сервисного работника.

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

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

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

Web version 9

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

Web version 8

// 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.
importScripts('https://www.gstatic.com/firebasejs/8.10.0/firebase-app.js');
importScripts('https://www.gstatic.com/firebasejs/8.10.0/firebase-messaging.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();

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

Web version 9

import { getMessaging } from "firebase/messaging";
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);
});

Web version 8

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

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

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

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