Google is committed to advancing racial equity for Black communities. See how.
Эта страница была переведа с помощью Cloud Translation API.
Switch to English

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

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

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

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

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

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

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

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

// 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.setBackgroundMessageHandler` 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 , рекомендуется добавлять fcm_options.link данные уведомления ко всем сообщениям с данными. Кроме того, вы можете обрабатывать уведомления с помощью сервис-воркера.

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

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

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

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

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

messaging.onBackgroundMessage(function(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 , как правило, чтобы связать пользователя с вашим веб-приложением и привлечь внимание к нему в браузере. В редких случаях, когда вся необходимая информация может быть помещена в уведомление, вам может не понадобиться ссылка.