Aby rozpocząć korzystanie z FCM, utwórz najprostszy przypadek użycia: wysłanie powiadomienia testowego z narzędzia do tworzenia powiadomień do urządzenia programistycznego, gdy aplikacja działa w tle na urządzeniu. Na tej stronie znajdują się wszystkie kroki, które należy wykonać, aby to osiągnąć, od konfiguracji po weryfikację — może obejmować kroki, które już wykonałeś, jeśli skonfigurowałeś aplikację kliencką Apple dla FCM.
Dodaj Firebase do swojego projektu Apple
W tej sekcji omówiono zadania, które mogłeś wykonać, jeśli włączyłeś już inne funkcje Firebase w swojej aplikacji. W szczególności w przypadku FCM musisz przesłać klucz uwierzytelniający APNs i zarejestrować się, aby otrzymywać zdalne powiadomienia .
Warunki wstępne
Zainstaluj następujące elementy:
- Xcode 14.1 lub nowszy
Upewnij się, że Twój projekt spełnia następujące wymagania:
- Twój projekt musi być przeznaczony dla tych wersji platform lub nowszych:
- iOS 11
- macOS 10.13
- tvOS 12
- zegarekOS 6
- Twój projekt musi być przeznaczony dla tych wersji platform lub nowszych:
Skonfiguruj fizyczne urządzenie Apple do uruchamiania aplikacji i wykonaj następujące zadania:
- Uzyskaj klucz uwierzytelniający powiadomienia Apple Push dla swojego konta programisty Apple .
- Włącz powiadomienia push w XCode w obszarze Aplikacja > Możliwości .
- Zaloguj się do Firebase przy użyciu swojego konta Google.
Jeśli nie masz jeszcze projektu Xcode i chcesz po prostu wypróbować produkt Firebase, możesz pobrać jeden z naszych przykładów szybkiego startu .
Utwórz projekt Firebase
Zanim będziesz mógł dodać Firebase do swojej aplikacji Apple, musisz utworzyć projekt Firebase, aby połączyć się z Twoją aplikacją. Odwiedź stronę Poznaj projekty Firebase, aby dowiedzieć się więcej o projektach Firebase.
Zarejestruj swoją aplikację w Firebase
Aby używać Firebase w aplikacji Apple, musisz zarejestrować aplikację w projekcie Firebase. Rejestracja aplikacji jest często nazywana „dodawaniem” aplikacji do projektu.
Przejdź do konsoli Firebase .
Na środku strony przeglądu projektu kliknij ikonę iOS+ , aby uruchomić proces konfiguracji.
Jeśli dodałeś już aplikację do projektu Firebase, kliknij Dodaj aplikację , aby wyświetlić opcje platformy.
Wpisz identyfikator pakietu aplikacji w polu identyfikatora pakietu .
Identyfikator pakietu jednoznacznie identyfikuje aplikację w ekosystemie Apple.
Znajdź swój identyfikator pakietu: otwórz swój projekt w Xcode, wybierz aplikację najwyższego poziomu w nawigatorze projektu, a następnie wybierz kartę Ogólne .
Wartością pola Identyfikator pakietu jest identyfikator pakietu (na przykład
com.yourcompany.yourproject
).Pamiętaj, że w wartości identyfikatora pakietu rozróżniana jest wielkość liter i nie można jej zmienić w przypadku tej aplikacji Firebase po jej zarejestrowaniu w projekcie Firebase.
(Opcjonalnie) Wprowadź inne informacje o aplikacji: pseudonim aplikacji i identyfikator App Store .
Pseudonim aplikacji : wewnętrzny, wygodny identyfikator, który jest widoczny tylko dla Ciebie w konsoli Firebase
Identyfikator App Store : używany przez Firebase Dynamic Links do przekierowywania użytkowników na stronę App Store oraz przez Google Analytics do importowania zdarzeń konwersji do Google Ads . Jeśli Twoja aplikacja nie ma jeszcze identyfikatora App Store, możesz dodać go później w ustawieniach projektu .
Kliknij opcję Zarejestruj aplikację .
Dodaj plik konfiguracyjny Firebase
Kliknij opcję Pobierz GoogleService-Info.plist , aby uzyskać plik konfiguracyjny platform Firebase Apple (
GoogleService-Info.plist
).Plik konfiguracyjny Firebase zawiera unikalne, ale nie tajne identyfikatory Twojego projektu. Aby dowiedzieć się więcej o tym pliku konfiguracyjnym, odwiedź stronę Informacje o projektach Firebase .
W dowolnym momencie możesz ponownie pobrać plik konfiguracyjny Firebase .
Upewnij się, że nazwa pliku konfiguracyjnego nie jest uzupełniona dodatkowymi znakami, takimi jak
(2)
.
Przenieś plik konfiguracyjny do katalogu głównego projektu Xcode. Jeśli zostanie wyświetlony monit, wybierz opcję dodania pliku konfiguracyjnego do wszystkich obiektów docelowych.
Jeśli w projekcie masz wiele identyfikatorów pakietów, musisz powiązać każdy identyfikator pakietu z zarejestrowaną aplikacją w konsoli Firebase, aby każda aplikacja mogła mieć własny plik GoogleService-Info.plist
.
Dodaj pakiety SDK Firebase do swojej aplikacji
Użyj Menedżera pakietów Swift, aby zainstalować zależności Firebase i zarządzać nimi.
- W Xcode, przy otwartym projekcie aplikacji, przejdź do File > Add Packages .
- Po wyświetleniu monitu dodaj repozytorium SDK platform Firebase Apple:
- Wybierz bibliotekę Firebase Cloud Messaging.
- Dodaj flagę
-ObjC
do sekcji Inne flagi linkera w ustawieniach kompilacji celu. - Aby zapewnić optymalne działanie Firebase Cloud Messaging, zalecamy włączenie Google Analytics w projekcie Firebase i dodanie pakietu SDK Firebase dla Google Analytics do swojej aplikacji. Można wybrać bibliotekę bez kolekcji IDFA lub z kolekcją IDFA.
- Po zakończeniu Xcode automatycznie rozpocznie rozwiązywanie i pobieranie zależności w tle.
https://github.com/firebase/firebase-ios-sdk.git
Prześlij swój klucz uwierzytelniający APNs
Prześlij swój klucz uwierzytelniający APNs do Firebase. Jeśli nie masz jeszcze klucza uwierzytelniającego APNs, pamiętaj o utworzeniu go w Apple Developer Member Center .
Wewnątrz projektu w konsoli Firebase wybierz ikonę koła zębatego, wybierz Ustawienia projektu , a następnie wybierz kartę Cloud Messaging .
W kluczu uwierzytelniania APN w obszarze konfiguracji aplikacji na iOS kliknij przycisk Prześlij .
Przejdź do lokalizacji, w której zapisałeś klucz, wybierz go i kliknij Otwórz . Dodaj identyfikator klucza (dostępny w Apple Developer Member Center ) i kliknij Prześlij .
Zainicjuj Firebase w swojej aplikacji
Musisz dodać kod inicjujący Firebase do swojej aplikacji. Zaimportuj moduł Firebase i skonfiguruj instancję współdzieloną, jak pokazano:
- Zaimportuj moduł
FirebaseCore
do swojegoUIApplicationDelegate
, a także wszelkie inne moduły Firebase, których używa delegat aplikacji. Na przykład, aby użyć Cloud Firestore i uwierzytelniania:SwiftUI
import SwiftUI import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
Szybki
import FirebaseCore import FirebaseFirestore import FirebaseAuth // ...
Cel C
@import FirebaseCore; @import FirebaseFirestore; @import FirebaseAuth; // ...
- Skonfiguruj udostępnioną instancję
FirebaseApp
w aplikacji delegataapplication(_:didFinishLaunchingWithOptions:)
metoda:SwiftUI
// Use Firebase library to configure APIs FirebaseApp.configure()
Szybki
// Use Firebase library to configure APIs FirebaseApp.configure()
Cel C
// Use Firebase library to configure APIs [FIRApp configure];
- Jeśli używasz SwiftUI, musisz utworzyć delegata aplikacji i dołączyć go do struktury
App
za pośrednictwemUIApplicationDelegateAdaptor
lubNSApplicationDelegateAdaptor
. Musisz także wyłączyć przełączanie delegatów aplikacji. Aby uzyskać więcej informacji, zapoznaj się z instrukcjami SwiftUI .SwiftUI
@main struct YourApp: App { // register app delegate for Firebase setup @UIApplicationDelegateAdaptor(AppDelegate.self) var delegate var body: some Scene { WindowGroup { NavigationView { ContentView() } } } }
Zarejestruj się, aby otrzymywać zdalne powiadomienia
Zarejestruj aplikację przy uruchamianiu lub w żądanym momencie przepływu aplikacji, aby otrzymywać zdalne powiadomienia. Zadzwoń doregisterForRemoteNotifications
, jak pokazano:Szybki
UNUserNotificationCenter.current().delegate = self let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound] UNUserNotificationCenter.current().requestAuthorization( options: authOptions, completionHandler: { _, _ in } ) application.registerForRemoteNotifications()
Cel C
[UNUserNotificationCenter currentNotificationCenter].delegate = self; UNAuthorizationOptions authOptions = UNAuthorizationOptionAlert | UNAuthorizationOptionSound | UNAuthorizationOptionBadge; [[UNUserNotificationCenter currentNotificationCenter] requestAuthorizationWithOptions:authOptions completionHandler:^(BOOL granted, NSError * _Nullable error) { // ... }]; [application registerForRemoteNotifications];
Uzyskaj dostęp do tokena rejestracyjnego
Aby wysłać wiadomość na konkretne urządzenie, musisz znać token rejestracji tego urządzenia. Ponieważ w celu ukończenia tego samouczka konieczne będzie wprowadzenie tokenu w polu kreatora powiadomień , pamiętaj o skopiowaniu tokenu lub bezpiecznym przechowywaniu go po jego pobraniu.
Domyślnie zestaw SDK FCM generuje token rejestracji dla instancji aplikacji klienckiej podczas uruchamiania aplikacji. Podobnie jak token urządzenia APNs, ten token umożliwia wysyłanie ukierunkowanych powiadomień do dowolnej konkretnej instancji aplikacji.
W ten sam sposób, w jaki platformy Apple zazwyczaj dostarczają token urządzenia APNs przy uruchamianiu aplikacji, FCM udostępnia token rejestracji za pośrednictwem metody messaging:didReceiveRegistrationToken:
FIRMessagingDelegate
Zestaw SDK FCM pobiera nowy lub istniejący token podczas pierwszego uruchomienia aplikacji oraz za każdym razem, gdy token jest aktualizowany lub unieważniany. We wszystkich przypadkach zestaw FCM SDK wywołuje messaging:didReceiveRegistrationToken:
z prawidłowym tokenem.
Token rejestracyjny może ulec zmianie w przypadku:
- Aplikacja zostanie przywrócona na nowym urządzeniu
- Użytkownik odinstalowuje/ponownie instaluje aplikację
- Użytkownik czyści dane aplikacji.
Ustaw delegata przesyłania wiadomości
Aby otrzymać tokeny rejestracji, zaimplementuj protokół delegowania przesyłania wiadomości i ustaw właściwość delegate
FIRMessaging
po wywołaniu [FIRApp configure]
. Na przykład, jeśli delegat aplikacji jest zgodny z protokołem delegowania przesyłania wiadomości, możesz ustawić delegata na application:didFinishLaunchingWithOptions:
na siebie.
Szybki
Messaging.messaging().delegate = self
Cel C
[FIRMessaging messaging].delegate = self;
Pobieranie aktualnego tokena rejestracyjnego
Tokeny rejestracyjne dostarczane są metodą messaging:didReceiveRegistrationToken:
. Ta metoda jest wywoływana zazwyczaj raz na aplikację uruchamianą z tokenem rejestracji. Po wywołaniu tej metody jest to idealny moment na:
- Jeśli token rejestracyjny jest nowy, wyślij go na serwer aplikacji.
- Subskrybuj token rejestracyjny do tematów. Jest to wymagane tylko w przypadku nowych subskrypcji lub w sytuacjach, gdy użytkownik ponownie zainstalował aplikację.
Możesz pobrać token bezpośrednio za pomocą token(completion:) . Jeśli w jakikolwiek sposób nie udało się pobrać tokenu, zostanie wyświetlony błąd inny niż null.
Szybki
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)" } }
Cel 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; } }];
Możesz użyć tej metody w dowolnym momencie, aby uzyskać dostęp do tokena zamiast go przechowywać.
Monitoruj odświeżanie tokenu
Aby otrzymywać powiadomienia za każdym razem, gdy token zostanie zaktualizowany, podaj delegata zgodnego z protokołem delegata przesyłania komunikatów. Poniższy przykład rejestruje delegata i dodaje odpowiednią metodę delegata:
Szybki
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. }
Cel 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. }
Alternatywnie możesz nasłuchiwać NSNotification
o nazwie kFIRMessagingRegistrationTokenRefreshNotification
zamiast dostarczać metodę delegowania. Właściwość tokenu zawsze ma bieżącą wartość tokenu.
Wyślij wiadomość z powiadomieniem
Zainstaluj i uruchom aplikację na urządzeniu docelowym. Na urządzeniach Apple musisz zaakceptować prośbę o pozwolenie na otrzymywanie zdalnych powiadomień.
Upewnij się, że aplikacja działa w tle na urządzeniu.
W konsoli Firebase otwórz stronę Wiadomości .
Jeśli to Twoja pierwsza wiadomość, wybierz opcję Utwórz pierwszą kampanię .
- Wybierz Wiadomości z powiadomieniami Firebase i wybierz Utwórz .
W przeciwnym razie na zakładce Kampanie wybierz Nowa kampania , a następnie Powiadomienia .
Wpisz treść wiadomości. Wszystkie pozostałe pola są opcjonalne.
Wybierz opcję Wyślij wiadomość testową w prawym okienku.
W polu Dodaj token rejestracyjny FCM wpisz token rejestracyjny uzyskany w poprzedniej części tego przewodnika.
Wybierz Testuj .
Po wybraniu opcji Testuj docelowe urządzenie klienckie (z aplikacją działającą w tle) powinno otrzymać powiadomienie.
Wgląd w dostarczanie wiadomości do aplikacji znajdziesz w panelu raportowania FCM , który rejestruje liczbę wiadomości wysłanych i otwartych na urządzeniach Apple i Android, wraz z danymi dotyczącymi „wyświetleń” (powiadomień widocznych przez użytkowników) w przypadku aplikacji na Androida.
Następne kroki
Aby wyjść poza powiadomienia i dodać inne, bardziej zaawansowane zachowania do swojej aplikacji, zobacz: