Aby kierować wiadomość na wiele urządzeń, użyj Wiadomości tematyczne. Ten umożliwia wysyłać wiadomość na wiele urządzeń, które wyraziły zgodę na dany temat.
Ten samouczek skupia się na wysyłaniu wiadomości tematycznych z serwera aplikacji za pomocą Admin SDK lub Interfejs REST API w wersji FCM, oraz przyjmowania i przetwarzania w aplikacji na Androida. Omówimy obsługę wiadomości zarówno w tle, aplikacji działających na pierwszym planie. Omawiane są wszystkie kroki prowadzące do osiągnięcia tego celu – od konfiguracji po konfigurację. weryfikacji.
Konfigurowanie pakietu SDK
Ta sekcja może zawierać informacje o wykonanych już czynnościach, jeśli mają skonfigurowaną aplikację kliencką na Androida. dla FCM lub przepracował(a) kroki, aby Wyślij swoją pierwszą wiadomość.
Zanim zaczniesz
Instalowanie lub aktualizowanie Android Studio do najnowszej wersji.
Sprawdź, czy Twój projekt spełnia te wymagania (pamiętaj, że niektóre usługi mogą mieć bardziej rygorystyczne wymagania):
- Docelowy poziom interfejsu API: 19 (KitKat) lub więcej
- ma Androida 4.4 lub nowszego,
- Zastosowania
Jetpack (AndroidX),
w tym:
com.android.tools.build:gradle
w wersji 7.3.0 lub nowszejcompileSdkVersion
28 lub nowsze
Skonfiguruj urządzenie fizyczne lub użyj emulator na uruchom aplikację.
Pamiętaj, że pakiety SDK Firebase zależą od Google Play usługi wymagają urządzenia lub emulatorowi, by mieć zainstalowane Usługi Google Play.Zaloguj się w Firebase, korzystając ze swojego konta Google koncie.
Jeśli nie masz jeszcze projektu na Androida, a chcesz tylko wypróbować Firebase możesz pobrać nasze krótkie wprowadzenia.
Tworzenie projektu Firebase
Zanim dodasz Firebase do swojej aplikacji na Androida, musisz utworzyć taką aplikację do połączenia z aplikacją na Androida. Odwiedź Więcej informacji o projektach Firebase Projekty Firebase.
Zarejestruj aplikację w Firebase
Aby używać Firebase w swojej aplikacji na Androida, musisz ją zarejestrować w projekt Firebase. Rejestracja aplikacji często nazywa się „dodawaniem” aplikacji na w projektach AI.
Otwórz konsolę Firebase.
Na środku strony przeglądu projektu kliknij ikonę Androida. (
) lub Dodaj aplikację, aby rozpocząć proces konfiguracji.Wpisz nazwę pakietu aplikacji w polu Nazwa pakietu na Androida.
.(Opcjonalnie) Wpisz inne informacje o aplikacji: Nazwa aplikacji i Certyfikat podpisywania debugowania SHA-1.
Kliknij Zarejestruj aplikację.
Dodaj plik konfiguracji Firebase
Pobierz i dodaj plik konfiguracji Firebase na Androida (
) do Twojej aplikacji:google-services.json Kliknij Pobierz google-services.json, aby uzyskać Firebase na Androida. .
Przenieś plik konfiguracyjny do katalogu głównego module (poziom aplikacji) serwera do aplikacji.
Aby udostępnić wartości w pliku konfiguracyjnym
do pakietów SDK Firebase, Wtyczka Gradle usług Google (google-services.json google-services
).w pliku Gradle na poziomie głównym (na poziomie projektu); (
<project>/build.gradle.kts
lub<project>/build.gradle
), dodaj Wtyczka 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' // ... }
Dodaj pakiety SDK Firebase do swojej aplikacji
w pliku Gradle (na poziomie aplikacji) modułu, (zwykle
<project>/<app-module>/build.gradle.kts
lub<project>/<app-module>/build.gradle
), dodaj zależność z biblioteką Firebase Cloud Messaging na Androida. Zalecamy użycie metody Firebase Android BoM aby kontrolować obsługę wersji biblioteki.Aby zapewnić optymalne działanie usługi Firebase Cloud Messaging, zalecamy włączam Google Analytics w projekcie Firebase i dodając do aplikacji pakiet SDK Firebase dla Google Analytics.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.2.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") }
Korzystając z narzędzia Firebase Android BoM, Twoja aplikacja zawsze używa zgodnych wersji bibliotek Firebase na Androida.
(Wersja alternatywna) Dodaj zależności biblioteki Firebase bez użycia komponentu BoM
Jeśli nie chcesz używać biblioteki Firebase BoM, musisz określić każdą wersję biblioteki Firebase w wierszu zależności.
Pamiętaj, że jeśli używasz wielu bibliotek Firebase w aplikacji, zalecamy korzystanie z BoM do zarządzania wersjami biblioteki. Dzięki temu wszystkie wersje są 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.0.1") implementation("com.google.firebase:firebase-analytics:22.1.0") }
Zsynchronizuj swój projekt na Androida z plikami Gradle.
Subskrybowanie tematu w aplikacji klienckiej
Aplikacje klienckie mogą subskrybować dowolny istniejący temat lub utworzyć nowy temat. Gdy aplikacja kliencka subskrybuje nową nazwę tematu (taką, która nie jeszcze nie istnieje dla Twojego projektu Firebase), nowy temat o tej nazwie to utworzona w FCM i każdy klient może ją subskrybować.
Aby zasubskrybować temat, aplikacja klienta wywołuje metodę Firebase Cloud Messaging
subscribeToTopic()
z tematem FCM. Ta metoda
zwraca element Task
, który może zostać użyty przez detektor ukończenia, aby określić, czy
subskrypcja się udał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 kliencka wywołuje Firebase Cloud Messaging unsubscribeFromTopic()
nazwę tematu.
Odbieranie i obsługę wiadomości dotyczących tematów
FCM dostarcza wiadomości tematyczne w taki sam sposób, jak inne wiadomości na kolejnym etapie wiadomości.
Aby odbierać wiadomości, użyj usługi z rozszerzeniem
FirebaseMessagingService
Twoja usługa powinna zastąpić te zasady: onMessageReceived
i onDeletedMessages
.
Czas przetwarzania wiadomości może być krótszy niż 20 sekund w zależności od opóźnień
naliczone przed zadzwonieniem pod numer onMessageReceived
, w tym opóźnienia systemu operacyjnego, czas uruchomienia aplikacji,
wątek główny jest blokowany przez inne operacje lub poprzedni onMessageReceived
trwa zbyt długo. Po tym czasie różne działania systemu operacyjnego, takie jak
procesu
zabijanie czy
i limity wykonywania w tle mogą zakłócać Twoją zdolność do wykonywania pracy.
W przypadku większości typów wiadomości uwzględniana jest właściwość onMessageReceived
, przy czym z następującymi
wyjątki:
-
Powiadomienia z powiadomieniami dostarczane, gdy aplikacja działa w tle. W tym powiadomienie pojawi się w obszarze powiadomień urządzenia. Użytkownik klika powiadomienie domyślnie otwiera Menu z aplikacjami.
-
Wiadomości z powiadomieniami i ładunkiem danych odebrane w tle W takim przypadku powiadomienie pojawi się w obszarze powiadomień. ładunek danych jest dostarczany w elementach dodatkowych intencji związanych z aktywnością programu uruchamiającego.
W skrócie:
Stan aplikacji | Powiadomienie | Dane | Oba rodzaje |
---|---|---|---|
Pierwszy plan | onMessageReceived |
onMessageReceived |
onMessageReceived |
Tło | Zasobnik systemowy | onMessageReceived |
Powiadomienie: obszar powiadomień Dane: w dodatkowych celach. |
Edytuj plik manifestu aplikacji
Aby użyć usługi FirebaseMessagingService
, musisz dodać te elementy do
plik 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ń. Ty pozwala określić niestandardową ikonę domyślną i niestandardowy kolor domyślny, który będzie stosowany nie są ustawione w ładunku powiadomień.
Dodaj te wiersze w polu
Tag application
, który pozwala ustawić niestandardową ikonę domyślną i niestandardowy kolor:
<!-- 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 powiadomienia wysyłane z Edytor powiadomień.
- Wszystkie komunikaty z powiadomieniami, które nie mają wyraźnie określonej ikony w ładunku powiadomień.
Android używa niestandardowego koloru domyślnego dla
- Wszystkie powiadomienia wysyłane z Edytor powiadomień.
- Wszystkie powiadomienia, które nie mają w sposób wyraźny określony koloru. ładunek.
Jeśli nie ustawisz żadnej niestandardowej ikony domyślnej i nie ustawisz żadnej ikony w ładunku powiadomień, Android wyświetla ikonę aplikacji wyrenderowaną na biało.
Zastąp onMessageReceived
Zastępując metodę FirebaseMessagingService.onMessageReceived
,
możesz wykonywać działania na podstawie otrzymanych
Zdalna_wiadomość
i pobierz 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ąp onDeletedMessages
W niektórych sytuacjach FCM może nie dostarczyć wiadomości. Dzieje się tak, gdy jest zbyt wiele
oczekujące wiadomości (> 100) dla
w momencie nawiązania połączenia lub gdy urządzenie nie połączyło się
FCM za ponad miesiąc. W takich przypadkach
możesz oddzwonić pod numer FirebaseMessagingService.onDeletedMessages()
Gdy instancja aplikacji otrzyma to wywołanie zwrotne,
powinien przeprowadzić pełną synchronizację z serwerem aplikacji. Jeśli wiadomość nie została jeszcze wysłana do aplikacji
urządzenie w ciągu ostatnich 4 tygodni, FCM nie będzie nawiązywać połączenia z numerem onDeletedMessages()
.
Obsługuj wiadomości z powiadomieniami w aplikacji działającej w tle
Gdy aplikacja działa w tle, Android przekierowuje powiadomienia na w obszarze powiadomień. Kliknięcie powiadomienia przez użytkownika powoduje otwarcie menu z aplikacjami wartość domyślną.
Obejmuje to wiadomości zawierające zarówno powiadomienia, jak i dane ładunek (oraz wszystkie wiadomości wysłane z konsoli powiadomień). W takich przypadkach powiadomienie jest dostarczane do w zasobniku systemowym, a ładunek danych jest dostarczany w elementach dodatkowych intencji aktywności programu uruchamiającego.
Więcej informacji o dostarczaniu wiadomości do aplikacji znajdziesz tutaj: FCM panelu raportowania, który rejestruje liczba wiadomości wysłanych i otwartych na urządzeniach Apple i z Androidem oraz dane dotyczące „wyświetleń” (powiadomienia użytkowników) dotyczące aplikacji na Androida.
Tworzenie żądań wysyłania
Po utworzeniu tematu przez zasubskrybowanie instancji aplikacji klienckiej po stronie klienta lub w interfejs API serwera, możesz wysyłać komunikaty do temat. Jeśli po raz pierwszy tworzysz prośby o wysłanie próśb do usługi FCM, zobacz przewodnik środowisko serwera i FCM dla najważniejsze informacje i informacje o konfiguracji.
W logice wysyłania w backendzie określ odpowiednią nazwę tematu Jak widać:
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, które określa
kierowania na tematy. Na przykład poniższy warunek spowoduje wysłanie wiadomości do
urządzenia z subskrypcją TopicA
oraz TopicB
lub TopicC
:
"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"
Funkcja FCM najpierw sprawdza warunki w nawiasach, a potem
od lewej do prawej. W powyższym wyrażeniu użytkownik zasubskrybował
każdy z tematów nie otrzyma wiadomości. Podobnie użytkownik, który nie
subskrypcja użytkownika TopicA
nie otrzymuje wiadomości. Takie kombinacje mają
go otrzymać:
TopicA
iTopicB
TopicA
iTopicC
Wyrażenie warunkowe może zawierać 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 klienckich w tematyce oraz wykonywać inne zadania związane z zarządzaniem. Zobacz Zarządzaj subskrypcjami tematów na serwerze.