Чтобы отправить сообщение на несколько устройств, используйте обмен сообщениями по темам . Эта функция позволяет отправлять сообщение на несколько устройств, которые выбрали определенную тему.
В этом руководстве основное внимание уделяется отправке тематических сообщений с вашего сервера приложений с помощью Admin SDK или REST API для FCM , а также их получению и обработке в приложении Android. Мы рассмотрим обработку сообщений как для фоновых, так и для приоритетных приложений. Описаны все шаги для достижения этой цели: от настройки до проверки.
Настройте SDK
В этом разделе могут быть описаны шаги, которые вы уже выполнили, если вы настроили клиентское приложение Android для FCM или выполнили действия по отправке первого сообщения .
Прежде чем начать
Установите или обновите Android Studio до последней версии.
Убедитесь, что ваш проект соответствует этим требованиям (обратите внимание, что к некоторым продуктам могут предъявляться более строгие требования):
- Целевой уровень API 21 (Lollipop) или выше.
- Использует Android 5.0 или выше.
- Использует Jetpack (AndroidX) , что включает соответствие следующим требованиям к версии:
-
com.android.tools.build:gradle
v7.3.0 или новее -
compileSdkVersion
28 или новее
-
Настройте физическое устройство или используйте эмулятор для запуска приложения.
Обратите внимание, что для Firebase SDK, зависящих от сервисов Google Play, на устройстве или эмуляторе должны быть установлены сервисы Google Play.Войдите в Firebase, используя свою учетную запись Google.
Если у вас еще нет проекта Android и вы просто хотите опробовать продукт Firebase, вы можете загрузить один из наших примеров быстрого запуска .
Создать проект Firebase
Прежде чем вы сможете добавить Firebase в свое приложение Android, вам необходимо создать проект Firebase для подключения к вашему приложению Android. Посетите раздел «Понимание проектов Firebase», чтобы узнать больше о проектах Firebase.
Зарегистрируйте свое приложение в Firebase
Чтобы использовать Firebase в своем приложении для Android, вам необходимо зарегистрировать свое приложение в проекте Firebase. Регистрация вашего приложения часто называется «добавлением» вашего приложения в проект.
Перейдите в консоль Firebase .
В центре страницы обзора проекта щелкните значок Android (
) или «Добавить приложение» , чтобы запустить рабочий процесс установки.Введите имя пакета вашего приложения в поле имени пакета Android .
Имя пакета уникально идентифицирует ваше приложение на устройстве и в Google Play Store.
Имя пакета часто называют идентификатором приложения .
Найдите имя пакета вашего приложения в файле Gradle вашего модуля (на уровне приложения), обычно
app/build.gradle
(пример имени пакета:com.yourcompany.yourproject
).Имейте в виду, что значение имени пакета чувствительно к регистру, и его нельзя изменить для этого приложения Firebase Android после его регистрации в вашем проекте Firebase.
(Необязательно) Введите другую информацию о приложении: псевдоним приложения и сертификат подписи отладки SHA-1 .
Псевдоним приложения : внутренний удобный идентификатор, который виден только вам в консоли Firebase .
Сертификат подписи отладки SHA-1 : хэш SHA-1 требуется для Firebase Authentication (при использовании входа в Google или входа по номеру телефона ) и Firebase Dynamic Links .
Нажмите Зарегистрировать приложение .
Добавьте файл конфигурации Firebase
Загрузите и добавьте файл конфигурации Firebase Android (
) в свое приложение:google-services.json Нажмите «Загрузить google-services.json» , чтобы получить файл конфигурации Firebase Android.
Переместите файл конфигурации в корневой каталог модуля (на уровне приложения) вашего приложения.
Файл конфигурации Firebase содержит уникальные, но несекретные идентификаторы вашего проекта. Чтобы узнать больше об этом файле конфигурации, посетите раздел «Понимание проектов Firebase» .
Вы можете снова загрузить файл конфигурации Firebase в любое время.
Убедитесь, что к имени файла конфигурации не добавлены дополнительные символы, например
(2)
.
Чтобы сделать значения в вашем файле конфигурации
доступными для Firebase SDK, вам понадобится плагин Gradle сервисов Google (google-services.json google-services
).В файле Gradle корневого уровня (уровня проекта) (
<project>/build.gradle.kts
или<project>/build.gradle
) добавьте плагин служб Google в качестве зависимости:Kotlin
plugins { id("com.android.application") version "7.3.0" apply false // ... // Add the dependency for the Google services Gradle plugin id("com.google.gms.google-services") version "4.4.2" apply false }
Groovy
plugins { id 'com.android.application' version '7.3.0' apply false // ... // Add the dependency for the Google services Gradle plugin id 'com.google.gms.google-services' version '4.4.2' apply false }
В файле Gradle вашего модуля (на уровне приложения) (обычно
<project>/<app-module>/build.gradle.kts
или<project>/<app-module>/build.gradle
) добавьте плагин сервисов Google:Kotlin
plugins { id("com.android.application") // Add the Google services Gradle plugin id("com.google.gms.google-services") // ... }
Groovy
plugins { id 'com.android.application' // Add the Google services Gradle plugin id 'com.google.gms.google-services' // ... }
Добавьте Firebase SDK в свое приложение
В файле Gradle вашего модуля (на уровне приложения) (обычно
<project>/<app-module>/build.gradle.kts
или<project>/<app-module>/build.gradle
) добавьте зависимость для Firebase Cloud Messaging Библиотека Firebase Cloud Messaging для Android. Мы рекомендуем использовать Firebase Android BoM для управления версиями библиотеки.Для оптимальной работы с Firebase Cloud Messaging мы рекомендуем включить Google Analytics в вашем проекте Firebase и добавить Firebase SDK для Google Analytics в ваше приложение.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.4.0")) // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging") implementation("com.google.firebase:firebase-analytics") }
Используя Firebase Android BoM , ваше приложение всегда будет использовать совместимые версии библиотек Firebase Android.
Ищете библиотечный модуль, специфичный для Kotlin? Начиная с октября 2023 года ( Firebase BoM 32.5.0) от основного модуля библиотеки могут зависеть как разработчики Kotlin, так и Java (подробнее см. FAQ по этой инициативе ).(Альтернатива) Добавить зависимости библиотеки Firebase без использования BoM
Если вы решите не использовать Firebase BoM , вы должны указать каждую версию библиотеки Firebase в ее строке зависимости.
Обратите внимание: если вы используете в своем приложении несколько библиотек Firebase, мы настоятельно рекомендуем использовать BoM для управления версиями библиотек, что гарантирует совместимость всех версий.
dependencies { // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging:24.0.2") implementation("com.google.firebase:firebase-analytics:22.1.2") }
Синхронизируйте проект Android с файлами Gradle.
Сборки Gradle, использующие плагин Android Gradle (AGP) v4.2 или более ранней версии, должны включить поддержку Java 8. В противном случае при добавлении Firebase SDK в этих проектах Android произойдет сбой сборки.
Чтобы исправить этот сбой сборки, вы можете воспользоваться одним из двух вариантов:
- Добавьте перечисленные
compileOptions
из сообщения об ошибке в файлbuild.gradle.kts
илиbuild.gradle
уровня приложения . - Увеличьте
minSdk
для вашего проекта Android до 26 или выше.
Узнайте больше об этом сбое сборки в этом FAQ .
- Добавьте перечисленные
Подписать клиентское приложение на тему
Клиентские приложения могут подписаться на любую существующую тему или создать новую тему. Когда клиентское приложение подписывается на новое имя темы (которое еще не существует для вашего проекта Firebase), в FCM создается новая тема с этим именем, и любой клиент впоследствии может подписаться на нее.
Чтобы подписаться на тему, клиентское приложение вызывает Firebase Cloud Messaging subscribeToTopic()
с именем темы FCM . Этот метод возвращает Task
, который может использоваться прослушивателем завершения, чтобы определить, успешна ли подписка:
Kotlin+KTX
Firebase.messaging.subscribeToTopic("weather") .addOnCompleteListener { task -> var msg = "Subscribed" if (!task.isSuccessful) { msg = "Subscribe failed" } Log.d(TAG, msg) Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show() }
Java
FirebaseMessaging.getInstance().subscribeToTopic("weather") .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { String msg = "Subscribed"; if (!task.isSuccessful()) { msg = "Subscribe failed"; } Log.d(TAG, msg); Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show(); } });
Чтобы отказаться от подписки, клиентское приложение вызывает Firebase Cloud Messaging unsubscribeFromTopic()
с именем темы.
Получать и обрабатывать тематические сообщения
FCM доставляет тематические сообщения так же, как и другие последующие сообщения.
Для получения сообщений используйте сервис, расширяющий FirebaseMessagingService
. Ваша служба должна переопределять обратные вызовы onMessageReceived
и onDeletedMessages
.
Временной интервал для обработки сообщения может быть короче 20 секунд в зависимости от задержек, возникших перед вызовом onMessageReceived
, включая задержки ОС, время запуска приложения, блокировку основного потока другими операциями или предыдущие вызовы onMessageReceived
, занимающие слишком много времени. По истечении этого времени различные варианты поведения ОС, такие как завершение процесса Android или ограничения фонового выполнения Android O, могут помешать вам завершить работу.
onMessageReceived
предоставляется для большинства типов сообщений, за следующими исключениями:
Уведомительные сообщения доставляются, когда ваше приложение находится в фоновом режиме . В этом случае уведомление доставляется в системный трей устройства. При нажатии пользователем уведомления по умолчанию открывается панель запуска приложений.
Сообщения, содержащие как уведомления, так и полезные данные, при получении в фоновом режиме . В этом случае уведомление доставляется на панель задач устройства, а полезные данные доставляются в дополнительных целях вашего действия средства запуска.
В итоге:
Состояние приложения | Уведомление | Данные | Оба |
---|---|---|---|
передний план | onMessageReceived | onMessageReceived | onMessageReceived |
Фон | Системный лоток | onMessageReceived | Уведомление: системный трей Данные: в доп. намерении. |
Редактировать манифест приложения
Чтобы использовать FirebaseMessagingService
, вам необходимо добавить в манифест приложения следующее:
<service android:name=".java.MyFirebaseMessagingService" android:exported="false"> <intent-filter> <action android:name="com.google.firebase.MESSAGING_EVENT" /> </intent-filter> </service>
Также рекомендуется установить значения по умолчанию, чтобы настроить внешний вид уведомлений. Вы можете указать собственный значок по умолчанию и собственный цвет по умолчанию, которые будут применяться всякий раз, когда эквивалентные значения не установлены в полезных данных уведомления.
Добавьте эти строки в тег application
, чтобы установить собственный значок по умолчанию и собственный цвет:
<!-- Set custom default icon. This is used when no icon is set for incoming notification messages. See README(https://goo.gl/l4GJaQ) for more. --> <meta-data android:name="com.google.firebase.messaging.default_notification_icon" android:resource="@drawable/ic_stat_ic_notification" /> <!-- Set color used with incoming notification messages. This is used when no color is set for the incoming notification message. See README(https://goo.gl/6BKBk7) for more. --> <meta-data android:name="com.google.firebase.messaging.default_notification_color" android:resource="@color/colorAccent" />
Android отображает пользовательский значок по умолчанию для
- Все уведомления, отправленные от композитора уведомлений .
- Любое уведомление, в котором явно не установлен значок в полезных данных уведомления.
Android использует собственный цвет по умолчанию для
- Все уведомления, отправленные от композитора уведомлений .
- Любое сообщение уведомления, в котором явно не задан цвет в полезных данных уведомления.
Если никакой пользовательский значок по умолчанию не установлен и значок не установлен в полезных данных уведомления, Android отображает значок приложения, отображаемый белым цветом.
Переопределить onMessageReceived
Переопределив метод FirebaseMessagingService.onMessageReceived
, вы можете выполнять действия на основе полученного объекта RemoteMessage и получать данные сообщения:
Kotlin+KTX
override fun onMessageReceived(remoteMessage: RemoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: ${remoteMessage.from}") // Check if message contains a data payload. if (remoteMessage.data.isNotEmpty()) { Log.d(TAG, "Message data payload: ${remoteMessage.data}") // Check if data needs to be processed by long running job if (needsToBeScheduled()) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob() } else { // Handle message within 10 seconds handleNow() } } // Check if message contains a notification payload. remoteMessage.notification?.let { Log.d(TAG, "Message Notification Body: ${it.body}") } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Java
@Override public void onMessageReceived(RemoteMessage remoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: " + remoteMessage.getFrom()); // Check if message contains a data payload. if (remoteMessage.getData().size() > 0) { Log.d(TAG, "Message data payload: " + remoteMessage.getData()); if (/* Check if data needs to be processed by long running job */ true) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob(); } else { // Handle message within 10 seconds handleNow(); } } // Check if message contains a notification payload. if (remoteMessage.getNotification() != null) { Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody()); } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Переопределить onDeletedMessages
В некоторых ситуациях FCM может не доставить сообщение. Это происходит, если на момент подключения вашего приложения на определенном устройстве находится слишком много сообщений (>100) или если устройство не подключалось к FCM более одного месяца. В этих случаях вы можете получить обратный вызов FirebaseMessagingService.onDeletedMessages()
Когда экземпляр приложения получает этот обратный вызов, он должен выполнить полную синхронизацию с вашим сервером приложений. Если вы не отправляли сообщение в приложение на этом устройстве в течение последних 4 недель, FCM не будет вызывать onDeletedMessages()
.Обработка сообщений уведомлений в фоновом приложении
Когда ваше приложение работает в фоновом режиме, Android направляет уведомления на панель задач. При нажатии пользователем уведомления по умолчанию открывается панель запуска приложений.
Сюда входят сообщения, содержащие как уведомления, так и полезные данные (а также все сообщения, отправленные из консоли уведомлений). В этих случаях уведомление доставляется на панель задач устройства, а полезные данные доставляются в дополнительных целях вашего действия средства запуска.
Для получения более подробной информации о доставке сообщений в ваше приложение см. панель отчетов FCM , которая записывает количество сообщений, отправленных и открытых на устройствах Apple и Android, а также данные о «показах» (уведомлениях, которые видят пользователи) для приложений Android.
Создание запросов на отправку
После того как вы создали тему, подписав на нее экземпляры клиентского приложения на стороне клиента или через серверный API , вы можете отправлять сообщения в тему. Если вы впервые создаете запросы на отправку для FCM , ознакомьтесь с руководством по вашей серверной среде и FCM для получения важной вводной информации и информации о настройке.
В логике отправки на серверной стороне укажите желаемое имя темы, как показано:
Node.js
// The topic name can be optionally prefixed with "/topics/".
const topic = 'highScores';
const message = {
data: {
score: '850',
time: '2:45'
},
topic: topic
};
// Send a message to devices subscribed to the provided topic.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Ява
// The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";
// See documentation on defining a message payload.
Message message = Message.builder()
.putData("score", "850")
.putData("time", "2:45")
.setTopic(topic)
.build();
// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Питон
# The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'
# See documentation on defining a message payload.
message = messaging.Message(
data={
'score': '850',
'time': '2:45',
},
topic=topic,
)
# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Идти
// The topic name can be optionally prefixed with "/topics/".
topic := "highScores"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Topic: topic,
}
// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
С#
// The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";
// See documentation on defining a message payload.
var message = new Message()
{
Data = new Dictionary<string, string>()
{
{ "score", "850" },
{ "time", "2:45" },
},
Topic = topic,
};
// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
ОТДЫХ
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"topic" : "foo-bar",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message"
}
}
}
команда cURL:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message": {
"topic" : "foo-bar",
"notification": {
"body": "This is a Firebase Cloud Messaging Topic Message!",
"title": "FCM Message"
}
}
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Чтобы отправить сообщение по нескольким темам, укажите условие , которое представляет собой логическое выражение, определяющее целевые темы. Например, следующее условие отправит сообщения на устройства, подписанные на TopicA
и TopicB
или TopicC
:
"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"
FCM сначала оценивает все условия в скобках, а затем оценивает выражение слева направо. В приведенном выше выражении пользователь, подписанный на какую-либо отдельную тему, не получает сообщение. Аналогично, пользователь, не подписанный на TopicA
, не получит сообщение. Эти комбинации получают его:
-
TopicA
иTopicB
-
TopicA
иTopicC
В условное выражение можно включить до пяти тем.
Чтобы отправить условие:
Node.js
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
const condition = '\'stock-GOOG\' in topics || \'industry-tech\' in topics';
// See documentation on defining a message payload.
const message = {
notification: {
title: '$FooCorp up 1.43% on the day',
body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
},
condition: condition
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Ява
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
Message message = Message.builder()
.setNotification(Notification.builder()
.setTitle("$GOOG up 1.43% on the day")
.setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
.build())
.setCondition(condition)
.build();
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Питон
# Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"
# See documentation on defining a message payload.
message = messaging.Message(
notification=messaging.Notification(
title='$GOOG up 1.43% on the day',
body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
),
condition=condition,
)
# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Идти
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Condition: condition,
}
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
С#
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
var message = new Message()
{
Notification = new Notification()
{
Title = "$GOOG up 1.43% on the day",
Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
},
Condition = condition,
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
ОТДЫХ
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"condition": "'dogs' in topics || 'cats' in topics",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message",
}
}
}
команда cURL:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"notification": {
"title": "FCM Message",
"body": "This is a Firebase Cloud Messaging Topic Message!",
},
"condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Следующие шаги
- Вы можете использовать свой сервер для подписки экземпляров клиентских приложений на темы и выполнения других задач управления. См. Управление подписками на темы на сервере .
Чтобы отправить сообщение на несколько устройств, используйте обмен сообщениями по темам . Эта функция позволяет отправлять сообщение на несколько устройств, которые выбрали определенную тему.
В этом руководстве основное внимание уделяется отправке тематических сообщений с вашего сервера приложений с помощью Admin SDK или REST API для FCM , а также их получению и обработке в приложении Android. Мы рассмотрим обработку сообщений как для фоновых, так и для приоритетных приложений. Описаны все шаги для достижения этой цели: от настройки до проверки.
Настройте SDK
В этом разделе могут быть описаны шаги, которые вы уже выполнили, если вы настроили клиентское приложение Android для FCM или выполнили действия по отправке первого сообщения .
Прежде чем начать
Установите или обновите Android Studio до последней версии.
Убедитесь, что ваш проект соответствует этим требованиям (обратите внимание, что к некоторым продуктам могут предъявляться более строгие требования):
- Целевой уровень API 21 (Lollipop) или выше.
- Использует Android 5.0 или выше.
- Использует Jetpack (AndroidX) , что включает соответствие следующим требованиям к версии:
-
com.android.tools.build:gradle
v7.3.0 или новее -
compileSdkVersion
28 или новее
-
Настройте физическое устройство или используйте эмулятор для запуска приложения.
Обратите внимание, что SDK Firebase с зависимостью от сервисов Google Play требуют, чтобы на устройстве или эмуляторе были установлены сервисы Google Play.Войдите в Firebase, используя свою учетную запись Google.
Если у вас еще нет проекта Android и вы просто хотите опробовать продукт Firebase, вы можете загрузить один из наших примеров быстрого запуска .
Создать проект Firebase
Прежде чем вы сможете добавить Firebase в свое приложение Android, вам необходимо создать проект Firebase для подключения к вашему приложению Android. Посетите раздел «Понимание проектов Firebase», чтобы узнать больше о проектах Firebase.
Зарегистрируйте свое приложение в Firebase
Чтобы использовать Firebase в своем приложении для Android, вам необходимо зарегистрировать свое приложение в проекте Firebase. Регистрация вашего приложения часто называется «добавлением» вашего приложения в проект.
Перейдите в консоль Firebase .
В центре страницы обзора проекта щелкните значок Android (
) или «Добавить приложение» , чтобы запустить рабочий процесс установки.Введите имя пакета вашего приложения в поле имени пакета Android .
Имя пакета уникально идентифицирует ваше приложение на устройстве и в Google Play Store.
Имя пакета часто называют идентификатором приложения .
Найдите имя пакета вашего приложения в файле Gradle вашего модуля (на уровне приложения), обычно
app/build.gradle
(пример имени пакета:com.yourcompany.yourproject
).Имейте в виду, что значение имени пакета чувствительно к регистру, и его нельзя изменить для этого приложения Firebase Android после его регистрации в вашем проекте Firebase.
(Необязательно) Введите другую информацию о приложении: псевдоним приложения и сертификат подписи отладки SHA-1 .
Псевдоним приложения : внутренний удобный идентификатор, который виден только вам в консоли Firebase .
Сертификат подписи отладки SHA-1 : хэш SHA-1 требуется для Firebase Authentication (при использовании входа в Google или входа по номеру телефона ) и Firebase Dynamic Links .
Нажмите Зарегистрировать приложение .
Добавьте файл конфигурации Firebase
Загрузите и добавьте файл конфигурации Firebase Android (
) в свое приложение:google-services.json Нажмите «Загрузить google-services.json» , чтобы получить файл конфигурации Firebase Android.
Переместите файл конфигурации в корневой каталог модуля (на уровне приложения) вашего приложения.
Файл конфигурации Firebase содержит уникальные, но несекретные идентификаторы вашего проекта. Чтобы узнать больше об этом файле конфигурации, посетите раздел «Понимание проектов Firebase» .
Вы можете снова загрузить файл конфигурации Firebase в любое время.
Убедитесь, что к имени файла конфигурации не добавлены дополнительные символы, например
(2)
.
Чтобы сделать значения в вашем файле конфигурации
доступными для Firebase SDK, вам понадобится плагин Gradle сервисов Google (google-services.json google-services
).В файле Gradle корневого уровня (уровня проекта) (
<project>/build.gradle.kts
или<project>/build.gradle
) добавьте плагин служб Google в качестве зависимости:Kotlin
plugins { id("com.android.application") version "7.3.0" apply false // ... // Add the dependency for the Google services Gradle plugin id("com.google.gms.google-services") version "4.4.2" apply false }
Groovy
plugins { id 'com.android.application' version '7.3.0' apply false // ... // Add the dependency for the Google services Gradle plugin id 'com.google.gms.google-services' version '4.4.2' apply false }
В файле Gradle вашего модуля (на уровне приложения) (обычно
<project>/<app-module>/build.gradle.kts
или<project>/<app-module>/build.gradle
) добавьте плагин сервисов Google:Kotlin
plugins { id("com.android.application") // Add the Google services Gradle plugin id("com.google.gms.google-services") // ... }
Groovy
plugins { id 'com.android.application' // Add the Google services Gradle plugin id 'com.google.gms.google-services' // ... }
Добавьте Firebase SDK в свое приложение
В файле Gradle вашего модуля (на уровне приложения) (обычно
<project>/<app-module>/build.gradle.kts
или<project>/<app-module>/build.gradle
) добавьте зависимость для Firebase Cloud Messaging Библиотека Firebase Cloud Messaging для Android. Мы рекомендуем использовать Firebase Android BoM для управления версиями библиотеки.Для оптимальной работы с Firebase Cloud Messaging мы рекомендуем включить Google Analytics в вашем проекте Firebase и добавить Firebase SDK для Google Analytics в ваше приложение.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.4.0")) // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging") implementation("com.google.firebase:firebase-analytics") }
Используя Firebase Android BoM , ваше приложение всегда будет использовать совместимые версии библиотек Firebase Android.
Ищете библиотечный модуль, специфичный для Kotlin? Начиная с октября 2023 года ( Firebase BoM 32.5.0) от основного модуля библиотеки могут зависеть как разработчики Kotlin, так и Java (подробнее см. FAQ по этой инициативе ).(Альтернатива) Добавить зависимости библиотеки Firebase без использования BoM
Если вы решите не использовать Firebase BoM , вы должны указать каждую версию библиотеки Firebase в ее строке зависимости.
Обратите внимание: если вы используете в своем приложении несколько библиотек Firebase, мы настоятельно рекомендуем использовать BoM для управления версиями библиотек, что гарантирует совместимость всех версий.
dependencies { // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging:24.0.2") implementation("com.google.firebase:firebase-analytics:22.1.2") }
Синхронизируйте проект Android с файлами Gradle.
Сборки Gradle, использующие плагин Android Gradle (AGP) v4.2 или более ранней версии, должны включить поддержку Java 8. В противном случае при добавлении Firebase SDK в этих проектах Android произойдет сбой сборки.
Чтобы исправить этот сбой сборки, вы можете воспользоваться одним из двух вариантов:
- Добавьте перечисленные
compileOptions
из сообщения об ошибке в файлbuild.gradle.kts
илиbuild.gradle
уровня приложения . - Увеличьте
minSdk
для вашего проекта Android до 26 или выше.
Узнайте больше об этом сбое сборки в этом FAQ .
- Добавьте перечисленные
Подписать клиентское приложение на тему
Клиентские приложения могут подписаться на любую существующую тему или создать новую тему. Когда клиентское приложение подписывается на новое имя темы (которое еще не существует для вашего проекта Firebase), в FCM создается новая тема с этим именем, и любой клиент впоследствии может подписаться на нее.
Чтобы подписаться на тему, клиентское приложение вызывает Firebase Cloud Messaging subscribeToTopic()
с именем темы FCM . Этот метод возвращает Task
, который может использоваться прослушивателем завершения, чтобы определить, успешна ли подписка:
Kotlin+KTX
Firebase.messaging.subscribeToTopic("weather") .addOnCompleteListener { task -> var msg = "Subscribed" if (!task.isSuccessful) { msg = "Subscribe failed" } Log.d(TAG, msg) Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show() }
Java
FirebaseMessaging.getInstance().subscribeToTopic("weather") .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { String msg = "Subscribed"; if (!task.isSuccessful()) { msg = "Subscribe failed"; } Log.d(TAG, msg); Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show(); } });
Чтобы отказаться от подписки, клиентское приложение вызывает Firebase Cloud Messaging unsubscribeFromTopic()
с именем темы.
Получать и обрабатывать тематические сообщения
FCM доставляет тематические сообщения так же, как и другие последующие сообщения.
Для получения сообщений используйте сервис, расширяющий FirebaseMessagingService
. Ваша служба должна переопределять обратные вызовы onMessageReceived
и onDeletedMessages
.
Временной интервал для обработки сообщения может быть короче 20 секунд в зависимости от задержек, возникших перед вызовом onMessageReceived
, включая задержки ОС, время запуска приложения, блокировку основного потока другими операциями или предыдущие вызовы onMessageReceived
, занимающие слишком много времени. По истечении этого времени различные варианты поведения ОС, такие как завершение процесса Android или ограничения фонового выполнения Android O, могут помешать вам завершить работу.
onMessageReceived
предоставляется для большинства типов сообщений, за следующими исключениями:
Уведомления доставляются, когда ваше приложение находится в фоновом режиме . В этом случае уведомление доставляется в системный трей устройства. При нажатии пользователем уведомления по умолчанию открывается панель запуска приложений.
Сообщения, содержащие как уведомления, так и полезные данные, при получении в фоновом режиме . В этом случае уведомление доставляется на панель задач устройства, а полезные данные доставляются в дополнительных целях вашего действия средства запуска.
В итоге:
Состояние приложения | Уведомление | Данные | Оба |
---|---|---|---|
передний план | onMessageReceived | onMessageReceived | onMessageReceived |
Фон | Системный лоток | onMessageReceived | Уведомление: системный трей Данные: в доп. намерении. |
Редактировать манифест приложения
Чтобы использовать FirebaseMessagingService
, вам необходимо добавить в манифест приложения следующее:
<service android:name=".java.MyFirebaseMessagingService" android:exported="false"> <intent-filter> <action android:name="com.google.firebase.MESSAGING_EVENT" /> </intent-filter> </service>
Также рекомендуется установить значения по умолчанию, чтобы настроить внешний вид уведомлений. Вы можете указать собственный значок по умолчанию и собственный цвет по умолчанию, которые будут применяться всякий раз, когда эквивалентные значения не установлены в полезных данных уведомления.
Добавьте эти строки в тег application
, чтобы установить собственный значок по умолчанию и собственный цвет:
<!-- Set custom default icon. This is used when no icon is set for incoming notification messages. See README(https://goo.gl/l4GJaQ) for more. --> <meta-data android:name="com.google.firebase.messaging.default_notification_icon" android:resource="@drawable/ic_stat_ic_notification" /> <!-- Set color used with incoming notification messages. This is used when no color is set for the incoming notification message. See README(https://goo.gl/6BKBk7) for more. --> <meta-data android:name="com.google.firebase.messaging.default_notification_color" android:resource="@color/colorAccent" />
Android отображает пользовательский значок по умолчанию для
- Все уведомления, отправленные от композитора уведомлений .
- Любое уведомление, в котором явно не установлен значок в полезных данных уведомления.
Android использует собственный цвет по умолчанию для
- Все уведомления, отправленные от композитора уведомлений .
- Любое сообщение уведомления, в котором явно не задан цвет в полезных данных уведомления.
Если никакой пользовательский значок по умолчанию не установлен и значок не установлен в полезных данных уведомления, Android отображает значок приложения, отображаемый белым цветом.
Переопределить onMessageReceived
Переопределив метод FirebaseMessagingService.onMessageReceived
, вы можете выполнять действия на основе полученного объекта RemoteMessage и получать данные сообщения:
Kotlin+KTX
override fun onMessageReceived(remoteMessage: RemoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: ${remoteMessage.from}") // Check if message contains a data payload. if (remoteMessage.data.isNotEmpty()) { Log.d(TAG, "Message data payload: ${remoteMessage.data}") // Check if data needs to be processed by long running job if (needsToBeScheduled()) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob() } else { // Handle message within 10 seconds handleNow() } } // Check if message contains a notification payload. remoteMessage.notification?.let { Log.d(TAG, "Message Notification Body: ${it.body}") } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Java
@Override public void onMessageReceived(RemoteMessage remoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: " + remoteMessage.getFrom()); // Check if message contains a data payload. if (remoteMessage.getData().size() > 0) { Log.d(TAG, "Message data payload: " + remoteMessage.getData()); if (/* Check if data needs to be processed by long running job */ true) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob(); } else { // Handle message within 10 seconds handleNow(); } } // Check if message contains a notification payload. if (remoteMessage.getNotification() != null) { Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody()); } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Переопределить onDeletedMessages
В некоторых ситуациях FCM может не доставить сообщение. Это происходит, если на момент подключения вашего приложения на определенном устройстве находится слишком много сообщений (>100) или если устройство не подключалось к FCM более одного месяца. В этих случаях вы можете получить обратный вызов FirebaseMessagingService.onDeletedMessages()
Когда экземпляр приложения получает этот обратный вызов, он должен выполнить полную синхронизацию с вашим сервером приложений. Если вы не отправляли сообщение в приложение на этом устройстве в течение последних 4 недель, FCM не будет вызывать onDeletedMessages()
.Обработка сообщений уведомлений в фоновом приложении
Когда ваше приложение работает в фоновом режиме, Android направляет уведомления на панель задач. При нажатии пользователем уведомления по умолчанию открывается панель запуска приложений.
Сюда входят сообщения, содержащие как уведомления, так и полезные данные (а также все сообщения, отправленные из консоли уведомлений). В этих случаях уведомление доставляется на панель задач устройства, а полезные данные доставляются в дополнительных целях вашего действия средства запуска.
Для получения более подробной информации о доставке сообщений в ваше приложение см. панель отчетов FCM , которая записывает количество сообщений, отправленных и открытых на устройствах Apple и Android, а также данные о «показах» (уведомлениях, которые видят пользователи) для приложений Android.
Создание запросов на отправку
После того как вы создали тему, подписав на нее экземпляры клиентского приложения на стороне клиента или через серверный API , вы можете отправлять сообщения в тему. Если вы впервые создаете запросы на отправку для FCM , ознакомьтесь с руководством по вашей серверной среде и FCM для получения важной вводной информации и информации о настройке.
В логике отправки на серверной стороне укажите желаемое имя темы, как показано:
Node.js
// The topic name can be optionally prefixed with "/topics/".
const topic = 'highScores';
const message = {
data: {
score: '850',
time: '2:45'
},
topic: topic
};
// Send a message to devices subscribed to the provided topic.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Ява
// The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";
// See documentation on defining a message payload.
Message message = Message.builder()
.putData("score", "850")
.putData("time", "2:45")
.setTopic(topic)
.build();
// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Питон
# The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'
# See documentation on defining a message payload.
message = messaging.Message(
data={
'score': '850',
'time': '2:45',
},
topic=topic,
)
# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Идти
// The topic name can be optionally prefixed with "/topics/".
topic := "highScores"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Topic: topic,
}
// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
С#
// The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";
// See documentation on defining a message payload.
var message = new Message()
{
Data = new Dictionary<string, string>()
{
{ "score", "850" },
{ "time", "2:45" },
},
Topic = topic,
};
// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
ОТДЫХ
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"topic" : "foo-bar",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message"
}
}
}
команда cURL:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message": {
"topic" : "foo-bar",
"notification": {
"body": "This is a Firebase Cloud Messaging Topic Message!",
"title": "FCM Message"
}
}
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Чтобы отправить сообщение по нескольким темам, укажите условие , которое представляет собой логическое выражение, определяющее целевые темы. Например, следующее условие отправит сообщения на устройства, подписанные на TopicA
и TopicB
или TopicC
:
"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"
FCM сначала оценивает все условия в скобках, а затем оценивает выражение слева направо. В приведенном выше выражении пользователь, подписанный на какую-либо отдельную тему, не получает сообщение. Аналогично, пользователь, не подписанный на TopicA
, не получит сообщение. Эти комбинации получают его:
-
TopicA
иTopicB
-
TopicA
иTopicC
В условное выражение можно включить до пяти тем.
Чтобы отправить условие:
Node.js
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
const condition = '\'stock-GOOG\' in topics || \'industry-tech\' in topics';
// See documentation on defining a message payload.
const message = {
notification: {
title: '$FooCorp up 1.43% on the day',
body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
},
condition: condition
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Ява
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
Message message = Message.builder()
.setNotification(Notification.builder()
.setTitle("$GOOG up 1.43% on the day")
.setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
.build())
.setCondition(condition)
.build();
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Питон
# Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"
# See documentation on defining a message payload.
message = messaging.Message(
notification=messaging.Notification(
title='$GOOG up 1.43% on the day',
body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
),
condition=condition,
)
# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Идти
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Condition: condition,
}
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
С#
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
var message = new Message()
{
Notification = new Notification()
{
Title = "$GOOG up 1.43% on the day",
Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
},
Condition = condition,
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
ОТДЫХ
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"condition": "'dogs' in topics || 'cats' in topics",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message",
}
}
}
команда cURL:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"notification": {
"title": "FCM Message",
"body": "This is a Firebase Cloud Messaging Topic Message!",
},
"condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Следующие шаги
- Вы можете использовать свой сервер для подписки экземпляров клиентских приложений на темы и выполнения других задач управления. См. Управление подписками на темы на сервере .
Чтобы отправить сообщение на несколько устройств, используйте обмен сообщениями по темам . Эта функция позволяет отправлять сообщение на несколько устройств, которые выбрали определенную тему.
В этом руководстве основное внимание уделяется отправке тематических сообщений с вашего сервера приложений с помощью Admin SDK или REST API для FCM , а также их получению и обработке в приложении Android. Мы рассмотрим обработку сообщений как для фоновых, так и для приоритетных приложений. Описаны все шаги для достижения этой цели: от настройки до проверки.
Настройте SDK
В этом разделе могут быть описаны шаги, которые вы уже выполнили, если вы настроили клиентское приложение Android для FCM или выполнили действия по отправке первого сообщения .
Прежде чем начать
Установите или обновите Android Studio до последней версии.
Убедитесь, что ваш проект соответствует этим требованиям (обратите внимание, что к некоторым продуктам могут предъявляться более строгие требования):
- Целевой уровень API 21 (Lollipop) или выше.
- Использует Android 5.0 или выше.
- Использует Jetpack (AndroidX) , что включает соответствие следующим требованиям к версии:
-
com.android.tools.build:gradle
v7.3.0 или новее -
compileSdkVersion
28 или новее
-
Настройте физическое устройство или используйте эмулятор для запуска приложения.
Обратите внимание, что SDK Firebase с зависимостью от сервисов Google Play требуют, чтобы на устройстве или эмуляторе были установлены сервисы Google Play.Войдите в Firebase, используя свою учетную запись Google.
Если у вас еще нет проекта Android и вы просто хотите опробовать продукт Firebase, вы можете загрузить один из наших примеров быстрого запуска .
Создать проект Firebase
Прежде чем вы сможете добавить Firebase в свое приложение Android, вам необходимо создать проект Firebase для подключения к вашему приложению Android. Посетите раздел «Понимание проектов Firebase», чтобы узнать больше о проектах Firebase.
Зарегистрируйте свое приложение в Firebase
Чтобы использовать Firebase в своем приложении для Android, вам необходимо зарегистрировать свое приложение в проекте Firebase. Регистрация вашего приложения часто называется «добавлением» вашего приложения в проект.
Перейдите в консоль Firebase .
В центре страницы обзора проекта щелкните значок Android (
) или «Добавить приложение» , чтобы запустить рабочий процесс установки.Введите имя пакета вашего приложения в поле имени пакета Android .
Имя пакета уникально идентифицирует ваше приложение на устройстве и в Google Play Store.
Имя пакета часто называют идентификатором приложения .
Найдите имя пакета вашего приложения в файле Gradle вашего модуля (на уровне приложения), обычно
app/build.gradle
(пример имени пакета:com.yourcompany.yourproject
).Имейте в виду, что значение имени пакета чувствительно к регистру, и его нельзя изменить для этого приложения Firebase Android после его регистрации в вашем проекте Firebase.
(Необязательно) Введите другую информацию о приложении: псевдоним приложения и сертификат подписи отладки SHA-1 .
Псевдоним приложения : внутренний удобный идентификатор, который виден только вам в консоли Firebase .
Сертификат подписи отладки SHA-1 : хэш SHA-1 требуется для Firebase Authentication (при использовании входа в Google или входа по номеру телефона ) и Firebase Dynamic Links .
Нажмите Зарегистрировать приложение .
Добавьте файл конфигурации Firebase
Загрузите и добавьте файл конфигурации Firebase Android (
) в свое приложение:google-services.json Нажмите «Загрузить google-services.json» , чтобы получить файл конфигурации Firebase Android.
Переместите файл конфигурации в корневой каталог модуля (на уровне приложения) вашего приложения.
Файл конфигурации Firebase содержит уникальные, но несекретные идентификаторы вашего проекта. Чтобы узнать больше об этом файле конфигурации, посетите раздел «Понимание проектов Firebase» .
Вы можете снова загрузить файл конфигурации Firebase в любое время.
Убедитесь, что к имени файла конфигурации не добавлены дополнительные символы, например
(2)
.
Чтобы сделать значения в вашем файле конфигурации
доступными для Firebase SDK, вам понадобится плагин Gradle сервисов Google (google-services.json google-services
).В файле Gradle корневого уровня (уровня проекта) (
<project>/build.gradle.kts
или<project>/build.gradle
) добавьте плагин служб Google в качестве зависимости:Kotlin
plugins { id("com.android.application") version "7.3.0" apply false // ... // Add the dependency for the Google services Gradle plugin id("com.google.gms.google-services") version "4.4.2" apply false }
Groovy
plugins { id 'com.android.application' version '7.3.0' apply false // ... // Add the dependency for the Google services Gradle plugin id 'com.google.gms.google-services' version '4.4.2' apply false }
В файле Gradle вашего модуля (на уровне приложения) (обычно
<project>/<app-module>/build.gradle.kts
или<project>/<app-module>/build.gradle
) добавьте плагин сервисов Google:Kotlin
plugins { id("com.android.application") // Add the Google services Gradle plugin id("com.google.gms.google-services") // ... }
Groovy
plugins { id 'com.android.application' // Add the Google services Gradle plugin id 'com.google.gms.google-services' // ... }
Добавьте Firebase SDK в свое приложение
В файле Gradle вашего модуля (на уровне приложения) (обычно
<project>/<app-module>/build.gradle.kts
или<project>/<app-module>/build.gradle
) добавьте зависимость для Firebase Cloud Messaging Библиотека Firebase Cloud Messaging для Android. Мы рекомендуем использовать Firebase Android BoM для управления версиями библиотеки.Для оптимальной работы с Firebase Cloud Messaging мы рекомендуем включить Google Analytics в вашем проекте Firebase и добавить Firebase SDK для Google Analytics в ваше приложение.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.4.0")) // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging") implementation("com.google.firebase:firebase-analytics") }
Используя Firebase Android BoM , ваше приложение всегда будет использовать совместимые версии библиотек Firebase Android.
Ищете библиотечный модуль, специфичный для Kotlin? Начиная с октября 2023 года ( Firebase BoM 32.5.0) от основного модуля библиотеки могут зависеть как разработчики Kotlin, так и Java (подробнее см. FAQ по этой инициативе ).(Альтернатива) Добавить зависимости библиотеки Firebase без использования BoM
Если вы решите не использовать Firebase BoM , вы должны указать каждую версию библиотеки Firebase в ее строке зависимости.
Обратите внимание: если вы используете в своем приложении несколько библиотек Firebase, мы настоятельно рекомендуем использовать BoM для управления версиями библиотек, что гарантирует совместимость всех версий.
dependencies { // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging:24.0.2") implementation("com.google.firebase:firebase-analytics:22.1.2") }
Синхронизируйте проект Android с файлами Gradle.
Сборки Gradle, использующие плагин Android Gradle (AGP) v4.2 или более ранней версии, должны включить поддержку Java 8. В противном случае при добавлении Firebase SDK в этих проектах Android произойдет сбой сборки.
Чтобы исправить этот сбой сборки, вы можете воспользоваться одним из двух вариантов:
- Добавьте перечисленные
compileOptions
из сообщения об ошибке в файлbuild.gradle.kts
илиbuild.gradle
уровня приложения . - Увеличьте
minSdk
для вашего проекта Android до 26 или выше.
Узнайте больше об этом сбое сборки в этом FAQ .
- Добавьте перечисленные
Подписать клиентское приложение на тему
Клиентские приложения могут подписаться на любую существующую тему или создать новую тему. Когда клиентское приложение подписывается на новое имя темы (которое еще не существует для вашего проекта Firebase), в FCM создается новая тема с этим именем, и любой клиент впоследствии может подписаться на нее.
Чтобы подписаться на тему, клиентское приложение вызывает Firebase Cloud Messaging subscribeToTopic()
с именем темы FCM . Этот метод возвращает Task
, который может использоваться прослушивателем завершения, чтобы определить, успешна ли подписка:
Kotlin+KTX
Firebase.messaging.subscribeToTopic("weather") .addOnCompleteListener { task -> var msg = "Subscribed" if (!task.isSuccessful) { msg = "Subscribe failed" } Log.d(TAG, msg) Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show() }
Java
FirebaseMessaging.getInstance().subscribeToTopic("weather") .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { String msg = "Subscribed"; if (!task.isSuccessful()) { msg = "Subscribe failed"; } Log.d(TAG, msg); Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show(); } });
Чтобы отказаться от подписки, клиентское приложение вызывает Firebase Cloud Messaging unsubscribeFromTopic()
с именем темы.
Получать и обрабатывать тематические сообщения
FCM доставляет тематические сообщения так же, как и другие последующие сообщения.
Для получения сообщений используйте сервис, расширяющий FirebaseMessagingService
. Ваша служба должна переопределять обратные вызовы onMessageReceived
и onDeletedMessages
.
Временной интервал для обработки сообщения может быть короче 20 секунд в зависимости от задержек, возникших перед вызовом onMessageReceived
, включая задержки ОС, время запуска приложения, блокировку основного потока другими операциями или предыдущие вызовы onMessageReceived
, занимающие слишком много времени. По истечении этого времени различные варианты поведения ОС, такие как завершение процесса Android или ограничения фонового выполнения Android O, могут помешать вам завершить работу.
onMessageReceived
предоставляется для большинства типов сообщений, за следующими исключениями:
Сообщения уведомления, доставленные, когда ваше приложение находится в фоновом режиме . В этом случае уведомление доставляется в системный лоток устройства. Пользователь нажимает на уведомление по умолчанию открывает запуск приложения по умолчанию.
Сообщения с уведомлением и полезной нагрузкой данных при получении в фоновом режиме . В этом случае уведомление доставляется в системный лоток устройства, а полезная нагрузка данных доставляется в дополнениях к намерению вашей деятельности запуска.
В итоге:
Состояние приложения | Уведомление | Данные | Оба |
---|---|---|---|
передний план | onMessageReceived | onMessageReceived | onMessageReceived |
Фон | Системный лоток | onMessageReceived | Уведомление: системный трей Данные: в доп. намерении. |
Измените манифест приложения
Чтобы использовать FirebaseMessagingService
, вам нужно добавить следующее в манифесте вашего приложения:
<service android:name=".java.MyFirebaseMessagingService" android:exported="false"> <intent-filter> <action android:name="com.google.firebase.MESSAGING_EVENT" /> </intent-filter> </service>
Кроме того, вам рекомендуется установить значения по умолчанию для настройки появления уведомлений. Вы можете указать пользовательский значок по умолчанию и пользовательский цвет по умолчанию, который применяется всякий раз, когда эквивалентные значения не устанавливаются в полезной нагрузке уведомления.
Добавьте эти строки внутри тега application
, чтобы установить пользовательский значок по умолчанию и пользовательский цвет:
<!-- Set custom default icon. This is used when no icon is set for incoming notification messages. See README(https://goo.gl/l4GJaQ) for more. --> <meta-data android:name="com.google.firebase.messaging.default_notification_icon" android:resource="@drawable/ic_stat_ic_notification" /> <!-- Set color used with incoming notification messages. This is used when no color is set for the incoming notification message. See README(https://goo.gl/6BKBk7) for more. --> <meta-data android:name="com.google.firebase.messaging.default_notification_color" android:resource="@color/colorAccent" />
Android отображает пользовательский значок по умолчанию для
- Все сообщения уведомлений, отправленные из композитора уведомлений .
- Любое сообщение уведомления, которое явно не устанавливает значок в полезной нагрузке уведомления.
Android использует пользовательский цвет по умолчанию для
- Все сообщения уведомлений, отправленные из композитора уведомлений .
- Любое сообщение уведомления, которое явно не устанавливает цвет в полезной нагрузке уведомления.
Если не установлен пользовательский значок по умолчанию, и в полевой нагрузке уведомления не установлен значок, Android отображает значок приложения, отображаемый в белом.
Переопределить onMessageReceived
Переоценив метод FirebaseMessagingService.onMessageReceived
, вы можете выполнять действия на основе полученного объекта RemoteMessage и получить данные сообщения:
Kotlin+KTX
override fun onMessageReceived(remoteMessage: RemoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: ${remoteMessage.from}") // Check if message contains a data payload. if (remoteMessage.data.isNotEmpty()) { Log.d(TAG, "Message data payload: ${remoteMessage.data}") // Check if data needs to be processed by long running job if (needsToBeScheduled()) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob() } else { // Handle message within 10 seconds handleNow() } } // Check if message contains a notification payload. remoteMessage.notification?.let { Log.d(TAG, "Message Notification Body: ${it.body}") } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Java
@Override public void onMessageReceived(RemoteMessage remoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: " + remoteMessage.getFrom()); // Check if message contains a data payload. if (remoteMessage.getData().size() > 0) { Log.d(TAG, "Message data payload: " + remoteMessage.getData()); if (/* Check if data needs to be processed by long running job */ true) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob(); } else { // Handle message within 10 seconds handleNow(); } } // Check if message contains a notification payload. if (remoteMessage.getNotification() != null) { Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody()); } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Переопределить onDeletedMessages
В некоторых ситуациях FCM может не доставить сообщение. Это происходит, когда в то время, когда оно подключается слишком много сообщений (> 100) для вашего приложения, или если устройство не подключено к FCM более одного месяца. В этих случаях вы можете получить обратный вызов FirebaseMessagingService.onDeletedMessages()
Когда экземпляр приложения получает этот обратный вызов, он должен выполнить полную синхронизацию с вашим сервером приложений. Если вы не отправили сообщение в приложение на этом устройстве в течение последних 4 недель, FCM не вызовет onDeletedMessages()
.Обработка сообщений уведомлений в фоновом приложении
Когда ваше приложение находится в фоновом режиме, Android направляет сообщения уведомлений в системный лоток. Пользователь нажимает на уведомление по умолчанию открывает запуск приложения.
Это включает сообщения, которые содержат как уведомление, так и полезную нагрузку данных (и все сообщения, отправленные из консоли уведомлений). В этих случаях уведомление доставляется в системный лоток устройства, а полезная нагрузка данных доставляется в дополнениях к намерению вашей деятельности запуска.
Для понимания доставки сообщений в ваше приложение см. Панель панели отчетов FCM , которая записывает количество отправленных и открытых сообщений на устройствах Apple и Android, а также данные для «впечатлений» (уведомления, которые можно увидеть пользователями) для приложений Android.
Построить запросы отправить
После того, как вы создали тему, либо подписав экземпляры клиентских приложений на тему на стороне клиента, либо через API сервера , вы можете отправлять сообщения на тему. Если это ваше первое время, когда вы отправляете запросы на FCM , см. Руководство по среде вашего сервера и FCM для важной информации и информации о настройке.
В вашей логике отправки на бэкэнд укажите желаемое имя темы, как показано:
Node.js
// The topic name can be optionally prefixed with "/topics/".
const topic = 'highScores';
const message = {
data: {
score: '850',
time: '2:45'
},
topic: topic
};
// Send a message to devices subscribed to the provided topic.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Ява
// The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";
// See documentation on defining a message payload.
Message message = Message.builder()
.putData("score", "850")
.putData("time", "2:45")
.setTopic(topic)
.build();
// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Питон
# The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'
# See documentation on defining a message payload.
message = messaging.Message(
data={
'score': '850',
'time': '2:45',
},
topic=topic,
)
# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Идти
// The topic name can be optionally prefixed with "/topics/".
topic := "highScores"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Topic: topic,
}
// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
C#
// The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";
// See documentation on defining a message payload.
var message = new Message()
{
Data = new Dictionary<string, string>()
{
{ "score", "850" },
{ "time", "2:45" },
},
Topic = topic,
};
// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
ОТДЫХ
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"topic" : "foo-bar",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message"
}
}
}
Команда Curl:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message": {
"topic" : "foo-bar",
"notification": {
"body": "This is a Firebase Cloud Messaging Topic Message!",
"title": "FCM Message"
}
}
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Чтобы отправить сообщение в комбинацию тем, укажите условие , которое является логическим выражением, которое указывает целевые темы. Например, следующее условие будет отправлять сообщения на устройства, которые подписаны на TopicA
, а также TopicB
или TopicC
:
"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"
FCM сначала оценивает любые условия в скобках, а затем оценивает выражение слева направо. В приведенном выше выражении пользователь, подписанный на какую -либо отдельную тему, не получает сообщение. Аналогично, пользователь, который не подписывается на TopicA
не получает сообщение. Эти комбинации получают это:
-
TopicA
иTopicB
-
TopicA
иTopicC
Вы можете включить до пяти тем в свое условное выражение.
Отправить в условие:
Node.js
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
const condition = '\'stock-GOOG\' in topics || \'industry-tech\' in topics';
// See documentation on defining a message payload.
const message = {
notification: {
title: '$FooCorp up 1.43% on the day',
body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
},
condition: condition
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Ява
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
Message message = Message.builder()
.setNotification(Notification.builder()
.setTitle("$GOOG up 1.43% on the day")
.setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
.build())
.setCondition(condition)
.build();
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Питон
# Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"
# See documentation on defining a message payload.
message = messaging.Message(
notification=messaging.Notification(
title='$GOOG up 1.43% on the day',
body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
),
condition=condition,
)
# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Идти
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Condition: condition,
}
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
C#
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
var message = new Message()
{
Notification = new Notification()
{
Title = "$GOOG up 1.43% on the day",
Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
},
Condition = condition,
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
ОТДЫХ
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"condition": "'dogs' in topics || 'cats' in topics",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message",
}
}
}
Команда Curl:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"notification": {
"title": "FCM Message",
"body": "This is a Firebase Cloud Messaging Topic Message!",
},
"condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Следующие шаги
- Вы можете использовать свой сервер для подписки на экземпляры клиентских приложений на темы и выполнять другие задачи управления. См. Управление подпискими на темы на сервере .
Чтобы нацелиться на сообщение на несколько устройств, используйте обмен темами . Эта функция позволяет отправлять сообщение на несколько устройств, которые выбрали определенную тему.
Этот урок фокусируется на отправке тематических сообщений с сервера приложений с использованием ADK Admin SDK или REST для FCM , а также получения и обработки их в приложении Android. Мы рассмотрим обработку сообщений как для фоновых, так и передовых приложений. Все шаги для достижения этого покрыты, от установки до проверки.
Установите SDK
Этот раздел может охватывать шаги, которые вы уже выполнили, если вы настроили приложение Android Client для FCM или проработали шаги по отправке первого сообщения .
Прежде чем начать
Установите или обновите Android Studio в последнюю версию.
Убедитесь, что ваш проект соответствует этим требованиям (обратите внимание, что некоторые продукты могут иметь более строгие требования):
- Целевые API уровня 21 (Lollipop) или выше
- Использует Android 5.0 или выше
- Использует JetPack (Androidx) , который включает в себя удовлетворение требований к этим версии:
-
com.android.tools.build:gradle
v7.3.0 или позже -
compileSdkVersion
28 или позже
-
Установите физическое устройство или используйте эмулятор для запуска вашего приложения.
Обратите внимание, что SDK Firebase SDK с зависимостью от Google Play Services требует, чтобы устройство или эмулятор были установлены службы Google Play.Войдите в Firebase, используя свою учетную запись Google.
Если у вас еще нет проекта Android и просто вы хотите попробовать продукт Firebase, вы можете скачать один из наших образцов QuickStart .
Создать проект Firebase
Прежде чем вы сможете добавить Firebase в приложение Android, вам необходимо создать проект Firebase для подключения к вашему приложению Android. Посетите раздел «Понимание проектов Firebase», чтобы узнать больше о проектах Firebase.
Зарегистрируйте свое приложение с помощью Firebase
Чтобы использовать Firebase в вашем приложении Android, вам необходимо зарегистрировать ваше приложение в своем проекте Firebase. Регистрацию вашего приложения часто называют «добавлением» вашего приложения в ваш проект.
Перейдите в консоль Firebase .
В центре страницы обзора проекта нажмите на значок Android (
) или добавьте приложение , чтобы запустить рабочий процесс настройки.Введите имя пакета вашего приложения в поле «Имя пакета Android» .
Имя пакета однозначно идентифицирует ваше приложение на устройстве и в магазине Google Play.
Имя пакета часто называют идентификатором приложения .
Найдите имя пакета вашего приложения в вашем файле Gradle Module (Level), обычно
app/build.gradle
(Пример имени пакета:com.yourcompany.yourproject
).Имейте в виду, что значение имени пакета чувствительно к случаям, и его нельзя изменить для этого приложения Android Firebase после того, как оно зарегистрировано в вашем проекте Firebase.
(Необязательно) Введите другую информацию о приложении: прозвище приложения и сертификат подписания отладки SHA-1 .
Прозвище приложения : внутренний, удобный идентификатор, который виден только вам в консоли Firebase
Сертификат подписания отладки SHA-1 : Хэш SHA-1 требуется для Firebase Authentication (при использовании входа в Google или номера телефона ) и Firebase Dynamic Links .
Нажмите Зарегистрировать приложение .
Добавить файл конфигурации Firebase
Загрузите, а затем добавьте файл конфигурации Android Firebase (
) в ваше приложение:google-services.json Нажмите Скачать Google-services.json , чтобы получить свой файл конфигурации Android Firebase.
Переместите файл конфигурации в корневой каталог модуля (на уровне приложения) вашего приложения.
Файл конфигурации Firebase содержит уникальные, но несекретные идентификаторы вашего проекта. Чтобы узнать больше об этом файле конфигурации, посетите раздел «Понимание проектов Firebase» .
Вы можете снова загрузить файл конфигурации Firebase в любое время.
Убедитесь, что к имени файла конфигурации не добавлены дополнительные символы, например
(2)
.
Чтобы сделать значения в вашем файле конфигурации
, доступных для Firebase SDK, вам нужен плагин Google Services Gradle (google-services.json google-services
).В вашем файле Gradle на уровне корневого уровня (
<project>/build.gradle.kts
или<project>/build.gradle
) добавьте плагин Google Services в качестве зависимости:Kotlin
plugins { id("com.android.application") version "7.3.0" apply false // ... // Add the dependency for the Google services Gradle plugin id("com.google.gms.google-services") version "4.4.2" apply false }
Groovy
plugins { id 'com.android.application' version '7.3.0' apply false // ... // Add the dependency for the Google services Gradle plugin id 'com.google.gms.google-services' version '4.4.2' apply false }
В вашем модуле (на уровне приложения) Gradle File (обычно
<project>/<app-module>/build.gradle.kts
или<project>/<app-module>/build.gradle
) добавьте плагин служб Google:Kotlin
plugins { id("com.android.application") // Add the Google services Gradle plugin id("com.google.gms.google-services") // ... }
Groovy
plugins { id 'com.android.application' // Add the Google services Gradle plugin id 'com.google.gms.google-services' // ... }
Добавьте Firebase SDK в ваше приложение
В вашем модуле (App-Level) File (обычно
<project>/<app-module>/build.gradle.kts
или<project>/<app-module>/build.gradle
) добавьте зависимость для Firebase Cloud Messaging Библиотека Firebase Cloud Messaging для Android. Мы рекомендуем использовать Firebase Android BoM для управления версией библиотеки.Для оптимального опыта работы с Firebase Cloud Messaging мы рекомендуем включить Google Analytics в вашем проекте Firebase и добавление SDK Firebase SDK для Google Analytics в ваше приложение.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.4.0")) // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging") implementation("com.google.firebase:firebase-analytics") }
Используя Firebase Android BoM , ваше приложение всегда будет использовать совместимые версии библиотек Android Firebase.
Ищете модуль библиотеки, специфичный для котлина? Начиная с октября 2023 года ( Firebase BoM 32.5.0) , разработчики Kotlin и Java могут зависеть от основного библиотечного модуля (подробности см. FAQ об этой инициативе ).(Альтернатива) Добавить зависимости библиотеки Firebase без использования BoM
Если вы решите не использовать Firebase BoM , вы должны указать каждую версию библиотеки Firebase в его строке зависимости.
Обратите внимание, что если вы используете несколько библиотек Firebase в вашем приложении, мы настоятельно рекомендуем использовать BoM для управления библиотечными версиями, что гарантирует, что все версии совместимы.
dependencies { // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging:24.0.2") implementation("com.google.firebase:firebase-analytics:22.1.2") }
Синхронизируйте ваш проект Android с Gradle Files.
Gradle сборка, которые используют Android Gradle Plugin (AGP) v4.2 или ранее, необходимо включить поддержку Java 8. В противном случае, эти проекты Android получают неудачу в сборке при добавлении SDK Firebase.
Чтобы исправить этот сбой сборки, вы можете следовать одним из двух вариантов:
- Добавьте перечисленные
compileOptions
из сообщенияbuild.gradle
ошибке в вашbuild.gradle.kts
на уровне приложения . - Увеличьте
minSdk
для вашего проекта Android до 26 или выше.
Узнайте больше об этом сбое сборки в этом FAQ .
- Добавьте перечисленные
Подпишитесь на клиентское приложение на тему
Клиентские приложения могут подписаться на любую существующую тему, или они могут создать новую тему. Когда клиентское приложение подписывается на новое имя темы (одно, которое еще не существует для вашего проекта Firebase), в FCM создается новая тема этого имени, и любой клиент может впоследствии подписаться на него.
Чтобы подписаться на тему, клиентское приложение называет Firebase Cloud Messaging subscribeToTopic()
с именем темы FCM . Этот метод возвращает Task
, которая может использоваться прослушивателем завершения, чтобы определить, удастся ли подписка:
Kotlin+KTX
Firebase.messaging.subscribeToTopic("weather") .addOnCompleteListener { task -> var msg = "Subscribed" if (!task.isSuccessful) { msg = "Subscribe failed" } Log.d(TAG, msg) Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show() }
Java
FirebaseMessaging.getInstance().subscribeToTopic("weather") .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { String msg = "Subscribed"; if (!task.isSuccessful()) { msg = "Subscribe failed"; } Log.d(TAG, msg); Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show(); } });
Чтобы отказаться от подписки, клиентское приложение называет обмену Firebase Cloud Messaging unsubscribeFromTopic()
с именем темы.
Получать и обрабатывать тематические сообщения
FCM предоставляет тематические сообщения так же, как и другие нижестоящие сообщения.
Для получения сообщений используйте услугу, которая расширяет FirebaseMessagingService
. Ваш сервис должен переопределить обратные вызовы onMessageReceived
и onDeletedMessages
.
Временное окно для обработки сообщения может быть короче, чем 20 секунд в зависимости от задержек, возникающих в преддверии вызова onMessageReceived
, включая задержки ОС, время запуска приложения, основной поток, заблокированный другими операциями, или предыдущие onMessageReceived
, предпринимаемые слишком долго. После этого время различные поведения ОС, такие как убийство процесса Android или пределы выполнения Android O, могут мешать вашей способности завершить вашу работу.
onMessageReceived
представлен для большинства типов сообщений, за следующими исключениями:
Сообщения уведомления, доставленные, когда ваше приложение находится в фоновом режиме . В этом случае уведомление доставляется в системный лоток устройства. Пользователь нажимает на уведомление по умолчанию открывает запуск приложения по умолчанию.
Сообщения с уведомлением и полезной нагрузкой данных при получении в фоновом режиме . В этом случае уведомление доставляется в системный лоток устройства, а полезная нагрузка данных доставляется в дополнениях к намерению вашей деятельности запуска.
В итоге:
Состояние приложения | Уведомление | Данные | Оба |
---|---|---|---|
передний план | onMessageReceived | onMessageReceived | onMessageReceived |
Фон | Системный лоток | onMessageReceived | Уведомление: системный трей Данные: в доп. намерении. |
Измените манифест приложения
Чтобы использовать FirebaseMessagingService
, вам нужно добавить следующее в манифесте вашего приложения:
<service android:name=".java.MyFirebaseMessagingService" android:exported="false"> <intent-filter> <action android:name="com.google.firebase.MESSAGING_EVENT" /> </intent-filter> </service>
Кроме того, вам рекомендуется установить значения по умолчанию для настройки появления уведомлений. Вы можете указать пользовательский значок по умолчанию и пользовательский цвет по умолчанию, который применяется всякий раз, когда эквивалентные значения не устанавливаются в полезной нагрузке уведомления.
Добавьте эти строки внутри тега application
, чтобы установить пользовательский значок по умолчанию и пользовательский цвет:
<!-- Set custom default icon. This is used when no icon is set for incoming notification messages. See README(https://goo.gl/l4GJaQ) for more. --> <meta-data android:name="com.google.firebase.messaging.default_notification_icon" android:resource="@drawable/ic_stat_ic_notification" /> <!-- Set color used with incoming notification messages. This is used when no color is set for the incoming notification message. See README(https://goo.gl/6BKBk7) for more. --> <meta-data android:name="com.google.firebase.messaging.default_notification_color" android:resource="@color/colorAccent" />
Android отображает пользовательский значок по умолчанию для
- Все сообщения уведомлений, отправленные из композитора уведомлений .
- Любое сообщение уведомления, которое явно не устанавливает значок в полезной нагрузке уведомления.
Android использует пользовательский цвет по умолчанию для
- Все сообщения уведомлений, отправленные из композитора уведомлений .
- Любое сообщение уведомления, которое явно не устанавливает цвет в полезной нагрузке уведомления.
Если не установлен пользовательский значок по умолчанию, и в полевой нагрузке уведомления не установлен значок, Android отображает значок приложения, отображаемый в белом.
Переопределить onMessageReceived
Переоценив метод FirebaseMessagingService.onMessageReceived
, вы можете выполнять действия на основе полученного объекта RemoteMessage и получить данные сообщения:
Kotlin+KTX
override fun onMessageReceived(remoteMessage: RemoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: ${remoteMessage.from}") // Check if message contains a data payload. if (remoteMessage.data.isNotEmpty()) { Log.d(TAG, "Message data payload: ${remoteMessage.data}") // Check if data needs to be processed by long running job if (needsToBeScheduled()) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob() } else { // Handle message within 10 seconds handleNow() } } // Check if message contains a notification payload. remoteMessage.notification?.let { Log.d(TAG, "Message Notification Body: ${it.body}") } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Java
@Override public void onMessageReceived(RemoteMessage remoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: " + remoteMessage.getFrom()); // Check if message contains a data payload. if (remoteMessage.getData().size() > 0) { Log.d(TAG, "Message data payload: " + remoteMessage.getData()); if (/* Check if data needs to be processed by long running job */ true) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob(); } else { // Handle message within 10 seconds handleNow(); } } // Check if message contains a notification payload. if (remoteMessage.getNotification() != null) { Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody()); } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Переопределить onDeletedMessages
В некоторых ситуациях FCM может не доставить сообщение. Это происходит, когда в то время, когда оно подключается слишком много сообщений (> 100) для вашего приложения, или если устройство не подключено к FCM более одного месяца. В этих случаях вы можете получить обратный вызов FirebaseMessagingService.onDeletedMessages()
Когда экземпляр приложения получает этот обратный вызов, он должен выполнить полную синхронизацию с вашим сервером приложений. Если вы не отправили сообщение в приложение на этом устройстве в течение последних 4 недель, FCM не вызовет onDeletedMessages()
.Обработка сообщений уведомлений в фоновом приложении
Когда ваше приложение находится в фоновом режиме, Android направляет сообщения уведомлений в системный лоток. Пользователь нажимает на уведомление по умолчанию открывает запуск приложения.
Это включает сообщения, которые содержат как уведомление, так и полезную нагрузку данных (и все сообщения, отправленные из консоли уведомлений). В этих случаях уведомление доставляется в системный лоток устройства, а полезная нагрузка данных доставляется в дополнениях к намерению вашей деятельности запуска.
Для понимания доставки сообщений в ваше приложение см. Панель панели отчетов FCM , которая записывает количество отправленных и открытых сообщений на устройствах Apple и Android, а также данные для «впечатлений» (уведомления, которые можно увидеть пользователями) для приложений Android.
Построить запросы отправить
После того, как вы создали тему, либо подписав экземпляры клиентских приложений на тему на стороне клиента, либо через API сервера , вы можете отправлять сообщения на тему. Если это ваше первое время, когда вы отправляете запросы на FCM , см. Руководство по среде вашего сервера и FCM для важной информации и информации о настройке.
В вашей логике отправки на бэкэнд укажите желаемое имя темы, как показано:
Node.js
// The topic name can be optionally prefixed with "/topics/".
const topic = 'highScores';
const message = {
data: {
score: '850',
time: '2:45'
},
topic: topic
};
// Send a message to devices subscribed to the provided topic.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Ява
// The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";
// See documentation on defining a message payload.
Message message = Message.builder()
.putData("score", "850")
.putData("time", "2:45")
.setTopic(topic)
.build();
// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Питон
# The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'
# See documentation on defining a message payload.
message = messaging.Message(
data={
'score': '850',
'time': '2:45',
},
topic=topic,
)
# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Идти
// The topic name can be optionally prefixed with "/topics/".
topic := "highScores"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Topic: topic,
}
// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
C#
// The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";
// See documentation on defining a message payload.
var message = new Message()
{
Data = new Dictionary<string, string>()
{
{ "score", "850" },
{ "time", "2:45" },
},
Topic = topic,
};
// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
ОТДЫХ
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"topic" : "foo-bar",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message"
}
}
}
Команда Curl:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message": {
"topic" : "foo-bar",
"notification": {
"body": "This is a Firebase Cloud Messaging Topic Message!",
"title": "FCM Message"
}
}
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Чтобы отправить сообщение в комбинацию тем, укажите условие , которое является логическим выражением, которое указывает целевые темы. Например, следующее условие будет отправлять сообщения на устройства, которые подписаны на TopicA
, а также TopicB
или TopicC
:
"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"
FCM сначала оценивает любые условия в скобках, а затем оценивает выражение слева направо. В приведенном выше выражении пользователь, подписанный на какую -либо отдельную тему, не получает сообщение. Аналогично, пользователь, который не подписывается на TopicA
не получает сообщение. Эти комбинации получают это:
-
TopicA
иTopicB
-
TopicA
иTopicC
Вы можете включить до пяти тем в свое условное выражение.
Отправить в условие:
Node.js
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
const condition = '\'stock-GOOG\' in topics || \'industry-tech\' in topics';
// See documentation on defining a message payload.
const message = {
notification: {
title: '$FooCorp up 1.43% on the day',
body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
},
condition: condition
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Ява
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
Message message = Message.builder()
.setNotification(Notification.builder()
.setTitle("$GOOG up 1.43% on the day")
.setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
.build())
.setCondition(condition)
.build();
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Питон
# Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"
# See documentation on defining a message payload.
message = messaging.Message(
notification=messaging.Notification(
title='$GOOG up 1.43% on the day',
body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
),
condition=condition,
)
# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Идти
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Condition: condition,
}
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
C#
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
var message = new Message()
{
Notification = new Notification()
{
Title = "$GOOG up 1.43% on the day",
Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
},
Condition = condition,
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
ОТДЫХ
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"condition": "'dogs' in topics || 'cats' in topics",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message",
}
}
}
Команда Curl:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"notification": {
"title": "FCM Message",
"body": "This is a Firebase Cloud Messaging Topic Message!",
},
"condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Следующие шаги
- Вы можете использовать свой сервер для подписки на экземпляры клиентских приложений на темы и выполнять другие задачи управления. См. Управление подпискими на темы на сервере .