Aby rozpocząć korzystanie z FCM, zaimplementuj najprostszy przypadek użycia: wyślij testowe powiadomienie z komponisty powiadomień na urządzenie programistyczne, gdy aplikacja działa w tle. Na tej stronie znajdziesz wszystkie kroki, które należy wykonać, od konfiguracji do weryfikacji. Mogą one obejmować czynności, które zostały już przez Ciebie wykonane, jeśli skonfigurujesz aplikację klienta Apple dla FCM.
Dodawanie Firebase do projektu Apple
W tej sekcji znajdziesz zadania, które możesz już mieć wykonane, jeśli masz w swojej aplikacji włączone inne funkcje Firebase. W przypadku FCM musisz przesłać klucz uwierzytelniający APNs i zarejestrować się w celu otrzymywania powiadomień zdalnych.
Wymagania wstępne
Zainstaluj te elementy:
- Xcode 15.2 lub nowsza wersja
Upewnij się, że Twój projekt spełnia te wymagania:
- Twój projekt musi być kierowany na te wersje platformy lub nowsze:
- iOS 13
- macOS 10.15
- tvOS 13
- watchOS 7
- Twój projekt musi być kierowany na te wersje platformy lub nowsze:
Aby uruchomić aplikację, skonfiguruj fizyczne urządzenie Apple i wykonaj te czynności:
- Uzyskaj klucz uwierzytelniający powiadomienia push Apple na swoje konto Apple Developer.
- Włącz powiadomienia push w XCode w sekcji Aplikacja > Możliwości.
- Zaloguj się w Firebase za pomocą konta Google.
Jeśli nie masz jeszcze projektu Xcode i chcesz wypróbować produkt Firebase, możesz pobrać jeden z naszych przykładowych projektów.
Tworzenie projektu Firebase
Zanim dodasz Firebase do aplikacji Apple, musisz utworzyć projekt Firebase, aby połączyć go z aplikacją. Więcej informacji o projektach Firebase znajdziesz w artykule Informacje o projektach Firebase.
Rejestrowanie aplikacji w Firebase
Aby korzystać z Firebase w aplikacji na urządzenia Apple, musisz ją zarejestrować w projekcie Firebase. Rejestrowanie aplikacji jest często nazywane „dodawaniem” aplikacji do projektu.
Otwórz konsolę Firebase.
W centrum strony „Opis” projektu kliknij ikonę iOS+, aby uruchomić proces konfiguracji.
Jeśli aplikacja została już dodana do projektu Firebase, kliknij Dodaj aplikację, aby wyświetlić opcje platformy.
W polu Identyfikator pakietu wpisz identyfikator pakietu aplikacji.
(Opcjonalnie) Wpisz inne informacje o aplikacji: nazwę skrótową aplikacji i identyfikator App Store.
Kliknij Zarejestruj aplikację.
Dodawanie pliku konfiguracji Firebase
Kliknij Pobierz plik GoogleService-Info.plist, aby pobrać plik konfiguracji Firebase dla platform Apple (
GoogleService-Info.plist
).Przenieś plik konfiguracji do katalogu głównego projektu Xcode. Jeśli pojawi się taka prośba, wybierz opcję dodania pliku konfiguracyjnego do wszystkich miejsc docelowych.
Jeśli w projekcie masz wiele identyfikatorów pakietów, musisz powiązać każdy z nich z zarejestrowaną aplikacją w konsoli Firebase, aby każda aplikacja miała własny plik GoogleService-Info.plist
.
Dodawanie pakietów SDK Firebase do aplikacji
Do instalacji zależności Firebase i zarządzania nimi możesz używać menedżera pakietów Swift.
- Po otwarciu projektu aplikacji w Xcode wybierz Plik > Dodaj pakiety.
- Gdy pojawi się prośba, dodaj repozytorium pakietu SDK Firebase na platformy Apple:
- Wybierz bibliotekę Firebase Cloud Messaging.
- Dodaj flagę
-ObjC
do sekcji Inne flagi linkera w ustawieniach kompilacji docelowej. - 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. Możesz wybrać bibliotekę z zbieraniem identyfikatorów IDFA lub bez niego.
- Gdy to zrobisz, Xcode automatycznie zacznie wyszukiwać i pobierać zależności w tle.
https://github.com/firebase/firebase-ios-sdk.git
Przesyłanie klucza uwierzytelniania APNs
Prześlij klucz uwierzytelniania APNs do Firebase. Jeśli nie masz jeszcze klucza uwierzytelniania APN, utwórz go w Centrum dla deweloperów Apple.
-
W konsoli Firebase projektu kliknij ikonę koła zębatego, wybierz Ustawienia projektu, a następnie kartę Cloud Messaging.
-
W sekcji Konfiguracja aplikacji na iOS kliknij Prześlij obok Klucz uwierzytelniania APNs.
-
Przejdź do lokalizacji, w której został zapisany klucz, wybierz go i kliknij Otwórz. Dodaj identyfikator klucza (dostępny w Centrum dla deweloperów Apple) i kliknij Prześlij.
Inicjowanie Firebase w aplikacji
Musisz dodać do aplikacji kod inicjalizacji Firebase. Zaimportuj moduł Firebase i skonfiguruj współdzieloną instancję, jak pokazano na ilustracji:
- Zaimportuj moduł
FirebaseCore
w plikuUIApplicationDelegate
oraz wszystkie inne moduły Firebase, których używa delegowany obiekt aplikacji. Aby na przykład użyć właściwości Cloud Firestore i Authentication:SwiftUI
import SwiftUI import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
Swift
import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
Objective-C
@import FirebaseCore; @import FirebaseFirestore; @import FirebaseAuth; // ...
- Skonfiguruj współdzieloną instancję
FirebaseApp
w metodzieapplication(_:didFinishLaunchingWithOptions:)
w delegacie aplikacji:SwiftUI
// Use Firebase library to configure APIs FirebaseApp.configure()
Swift
// Use Firebase library to configure APIs FirebaseApp.configure()
Objective-C
// Use Firebase library to configure APIs [FIRApp configure];
- Jeśli używasz SwiftUI, musisz utworzyć obiekt delegujący aplikacji i dołączyć go do struktury
App
za pomocą funkcjiUIApplicationDelegateAdaptor
lubNSApplicationDelegateAdaptor
. Musisz też wyłączyć swizlowanie zastępników aplikacji. Więcej informacji znajdziesz w instrukcjach SwiftUI.SwiftUI
@main struct YourApp: App { // register app delegate for Firebase setup @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate var body: some Scene { WindowGroup { NavigationView { ContentView() } } } }
Rejestrowanie się na powiadomienia zdalne
Zarejestruj aplikację do otrzymywania powiadomień zdalnych na etapie uruchamiania lub w wybranym miejscu w przebiegu aplikacji. Wywołaj funkcjęregisterForRemoteNotifications
w ten sposób:
Swift
UNUserNotificationCenter.current().delegate = self let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound] UNUserNotificationCenter.current().requestAuthorization( options: authOptions, completionHandler: { _, _ in } ) application.registerForRemoteNotifications()
Objective-C
[UNUserNotificationCenter currentNotificationCenter].delegate = self; UNAuthorizationOptions authOptions = UNAuthorizationOptionAlert | UNAuthorizationOptionSound | UNAuthorizationOptionBadge; [[UNUserNotificationCenter currentNotificationCenter] requestAuthorizationWithOptions:authOptions completionHandler:^(BOOL granted, NSError * _Nullable error) { // ... }]; [application registerForRemoteNotifications];
Dostęp do tokena rejestracji
Aby wysłać wiadomość na konkretne urządzenie, musisz znać jego token rejestracji. Aby ukończyć ten samouczek, musisz wpisać token w polu w kompozytorze powiadomień. Po jego pobraniu skopiuj go lub zapisz w bezpiecznym miejscu.
Domyślnie pakiet SDK FCM generuje token rejestracji dla wystąpienia aplikacji klienta po uruchomieniu aplikacji. Podobnie jak token urządzenia APN, ten token umożliwia wysyłanie ukierunkowanych powiadomień do dowolnego konkretnego wystąpienia aplikacji.
Podobnie jak platformy Apple zwykle dostarczają token urządzenia APN po uruchomieniu aplikacji, FCM dostarcza token rejestracji za pomocą metody FIRMessagingDelegate
messaging:didReceiveRegistrationToken:
.
Pakiet FCM SDK pobiera nowy lub istniejący token podczas uruchamiania aplikacji oraz za każdym razem, gdy token zostanie zaktualizowany lub unieważniony.
W każdym przypadku pakiet FCM SDK wywołuje funkcję messaging:didReceiveRegistrationToken:
z poprawnym tokenem.
Token rejestracji może się zmienić, gdy:
- Aplikacja jest przywracana na nowym urządzeniu
- Użytkownik odinstaluje/ponownie zainstaluje aplikację.
- Użytkownik czyści dane aplikacji.
Konfigurowanie delegata do obsługi wiadomości
Aby otrzymywać tokeny rejestracji, zaimplementuj protokół obsługi wiadomości i po wywołaniu funkcji [FIRApp configure]
ustaw właściwość delegate
obiektu FIRMessaging
.
Jeśli na przykład delegowanie aplikacji jest zgodne z protokołem delegowania wiadomości, możesz ustawić delegowanie w application:didFinishLaunchingWithOptions:
na samo siebie.
Swift
Messaging.messaging().delegate = self
Objective-C
[FIRMessaging messaging].delegate = self;
Pobieranie bieżącego tokena rejestracji
Tokeny rejestracji są dostarczane za pomocą metody messaging:didReceiveRegistrationToken:
. Ta metoda jest wywoływana zwykle raz na rozpoczęcie aplikacji za pomocą tokena rejestracji. Wywołanie tej metody to idealny moment na:
- Jeśli token rejestracji jest nowy, prześlij go na serwer aplikacji.
- Subskrybuj token rejestracji w tematach. Jest to wymagane tylko w przypadku nowych subskrypcji lub sytuacji, gdy użytkownik ponownie zainstalował aplikację.
Token możesz pobrać bezpośrednio za pomocą funkcji token(completion:). Jeśli pobranie tokena zakończyło się niepowodzeniem, zwracany jest błąd inny niż null.
Swift
Messaging.messaging().token { token, error in if let error = error { print("Error fetching FCM registration token: \(error)") } else if let token = token { print("FCM registration token: \(token)") self.fcmRegTokenMessage.text = "Remote FCM registration token: \(token)" } }
Objective-C
[[FIRMessaging messaging] tokenWithCompletion:^(NSString *token, NSError *error) { if (error != nil) { NSLog(@"Error getting FCM registration token: %@", error); } else { NSLog(@"FCM registration token: %@", token); self.fcmRegTokenMessage.text = token; } }];
W każdej chwili możesz użyć tej metody, aby uzyskać dostęp do tokena zamiast go przechowywać.
Monitorowanie odświeżania tokena
Aby otrzymywać powiadomienia o aktualizacji tokena, podaj delegata zgodnego z protokołem delegata wiadomości. W tym przykładzie rejestrujemy delegata i dodajemy odpowiednią metodę delegata:
Swift
func messaging(_ messaging: Messaging, didReceiveRegistrationToken fcmToken: String?) { print("Firebase registration token: \(String(describing: fcmToken))") let dataDict: [String: String] = ["token": fcmToken ?? ""] NotificationCenter.default.post( name: Notification.Name("FCMToken"), object: nil, userInfo: dataDict ) // TODO: If necessary send token to application server. // Note: This callback is fired at each app startup and whenever a new token is generated. }
Objective-C
- (void)messaging:(FIRMessaging *)messaging didReceiveRegistrationToken:(NSString *)fcmToken { NSLog(@"FCM registration token: %@", fcmToken); // Notify about received token. NSDictionary *dataDict = [NSDictionary dictionaryWithObject:fcmToken forKey:@"token"]; [[NSNotificationCenter defaultCenter] postNotificationName: @"FCMToken" object:nil userInfo:dataDict]; // TODO: If necessary send token to application server. // Note: This callback is fired at each app startup and whenever a new token is generated. }
Możesz też nasłuchiwać zdarzenia NSNotification
o nazwie kFIRMessagingRegistrationTokenRefreshNotification
, zamiast podawać metodę delegowaną. Właściwość tokena zawsze zawiera bieżącą wartość tokena.
Wysyłanie wiadomości z powiadomieniem
Zainstaluj aplikację na urządzeniu docelowym i uruchom ją. Na urządzeniach Apple musisz zaakceptować prośbę o zezwolenie na otrzymywanie powiadomień zdalnych.
Upewnij się, że aplikacja działa w tle na urządzeniu.
W konsoli Firebase otwórz stronę Komunikacja.
Jeśli to Twoja pierwsza wiadomość, kliknij Utwórz pierwszą kampanię.
- Kliknij kolejno Wiadomości powiadomień Firebase i Utwórz.
W przeciwnym razie na karcie Kampanie kliknij kolejno Nowa kampania i Powiadomienia.
Wpisz tekst wiadomości. Pozostałe pola są opcjonalne.
W prawym okienku kliknij Wyślij wiadomość testową.
W polu Dodaj token rejestracji FCM wpisz token rejestracji uzyskany w poprzedniej sekcji tego przewodnika.
Kliknij Test.
Po wybraniu opcji Test na urządzeniu docelowym klienta (z aplikacją działającą w tle) powinno pojawić się powiadomienie.
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.
Dalsze kroki
Aby dodać do aplikacji inne, bardziej zaawansowane funkcje niż tylko wiadomości z powiadomieniami, zapoznaj się z tymi artykułami: