Aby kierować wiadomość na wiele urządzeń, użyj wiadomości na temat. Ta funkcja umożliwia wysyłanie wiadomości na wiele urządzeń, które zostały dodane do konkretnego tematu.
W tym samouczku omówimy wysyłanie wiadomości na tematy z serwera aplikacji za pomocą interfejsu Admin SDK lub REST API (FCM) oraz ich odbieranie i obsługę w aplikacji na Androida. Omówimy obsługę wiadomości zarówno w przypadku aplikacji działających w tle, jak i na pierwszym planie. Wszystkie kroki prowadzące do tego celu są uwzględnione, od konfiguracji po weryfikację.
Konfigurowanie pakietu SDK
Ten rozdział może zawierać czynności, które zostały już przez Ciebie wykonane, jeśli skonfigurujesz aplikację kliencką na Androida dla FCM lub wykonasz czynności opisane w sekcji Wysyłanie pierwszej wiadomości.
Zanim zaczniesz
Zainstaluj lub zaktualizuj Android Studio do najnowszej wersji.
Upewnij się, że Twój projekt spełnia te wymagania (zauważ, że niektóre produkty mogą mieć bardziej rygorystyczne wymagania):
- jest kierowana na poziom API 21 (Lollipop) lub wyższy;
- Urządzenie z Androidem w wersji 5.0 lub nowszej,
- Korzysta z Jetpack (AndroidX), który obejmuje te wymagania wersji:
com.android.tools.build:gradle
w wersji 7.3.0 lub nowszejcompileSdkVersion
28 lub nowsza
Skonfiguruj urządzenie fizyczne lub użyj emulatora, aby uruchomić aplikację.
Pamiętaj, że pakiety SDK Firebase zależne od usług Google Play wymagają zainstalowania usług Google Play na urządzeniu lub w emulatorze.Zaloguj się w Firebase, używając konta Google.
Jeśli nie masz jeszcze projektu na Androida i chcesz wypróbować usługę Firebase, możesz pobrać jeden z naszych sampli szybkiego startu.
Tworzenie projektu Firebase
Zanim dodasz Firebase do aplikacji na Androida, musisz utworzyć projekt Firebase, aby połączyć go z tą aplikacją. Więcej informacji o projektach Firebase znajdziesz w artykule Informacje o projektach Firebase.
Rejestrowanie aplikacji w Firebase
Aby używać Firebase w swojej aplikacji na Androida, musisz ją zarejestrować w projekcie Firebase. Rejestracja aplikacji często nazywa się „dodaniem” jej do projektu.
Otwórz konsolę Firebase.
W centrum strony „Opis” projektu kliknij ikonę Androida (
) lub Dodaj aplikację, aby uruchomić proces konfiguracji.W polu Nazwa pakietu na Androida wpisz nazwę pakietu aplikacji.
(Opcjonalnie) Wpisz inne informacje o aplikacji: pseudonim aplikacji i certyfikat podpisywania debugowania SHA-1.
Kliknij Zarejestruj aplikację.
Dodawanie pliku konfiguracji Firebase
Pobierz plik konfiguracji Firebase na Androida (
) i dodaj go do aplikacji:google-services.json Kliknij Pobierz google-services.json, aby uzyskać plik konfiguracyjny Firebase na Androida.
Przenieś plik konfiguracyjny do katalogu głównego module (poziom aplikacji) aplikacji.
Aby udostępnić wartości z pliku konfiguracyjnego
pakietom SDK Firebase, potrzebujesz wtyczki usług Google do Gradle (google-services.json google-services
).W pliku Gradle na poziomie głównym (poziomie projektu) (
<project>/build.gradle.kts
lub<project>/build.gradle
) dodaj wtyczkę usług Google jako zależność: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 }
W pliku Gradle modułu (na poziomie aplikacji) (zwykle
<project>/<app-module>/build.gradle.kts
lub<project>/<app-module>/build.gradle
) dodaj wtyczkę usług 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' // ... }
Dodawanie pakietów SDK Firebase do aplikacji
W pliku Gradle (na poziomie modułu) modułu (na poziomie aplikacji) (zwykle
<project>/<app-module>/build.gradle.kts
lub<project>/<app-module>/build.gradle
) dodaj zależność z biblioteką Firebase Cloud Messaging na Androida. Do kontrolowania obsługi wersji biblioteki zalecamy używanie Firebase Android BoM.Aby uzyskać optymalne wyniki w przypadku Firebase Cloud Messaging, zalecamy włączenie Google Analytics w projekcie Firebase i dodanie do aplikacji pakietu SDK Firebase dla Google Analytics.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.6.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") }
Dzięki użyciu Firebase Android BoMaplikacja zawsze będzie używać zgodnych wersji bibliotek Firebase na Androida.
(Alternatywnie) Dodaj zależności bibliotek Firebase bez korzystania z BoM
Jeśli zdecydujesz się nie używać Firebase BoM, musisz określić każdą wersję biblioteki Firebase w jej wierszu zależności.
Jeśli w aplikacji używasz kilku bibliotek Firebase, zdecydowanie zalecamy korzystanie z BoM do zarządzania wersjami bibliotek. Dzięki temu wszystkie wersje będą ze sobą zgodne.
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.1.0") implementation("com.google.firebase:firebase-analytics:22.1.2") }
Synchronizuj projekt Androida z plikami Gradle.
Subskrybowanie tematu przez aplikację kliencką
Aplikacje klienckie mogą subskrybować dowolny istniejący temat lub utworzyć nowy temat. Gdy aplikacja klienta subskrybuje nową nazwę tematu (której nie ma jeszcze w Twoim projekcie Firebase), w FCM tworzony jest nowy temat o tej nazwie, a każdy klient może go następnie subskrybować.
Aby zasubskrybować temat, aplikacja klienta wywołuje funkcję Firebase Cloud Messaging
subscribeToTopic()
z nazwą tematu FCM. Ta metoda zwraca Task
, którego można użyć w detektorze zakończenia, aby określić, czy subskrypcja się powiodła:
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(); } });
Aby anulować subskrypcję, aplikacja klienta wywołuje funkcję Firebase Cloud Messaging unsubscribeFromTopic()
z nazwą tematu.
Odbieranie i obsługa wiadomości w temacie
FCM dostarcza wiadomości dotyczące tematów w taki sam sposób jak inne wiadomości.
Aby otrzymywać wiadomości, użyj usługi, która rozszerza
FirebaseMessagingService
.
Usługa powinna zastąpić wywołania zwrotne onMessageReceived
i onDeletedMessages
.
Okno czasowe na przetworzenie wiadomości może być krótsze niż 20 sekund, w zależności od opóźnień występujących przed wywołaniem funkcji onMessageReceived
, w tym opóźnień systemu operacyjnego, czasu uruchamiania aplikacji, blokowania głównego wątku przez inne operacje lub zbyt długiego czasu trwania poprzednich wywołań funkcji onMessageReceived
. Po tym czasie różne zachowania systemu operacyjnego, takie jak zabijanie procesów w Androidzie lub ograniczenia dotyczące wykonywania procesów w tle w Androidzie O, mogą utrudniać Ci dokończenie pracy.
onMessageReceived
jest dostępna w przypadku większości typów wiadomości, z tymi wyjątkami:
-
Powiadomienia wysyłane, gdy aplikacja działa w tle. W takim przypadku powiadomienie jest wysyłane do obszaru powiadomień urządzenia. Kliknięcie powiadomienia powoduje domyślnie otwarcie menu z aplikacjami.
-
Wiadomości z zawartością danych i powiadomienia, które są odbierane w tle. W takim przypadku powiadomienie jest dostarczane do zasobnika systemowego urządzenia, a dane są dostarczane w ramach dodatkowych informacji o intencji aktywności w launcherze.
W skrócie:
Stan aplikacji | Powiadomienie | Dane | Oba rodzaje |
---|---|---|---|
Pierwszy plan | onMessageReceived |
onMessageReceived |
onMessageReceived |
Tło | obszar powiadomień. | onMessageReceived |
Powiadomienie: w obszarze powiadomień Dane: w elementach dodatkowych intencji. |
Edytuj plik manifestu aplikacji
Aby używać FirebaseMessagingService
, musisz dodać do pliku manifestu aplikacji:
<service android:name=".java.MyFirebaseMessagingService" android:exported="false"> <intent-filter> <action android:name="com.google.firebase.MESSAGING_EVENT" /> </intent-filter> </service>
Zalecamy też ustawienie wartości domyślnych, aby dostosować wygląd powiadomień. Możesz określić niestandardową domyślną ikonę i niestandardowy domyślny kolor, które są stosowane, gdy w danych powiadomienia nie są ustawione odpowiednie wartości.
Aby ustawić niestandardową ikonę domyślną i niestandardowy kolor, dodaj te wiersze w tagu 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 wyświetla niestandardową ikonę domyślną
- Wszystkie wiadomości z powiadomieniami wysyłane z Kreatora powiadomień.
- każde powiadomienie, które nie ma wyraźnie ustawionej ikony w danych powiadomienia;
Android używa niestandardowego koloru domyślnego w przypadku
- Wszystkie powiadomienia wysyłane z narzędzi do tworzenia powiadomień.
- każda wiadomość, która nie ustawia koloru w sposób jawny w danych ładunku;
Jeśli nie ustawisz niestandardowej domyślnej ikony ani nie podasz ikony w danych powiadomienia, Android wyświetli ikonę aplikacji w kolorze białym.
Zastąp onMessageReceived
Zastępując metodę FirebaseMessagingService.onMessageReceived
, możesz wykonywać działania na podstawie otrzymanego obiektu RemoteMessage i pobierać dane wiadomości:
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. }
Zastąpić onDeletedMessages
W niektórych sytuacjach FCM może nie dostarczyć wiadomości. Dzieje się tak, gdy w danym momencie w aplikacji na konkretnym urządzeniu jest zbyt wiele oczekujących wiadomości (ponad 100) lub gdy urządzenie nie było połączone z aplikacją FCM przez ponad miesiąc. W takich przypadkach możesz otrzymać wywołanie zwrotne do FirebaseMessagingService.onDeletedMessages()
Gdy instancja aplikacji otrzyma to wywołanie zwrotne, powinna przeprowadzić pełną synchronizację z serwerem aplikacji. Jeśli w ciągu ostatnich 4 tygodni nie wysłano do tej aplikacji żadnej wiadomości, FCM nie zadzwoni do onDeletedMessages()
.
Obsługa wiadomości z powiadomień w aplikacji działającej w tle
Gdy aplikacja działa w tle, Android kieruje powiadomienia do obszaru powiadomień. Gdy użytkownik kliknie powiadomienie, domyślnie otworzy się Menu z aplikacjami.
Obejmuje to wiadomości, które zawierają zarówno powiadomienia, jak i ładunek danych (a także wszystkie wiadomości wysłane z konsoli powiadomień). W takich przypadkach powiadomienie jest wysyłane do zasobnika systemowego urządzenia, a dane są dostarczane w ramach dodatkowych informacji o intencji w aktywności Launchera.
Aby uzyskać informacje o dostarczaniu wiadomości do aplikacji, otwórz FCM panel raportowania, który zawiera informacje o liczbie wiadomości wysłanych i otwartych na urządzeniach Apple i Android, a także dane o wyświetleniach (powiadomieniach wyświetlanych użytkownikom) aplikacji na Androida.
Tworzenie żądań wysyłania
Po utworzeniu tematu przez subskrybowanie instancji aplikacji klienckiej w temacie po stronie klienta lub za pomocą interfejsu API serwera możesz wysyłać wiadomości do tematu. Jeśli po raz pierwszy tworzysz żądania wysyłania w przypadku usługi FCM, zapoznaj się z przewodnikiem dotyczącym środowiska serwera i usługi FCM, aby uzyskać ważne informacje wstępne i informacje o konfiguracji.
W logice wysyłania na zapleczu określ nazwę tematu, jak pokazano poniżej:
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);
});
Java
// 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);
Python
# 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)
Go
// 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);
REST
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"
}
}
}
Polecenie 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
Aby wysłać wiadomość do kombinacji tematów, określ warunek, czyli wyrażenie logiczne określające tematy docelowe. Na przykład to wyrażenie spowoduje wysyłanie wiadomości do urządzeń, które mają subskrypcję TopicA
i TopicB
lub TopicC
:
"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"
Funkcja FCM najpierw sprawdza warunki w nawiasach, a następnie wyrażenie od lewej do prawej. W przypadku powyższego wyrażenia użytkownik zasubskrybowany
dowolny pojedynczy temat nie otrzymuje wiadomości. Podobnie użytkownik, który nie subskrybuje kanału TopicA
, nie otrzyma wiadomości. Te kombinacje otrzymują:
TopicA
iTopicB
TopicA
iTopicC
W wyrażeniu warunkowym możesz uwzględnić maksymalnie 5 tematów.
Aby wysłać do warunku:
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);
});
Java
// 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);
Python
# 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)
Go
// 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);
REST
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",
}
}
}
Polecenie 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
Dalsze kroki
- Za pomocą serwera możesz subskrybować instancje aplikacji klienta do tematów i wykonywać inne zadania związane z zarządzaniem. Zobacz Zarządzanie subskrypcjami tematów na serwerze.