Hogyan kaphat push értesítéseket az Ionic 4 és a Firebase használatával

Teljes körű lépésről lépésre bemutató oktatóprogram, amely jó úton halad az iOS és az Android számára

A push értesítések beállítása valóban frusztráló és időigényes lehet. Végigvettem az összes beállítást, és elkészítettem neked ezt az oktatóanyagot.

Előfeltétel

Az Ionic 4-et már telepíteni kell.

Szakasz navigáció

  1. Csomag telepítése
  2. Firebase beállítása Android és iOS rendszerhez
  3. Nyomja meg az értesítési kód megvalósítását
  4. Tesztelje a push értesítéseket Androidon
  5. iOS push értesítések előbeállítása
  6. Tesztelje a push értesítéseket iOS rendszeren

1. A csomag telepítése

Nyissa meg az Ionic projektjét a választott kódoló szerkesztőben, és nyissa meg a terminálját is. Navigáljon a projekt mappájához.

Először telepítjük az összes szükséges csomagot.

Mit kell telepítenünk:

  • Cordova plugin a firebase számára:ionic cordova plugin add cordova-plugin-firebase
  • Firebase natív csomag: mivel az Ionic 4 bétaverzióban van, ellenőrizze az Ionic-native csomagokat, package.json és telepítse ugyanazt a verziót, mint a többi Ionic-native csomagokat. Végül írjuk be:npm install --save @ionic-native/[email protected]
  • Egy utolsó csomag, az AngularFire 2 . Ez az Angular és a Firebase könyvtár:npm install --save angularfire2 firebase

A csomagok telepítve vannak, kész! Térjünk át a második szakaszra.

2. Firebase beállítása iOS és Android rendszerhez

Mielőtt elkezdenénk az összes beállítást, figyelmeztetnem kell, hogy nem tesztelheti a push értesítéseket az iOS emulátoron. A teszteléshez rendelkeznie kell egy Apple Developer számlával, amelynek költsége körülbelül 99 USD / év. Azt javaslom, hogy mindenképp hajtsa végre az iOS telepítését, így jobban megismerheti a jövőbeni projekteket.

Megjegyzés: Az itt kezdődő lépések nagyon fontosak, ezért kérjük, legyen türelmes. Olvassa el lassan, és győződjön meg róla, hogy minden rendben van. A problémák keresése a telepítés után is nagyon frusztráló lehet, bízz bennem - saját tapasztalataim szerint beszélek.

iOS

Keresse meg a Firebase oldalt, és jelentkezzen be egy konzolra. Ha még nincs létrehozva projekt, akkor most tegye meg. Látnia kell ezt a képernyőt.

Kattintson az iOS gombra, és ezt látja:

Most meg kell adnunk az iOS csomag-azonosítónkat, és ennek meg kell egyeznie az ionos projektjével. Tegyük fel, hogy szeretném a csomag nevét com.filipjerga.angularcourse, majd a következőket kell tennem:

Nyissa meg az Ionic projekteket, és keresse meg a „config.xml” fájlt. Vizsgáljuk meg a widget elemet. Az Id attribútum az alkalmazás egyedi azonosítóját tartalmazza . Korábban mondtam, ha com.filipjerga.angularcoursea Firebase-ben megadta a csomag nevét , akkor az Ionic projekt azonosítójának meg kell egyeznie! Hagyhatja az azonosítót is, amint az már van az Ionic projektjén, de akkor meg kell változtatnia a Firebase-ben.

Miután megkapta az id értékét , ne felejtse el megadni a Firebase alkalmazásnak csomagazonosítóként.

Ez legyen minden az alkalmazás regisztrációjának első lépésében. Ez a lépés kulcsfontosságú, ezért ellenőrizze még egyszer a Firebase alkalmazás widgetjén található azonosító értékét és a csomag azonosítóját .

Hagyja üresen a többi mezőt, és kattintson az „Alkalmazás regisztrálása” gombra.

Most le kell töltenünk a „GoogleService-Info.plist” fájlt.

Amikor letöltötte, illessze be a projektek alapmappájába. Itt láthat egy mappastruktúrát a projektemben.

Az összes további lépést kihagyhatjuk, mivel ezekre nincs szükség az Ionic projekt beállításához. Készen kell állnia az IOS alkalmazásra.

Android

A következő lépések az Android esetében szinte megegyeznek az iOS telepítésével:

  • Kattintson az „alkalmazás hozzáadása” elemre Androidhoz, ugyanúgy, mint korábban az iOS-ben.
  • Az Android-csomag nevének meg kell egyeznie a widget-azonosítóval, esetemben: com.filipjerga.angularcourse
  • Ezután töltse le google-services.json. Ugyanúgy, mint korábban az iOS fájlnál, át kell másolnunk az alkalmazások alapmappájába
  • Kattintson a „Tovább” gombra, amíg az utolsó lépésbe nem lép, amelyet átugorhat, és végül mindkét alkalmazás létrejön.

Hurrá! Gratula! De még mindig korai szurkolni.

3. Nyomja meg az értesítési kód megvalósítását

Csomag importálása

Eljött az idő, hogy végre felmelegítsük ujjainkat egy kód beírásával. A korábban telepített csomagok importálásával kezdjük.

  1. Menj app.module.ts
  2. A fájljának így kell kinéznie:
import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { RouterModule, RouteReuseStrategy } from '@angular/router'; import { IonicModule, IonicRouteStrategy } from '@ionic/angular'; import { SplashScreen } from '@ionic-native/splash-screen/ngx'; import { StatusBar } from '@ionic-native/status-bar/ngx'; import { AppRoutingModule } from './app-routing.module'; import { AppComponent } from './app.component'; import { AngularFireModule } from 'angularfire2'; import { AngularFirestoreModule } from 'angularfire2/firestore'; import { Firebase } from '@ionic-native/firebase/ngx'; const config = { apiKey: "AIzaSyD-K6SlFECXKmd8iHwEvggVtavKgyPF2k8", authDomain: "angular2-course-9270e.firebaseapp.com", databaseURL: "//angular2-course-9270e.firebaseio.com", projectId: "angular2-course-9270e", storageBucket: "angular2-course-9270e.appspot.com", messagingSenderId: "443316848633" }; @NgModule({ declarations: [AppComponent], entryComponents: [], imports: [ BrowserModule, IonicModule.forRoot(), AppRoutingModule, IonicStorageModule.forRoot(), AngularFireModule.initializeApp(config), AngularFirestoreModule], providers: [ StatusBar, SplashScreen, Firebase, { provide: RouteReuseStrategy, useClass: IonicRouteStrategy } ], bootstrap: [AppComponent] }) export class AppModule {}

Láthatja Firebasea szolgáltató tömbben AngularFirestoreModuleés AngularFireModuleaz importálásban.

De honnan jött a configtárgy? Sok információt láthat ott „apiKey, authDomain” és így tovább.

To answer this we need go back to our Firebase console and create a web app.

You need to click on a web platform icon on the right from the Android icon (see the image above). When the web app is selected you will be presented with your own config object.

Now it’s time to copy whole config object to app.module.ts in our Ionic projects. Please make sure you change it for your config object! Mine will not work for you.

Now we can start working on the implementation of the push notification service.

Push notification service

Let’s create a new service. Call it what you like. I will call mine fcm.service.ts. FCM stands for Firebase Cloud Messaging.

First, let’s take a look at the service implementation. I will explain it line by line.

import { Injectable } from '@angular/core'; import { Firebase } from '@ionic-native/firebase/ngx'; import { Platform } from '@ionic/angular'; import { AngularFirestore } from 'angularfire2/firestore'; @Injectable() export class FcmService { constructor(private firebase: Firebase, private afs: AngularFirestore, private platform: Platform) {} async getToken() { let token; if (this.platform.is('android')) { token = await this.firebase.getToken(); } if (this.platform.is('ios')) { token = await this.firebase.getToken(); await this.firebase.grantPermission(); } this.saveToken(token); } private saveToken(token) { if (!token) return; const devicesRef = this.afs.collection('devices'); const data = { token, userId: 'testUserId' }; return devicesRef.doc(token).set(data); } onNotifications() { return this.firebase.onNotificationOpen(); } }

If we want to send a push notification to a device, we need to get an unique identifier of the device. In this case it’s called a token.

We need to check for a platform specific device, because of an additional step in the iOS setup. iOS requires explicit permissions to receive push notifications.

Now we need to store this token somewhere, but where? We will store tokens in the Firebase database. You can see, I am creating device collections and I am filling them with datathat contains the token and just a testing UserId. Perfect! Now, we have stored our token and we can subscribe to notifications.

Subscribing to notifications is actually very simple. We just need to call this.firebase.onNotificationOpen()

Amazing. Service checked!

All of this is nice but kinda useless, since we are not using our service yet. Let’s fix it!

Move to your app.component.tsand write the following:

import { Component } from '@angular/core'; import { Platform } from '@ionic/angular'; import { SplashScreen } from '@ionic-native/splash-screen/ngx'; import { StatusBar } from '@ionic-native/status-bar/ngx'; import { FcmService } from './shared/service/fcm.service'; import { ToastService } from './shared/service/toast.service'; import { ToastController } from '@ionic/angular'; @Component({ selector: 'app-root', templateUrl: 'app.component.html' }) export class AppComponent { constructor( private platform: Platform, private splashScreen: SplashScreen, private statusBar: StatusBar, private fcm: FcmService, private toastr: ToastService, public toastController: ToastController ) { this.initializeApp(); } private async presentToast(message) { const toast = await this.toastController.create({ message, duration: 3000 }); toast.present(); } private notificationSetup() { this.fcm.getToken(); this.fcm.onNotifications().subscribe( (msg) => { if (this.platform.is('ios')) { this.presentToast(msg.aps.alert); } else { this.presentToast(msg.body); } }); } initializeApp() { this.platform.ready().then(() => { this.statusBar.styleDefault(); this.splashScreen.hide(); this.notificationSetup(); }); } }

Especially important here is the function notificationSetup.

We are getting an unique token of the device first.

We are also subscribing to incoming notifications from Firebase.

When the message is received, we need to check, again, for specific platforms. On iOS your message text is under aps.alert . On Android it’s under body.

Then we will just simply display the received message as a Toast.

Now the code setup is done. We are getting very close! It’s time to test it out.

4. Test push notifications on Android

All of the required setup for Android should be done right now. You can start emulating your app by:

ionic cordova emulate android

or

ionic cordova build android and open your build manually in Android Studio.

Let’s launch our applications and go to a Home menu, so we will see a push notification there. Make sure your application was launched properly in emulator and you have no errors.

Go back to your browsers to your Firebase Applications. Now it’s time to inspect our Firebase Database. You can find the database option in the left panel under the Develop category.

After your application was launched in emulators, the code from app.component.ts we wrote a few moments ago ran. No wonder our database is populated. In the “saveToken” function we specified the “devices” collection and we saved the token with the user id as a document into this devices collection. That is what we see in our database.

In my case, I have multiple tokens in my database but you should have only one since we’ve run our app the first time. You will create a new document per unique device/emulator you are running your app on.

Now it’s time to copy this token in order to send push notification to a specific device.

Navigate to the left panel to a grow tab and click on cloud messaging.

Now we need to fill in the necessary data. Enter the text of your message and provide the token of the device from the database we just copied.

When you are sending a message, open your emulated device simultaneously and watch what happens.

Send a message, aaaaand Congrats! Now your Android setup is done and you are able to send push notifications! Isn’t that awesome?

5. iOS push notification pre-setup

Buckle up guys, iOs setup is coming. Let’s separate this setup into multiple steps, so we will not have a panic attack. Let’s dig in!

First, build your application for iOS: ionic cordova build ios

Open your Xcode, and find your built app in platforms/ios/nameofyourapp.xcodeproj . Open it.

This should open a tree structure of your application on the left side. Double Click the root file of this structure. This will open an additional menu with more settings for your app.

Sign in with your developer account.

5. Open the top “Capabilities” tab and enable “Push Notifications”.

6. Navigate to your Apple developer account page. Under “Certificates” select “All” and click "+" to add a new certificate.

Enable the Apple Push Notification service and proceed to the next step.

Now let’s choose your application.

We need to request a certificate. On your Mac, go to “Keychain Access” -> “Certificate Assistant” -> “Request a Certificate From a Certificate Authority”.

Complete all the necessary information — your email and common name — and save it to disk.

In the Apple Console proceed to the next step and upload your certificate request.

In the next step your certificate should be created and you can download it. You will need it later.

Now we need to create a service key to enable Apple push notifications. Under “Keys” select “All” . Choose your key name. Enable “Apple Push Notifications service (APNs)”.

Click “Continue” and confirm your key. Never share such data with others. You can now download your key.

Now we need to go back to Firebase.

In Firebase, open your iOS application and navigate to “Cloud Messaging”.

We need to upload our APN Authentication Key we generated a while ago. Click “Upload”.

Provide all the information and upload the key.

First, upload your “.p8” file, downloaded from the Apple console earlier. Enter your Key ID. You can get the App ID prefix from the Apple console in “Identifiers”->“App IDs”->“Your App”->“Prefix”.

That’s it. Tears of joy are running down my face.

We can test Push Notifications on iOS. Let’s not forget we need to use a real device.

6. Test push notification on iOS

First, we need to build our applications so let’s run: ionic cordova build ios

In Xcode you can run your application on a device connected by USB with your computer.

Let’s wait until everything is launched. We can now repeat the steps to send push notifications from Section 4, because it is the same as on Android.

Remember that you need to use a new token now, that was generated for your iOS device. Go to Databases, get a new token, and send a push notification. Your result should look like this.

I hope you have been successful with setting up your push notifications. It takes some time and patience to get everything right, but the outcome and benefits are amazing.

If you like my tutorial and you are interested in more, you can check out my course on Udemy: Ionic 4 Crash Course with Heartstone API and Angular.

For a full project see my Github Repo.

Happy Coding!

Filip