iOS Development: Powiadomienia push z Firebase Cloud Messaging

Czego nauczę się w tym poradniku?

• Jak utworzyć nowy projekt w Xcode
• Jak wstępnie skonfigurować projekt, aby mógł korzystać z powiadomień push
• Jak zainstalować Firebase SDK
• Jak wygenerować klucz uwierzytelniający w Apple Developer Program
• Jak utworzyć i zainstalować profil Provisioning Profile
• Jak włączyć i skonfigurować powiadomienia z zastosowaniem Firebase Cloud Messaging
• Jak wysłać powiadomienie do aplikacji iOS z Firebase Console

Wymagania

• Komputer z systemem Mac OS
• Urządzenie z systemem iOS
• Edytor Xcode w wersji 8 lub nowszy
• Kompilator języka Swift w wersji 3 lub nowszy
• Płatna subskrypcja Apple Developer Program
• Konto Google Account
• Zainstalowane narzędzie Cocoapods w wersji 1.2.0 lub nowsze

Poziom trudności

• Średni

Treść poradnika

Poniżej została przedstawiona lista czynności potrzebnych do skutecznej implementacji powiadomień Push Notifications w aplikacji iOS, z wykorzystaniem Firebase Cloud Messaging (FCM).

Firebase Cloud Messaging to wieloplatformowe rozwiązanie pozwalające na wysyłanie wiadomości i powiadomień na aplikacje iOS, Android i webowe, bez ponoszenia kosztów.

Tłumaczenie zostało wykonane w oparciu o treści zawarte na https://en.wikipedia.org/wiki/Firebase_Cloud_Messaging.

Informacja: Wskazówki testowano w systemie Mac OS High Sierra 10.13 z zainstalowanym edytorem Xcode w wersji 9.2, a testy aplikacji odbyły się na telefonie iPhone 5s z systemem iOS 11.

Przykładowy projekt znajduje się na moim repozytorium GIT pod adresem https://github.com/ptrio42/push-notifications-demo.

Tworzenie nowego projektu w Xcode

Przed rozpoczęciem procesu implementacji Push Notifications w projekcie, koniecznym jest jego utworzenie. Alternatywnie, istniejący projekt może zostać wykorzystany - w tym przypadku poniższy krok powinien zostać pominięty.

Aby stworzyć nowy projekt w Xcode, należy na ekranie powitalnym narzędzia odnaleźć opcję Create a new Xcode project.

Z listy, która się pojawi należy wybrać Single View Application oraz kliknąć w przycisk Next. Taki wybór oznacza, że aplikacja, która zostanie utworzona będzie posiadać jeden widok.

Informacja: Wybór aplikacji z pojedynczym widokiem to dobry punkt startowy dla nowej aplikacji. Większą ilość widoków można dodać w poźniejszych etapach pracy nad aplikacją.

W następnym kroku, koniecznym jest wprowadzenie nazwy produktu (projektu), wybór zespołu deweloperskiego, nazwy organizacji, identyfikatora organizacji oraz języka programowania.

Product Name, czyli nazwa produktu, jest używana do utworzenia unikalnego identyfikatora aplikacji tzw. Bundle Identifier. Nazwa ta jest prezentowana na liście aplikacji w systemie iOS i w AppStore oraz w otrzymywanym powiadomieniu push.

Team, inaczej zespół deweloperski, to pole wyboru zespołu deweloperskiego subskrybującego Apple Development Program.

Organization Name lub nazwa organizacji to inaczej nazwa wydawcy aplikacji.

Organization Identifier, czyli identyfikator organizacji to najczęściej adres www organizacji w odwróconej kolejności. Na przykład dla adresu mycompany.com identyfikatorem organizacji będzie com.mycompany. Identyfikator organizacji to drugi element, który jest zastosowany do utworzenia Bundle Identifier.

Bundle Identifier to unikalny identyfikator aplikacji.

Język programowania z ang. Language, to język, w którym aplikacja zostanie oprogramowana.

Dane można potwierdzić klikając w przycisk Next.

W przypadku, gdy żaden zespół deweloperski nie jest widoczny, można go dodać przechodząc do Xcode > Preferences > Accounts > +.

Następnie edytor poprosi o podanie lokalizacji do zapisania projektu. Potwierdzenie wybranej lokalizacji odbywa się za pomocą przycisku Create.

Po chwili, nowy projekt zostanie utworzony.

Informacja: Utworzony projekt oprogramowany będzie w języku Swift w wersji 3.2

Wstępna konfiguracja projektu w Xcode

Nim projekt będzie mógł korzystać z dobrodziejstw Push Notifications, konieczne jest przeprowadzenie konfiguracji wstępnej.

Pierwsza czynność, którą trzeba wykonać to włączenie Push Notifications w możliwościach aplikacji. W tym celu, należy przejść do zakładki Capabilities w ustawieniach głównych projektu.

Następnie suwak znajdujący się na prawo od Push Notifications powinien zostać ustawiony w pozycji On.

Odpowiednie App ID zostanie utworzone w tle, na koncie Apple Developer Program.

Instalacja Firebase SDK

Aby zainstalować Firebase SDK należy otworzyć narzędzie Terminal i przejść do katalogu projektu.

Koniecznym jest wygenerowanie pliku Podfile za pomocą narzędzia Cocoapods.

$ pod init

Następnie należy otworzyć plik Podfile za pomocą Xcode. Inne edytory mogą wprowadzić do pliku swoje znaczniki, co może skutkować jego uszkodzeniem, dlatego edytor Xcode jest rekomendowany.

$ open -a Xcode Podfile

Do pliku Podfile powinny zostać dodany pozycje pod 'Firebase/Core' oraz pod 'Firebase/Messaging'.

Konfigurację należy zapisać i powrócić do narzędzia Terminal. Instalacja Firebase SDK następuje po wykonaniu polecenia pod install.

$ pod install

W przypadku gdy instalacja przebiegła pomyślnie, zostanie wyświetlony rezultat podobny do poniższego.

Aby zależności dla projektu zostały wczytane przez Xcode należy go wyłączyć, a następnie uruchomić ponownie poprzez plik My Product Name.xcworkspace, znajdujący się w katalogu głównym projektu.

W panelu bocznym struktury projektu w Xcode zostanie wyświetlona pozycja Pods, która reprezentuje strukturę plików będących zależnościami projektu.

Generowanie klucza uwierzytelniającego

Klucz uwierzytelniający pozwala na autoryzację aplikacji w Apple Push Notifications Services. Jest to krok konieczny do implementacji Push Notifications w aplikacji iOS.

Na koncie Apple Developer Program należy przejść do sekcji Keys i kliknąć w przycisk +.

Wymaganym jest podanie nazwy klucza weryfikacyjnego i zaznaczenie pozycji APNs. Skrót APNs to w języku angielskim Apple Push Notification service czyli usługi powiadomień push dostarczane przez firmę Apple.

Należy wybrać Continue aby przejść dalej.

Proces tworzenia nowego klucza weryfikującego można zakończyć klikając w Confirm.

Następnie należy pobrać wygenerowany klucz weryfikacyjny.

Informacja: Ze względów bezpieczeństwa, klucz weryfikacyjny może być pobrany tylko raz.

Generowanie profilu Provisioning Profile

Profil Provisioning Profile, w tym przypadku, pozwala na autoryzację urządzeń do uruchomienia aplikacji, która nie została opublikowana w AppStore.

Aby utworzyć nowy Provisioning Profile należy przejść do sekcji Provisioning Profiles na koncie Apple Developer Program i kliknąć w przycisk +.

Informacja: Na potrzeby niniejszego poradnika, wygenerowany profil będzie umożliwiał testowanie aplikacji w środowisku deweloperskim.

Aby wygenerować Provisioning Profile należy zaznaczyć pozycję iOS App Development, a następnie kliknąć w Continue.

Kolejnym krokiem jest wybór odpowiedniego identyfikatora aplikacji z rozwijanej listy i potwierdzenie go za pomocą przycisku Continue.

Na wyświetlonym ekranie należy wybrać certyfikat połączony z kontem w Xcode. W większości przypadków nazwa certyfikatu będzie odpowiadać imieniu i nazwisku użytkownika.

Po przejściu do następnego ekranu, zostanie zaprezentowana lista urządzeń, na których będzie możliwe uruchomienie aplikacji. Należy wybrać odpowiednie urządzenia i potwierdzić wybór klikając w Continue.

Proces tworzenia Provisioning Profile można zakończyć wprowadzając nazwę profilu i potwierdzając przyciskiem Continue.

Instalacja Provisioning Profile

Aby zainstalować profil Provisioning Profile należy w pierwszej kolejności go pobrać.

Instalacja następuje przez dwukrotne kliknięcie w plik profilu. Po zakończeniu procesu instalacji, nastąpi powrót do edytora Xcode.

Konfiguracja projektu w Firebase

W pierwszym kroku konfiguracji projektu w Firebase należy zalogować się do konta Google i przejść do konsoli Firebase Console dostępnej pod adresem https://console.firebase.google.com/.

Aby udostępnić możliwość korzystania z Push Notifications dowolnej aplikacji iOS koniecznym będzie utworzenie nowego projektu.

Następnie należy podać nazwę projektu oraz kraj zamieszkania i potwierdzić dane, klikając w Create Project.

Gdy proces tworzenia nowego projektu zakończy się, chęć kontynuowania należy potwierdzić, klikając w Continue.

Na ekranie głównym projektu koniecznym jest wybranie przycisku iOS.

W oknie, które zostanie wyświetlone należy wprowadzić identyfikator aplikacji Bundle Identifier i wybrać Register App.

Kolejną wymaganą czynnością jest pobranie pliku GoogleService-Info.plist i dodanie go do katalogu głównego projektu.

Plik GoogleService-Info.plist można dodać do projektu przeciągając go z narzędzia Finder do panelu struktury projektu w Xcode.

Potwierdzenie dodania pliku do projektu odbywa się klikając w przycisk Finish.

Plik zostanie wyświetlony w panelu bocznym.

Następnie należy powrócić do Firebase i kliknąć w Skip to the console.

Implementacja klucza weryfikacyjnego w Firebase

W celu implementacji klucza weryfikacyjnego, należy przejść do ustawień projektu w Firebase.

Następnie, koniecznym jest przejście do zakładki Cloud Messaging.

Aby dodać klucz weryfikacyjny, wymagane jest także przejście do sekcji iOS app configuration i kliknięcie w przycisk Upload.

W następnym kroku konieczne będzie wybranie pobranego wcześniej klucza weryfikacyjnego.

Wymagane jest również wprowadzenie identyfikatora klucza Key ID oraz App ID prefix. Identyfikator można znaleźć na koncie Apple Developer Program, po kliknięciu w nazwę klucza w sekcji Keys.

App ID prefix można wyświetlić przechodząc do sekcji App IDs, a następnie klikając na nazwę wybranej aplikacji.

Proces implementacji klucza można potwierdzić klikając w Upload.

Implementacja Push Notifications w projekcie

Ostatnim etapem jest inicjalizacja Firebase w projekcie. W tym celu należy przejść do edytora Xcode i wybrać plik AppDelegate.

Na górze pliku należy dodać poniższy kod.

import UserNotifications
import Firebase

Klasa AppDelegate będzie dostosowana do protokołu UNUserNotificationCenterDelegate oraz MessagingDelegate.

Poniższy kod:

class AppDelegate: UIResponder, UIApplicationDelegate

należy zastąpić:

class AppDelegate: UIResponder, UIApplicationDelegate, UNUserNotificationCenterDelegate, MessagingDelegate

Wewnątrz metody application:didFinishLaunchingWithOptions: koniecznym jest dodanie poniższej treści.

FirebaseApp.configure()

Dodatkowo, w celu rejestracji aplikacji w usłudze Push Notifications, podczas jej startu, wewnątrz metody application:didFinishLaunchingWithOptions: należy również umieścić poniższy kod.

Messaging.messaging().delegate = self
if #available(iOS 10.0, *) {
  UNUserNotificationCenter.current().delegate = self
  let authOptions: UNAuthorizationOptions = [.alert, .badge, .sound]
  UNUserNotificationCenter.current().requestAuthorization(
    options: authOptions,
    completionHandler: {_, _ in })
} else {
  let settings: UIUserNotificationSettings =
  UIUserNotificationSettings(types: [.alert, .badge, .sound], categories: nil)
  application.registerUserNotificationSettings(settings)
}
application.registerForRemoteNotifications()

Wewnątrz klasy AppDelegate należy również dodać poniższą metodę.

func messaging(_ messaging: Messaging, didRefreshRegistrationToken fcmToken: String) {
    debugPrint("Firebase token: \(fcmToken)")
}

Budowanie aplikacji na urządzeniu mobilnym Apple

Aby zbudować aplikację na urządzeniu mobilnym, należy podłączyć je do komputera za pomocą kabla USB, a następnie wybrać je jako Target Device z listy urządzeń.

Informacja: Urządzenie mobline musi być autoryzowane do uruchomienia aplikacji. Innymi słowy, musi to być urządzenie wybrane podczas tworzenia profilu Provisioning Profile.

Proces budowania aplikacji można rozpocząć, klikając w przycisk oznaczony poniżej.

Należy poczekać aż aplikacja zostanie zbudowana.

Informacja: Podczas procesu budowania aplikacji, narzędzie codesign może poprosić o pozwolenie na dostęp do kluczy znajdujących się w pęku kluczy keychain w systemie Mac OS. Należy wprowadzić hasło użytkownika i udzielić zezwolenia, wybierając opcję Always Allow.

Po chwili, aplikacja powinna zostać uruchomiona na urządzeniu mobilnym. Ze względu na brak jakichkolwiek elementów graficznych, powinien zostać wyświetlony biały ekran. Dodatkowo, ze względów bezpieczeństwa, system zapyta o pozwolenie na otrzymywanie powiadomień od aplikacji. Należy
udzielić zgody, wybierając Allow.

Aplikację należy następnie przełączyć w tryb w tle, naciskając przycisk Home na urządzeniu mobilnym.

Wysyłanie powiadomień z Firebase Console

Aby przetestować działanie powiadomień push należy przejść do Firebase Console i wybrać projekt utworzony we wcześniejszych krokach.

Z lewego menu powinna zostać wybrana pozycja Grow > Notifications.

Następnie koniecznym jest wprowadzenie treści powiadomienia oraz wybór aplikacji, do której zostanie ono wysłane. Oznacza to, że powiadomienie będzie dostarczone do wszystkich urządzeń, na których została zainstalowana aplikacja. Dodatkowo powiadomienie można wysłać do subskrybentów danego tematu lub do pojedynczego urządzenia.

Po kliknięciu w SEND MESSAGE, zostanie wyświetlone nowe okno i wymagane będzie potwierdzenie operacji.

Po potwierdzeniu operacji, nastąpi przekierowanie do listy wysłanych wiadomości. Pozycja Status informuje o obecnym stanie procesu wysyłki. Status Completed oznacza, że wiadomość została pomyślnie wysłana na urządzenia mobilne.

W tym samym czasie, na urządzeniu mobilnym powinno pojawić się powiadomienie push.

Wnioski

Po ukończeniu poradnika, uzyskana wiedza powinna pozwolić zainteresowanemu użytkownikowi na pełną implementację Push Notifications w jego aplikacji w wersji deweloperskiej i odbieranie powiadomień z Firebase Console.