Implement Firebase Cloud Messaging in your Android app (2)-Receive messages in your app

I wrote about how to use Firebase Cloud Messaging to introduce push notifications to your Android app. In this entry, I write the code necessary to actually receive the notification and summarize the process until receiving the notification.

FCM message type

There are two types of FCM messages: For more information, please see here.

There are two main differences between the two.

• The JSON format used for sending messages is different
• The behavior when receiving a message in the app is different

The behavior of the app when receiving a message is as follows. In the case where "onMessageReceived" is written, [onMessageReceived method of service inheriting FirebaseMessagingService class](https://firebase.google.com/docs/reference/android/com/google/firebase/messaging/FirebaseMessagingService.html #onMessageReceived (com.google.firebase.messaging.RemoteMessage)) is called.

Notification messages can also include data. Please refer to here for the case of using both together.

Prerequisites

Firebase has been added to your Android project. Please check Previous entry for how to add.

environment

It is carried out using the following environment.

• macOS Mojave version 10.14.5
• Android Studio 3.4.1
• Nexus5X + Android7.1.2
• Pixel3a + Android9

Implementation

Service definition

Create a service that inherits from FirebaseMessagingService. This service implements the following two methods (there are other methods that can be implemented, but they are omitted here).

I implemented each method. Normally, when the token is updated, processing such as saving it on the server is necessary, but here we only log it.

MyFirebaseMessagingService.java

public class MyFirebaseMessagingService extends FirebaseMessagingService {
    @Override
    public void onNewToken(String token) {
        //Get a token to uniquely identify the device + app
        Log.i("FIREBASE", "[SERVICE] Token = " + token);
    }

    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
        if (remoteMessage != null) {
            //Notification message
            RemoteMessage.Notification notification = remoteMessage.getNotification();
            if (notification != null) {
                //Handle notification messages
            }

            //Data message
            Map<String, String> data = remoteMessage.getData();
            if (data != null) {
                //Process data messages
            }
        }
    }
}

MyFirebaseMessagingService.kt

class MyFirebaseMessagingService : FirebaseMessagingService() {
    override fun onNewToken(token: String?) {
        //Get a token to uniquely identify the device + app
        Log.i("FIREBASE", "[SERVICE] Token = ${token ?: "Empty"}")
    }

    override fun onMessageReceived(remoteMessage: RemoteMessage?) {
        remoteMessage?.let { message ->
            //Notification message
            message.notification?.let {
                //Handle notification messages
            }

            //Data message
            message.data?.let {
                //Process data messages
            }
        }
    }
}

Register the created service in AndroidManifest.xml.

AndroidManifest.xml

<service
        android:name=".MyFirebaseMessagingService"
        android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT"/>
    </intent-filter>
</service>

Check the latest token

"Terminal registration token" (hereinafter "token") is a character string for uniquely identifying the combination of terminal + application. Use this to send a message to your app. The token may be updated ** due to user circumstances or server side circumstances **. It is recommended to always get the latest token, so I think it is appropriate to implement it so that it is confirmed when the application starts. The code to get the token is below.

Get token(Java)

FirebaseInstanceId.getInstance().getInstanceId().addOnCompleteListener((task) -> {
    if (!task.isSuccessful()) {
        Log.w("FIREBASE", "getInstanceId failed.", task.getException());
        return;
    }

    String token = (task.getResult() == null) ? "empty" : task.getResult().getToken();
    Log.i("FIREBASE", "[CALLBACK] Token = " + token);
});

Get token(Kotlin)

FirebaseInstanceId.getInstance().instanceId.addOnCompleteListener { task ->
    if (!task.isSuccessful) {
        Log.w("FIREBASE", "getInstanceId failed", task.exception)
        return@addOnCompleteListener
    }

    Log.i("FIREBASE", "[CALLBACK] Token = ${task.result?.token}")
}

Receive FCM messages

When a message is received, onMessageReceived (RemoteMessage) implemented in a subclass of FirebaseMessagingService is called. In it, you define the logic of how to parse and handle the message. The sample code in the "Service Definition" section corresponds to each notification message and data message. please confirm.

Send FCM message

At this point, you are ready to receive the message. You can send a message with the Firebase console or an HTTP request, so give it a try.

a. Send from console

To send a notification message, log in to the Firebase console, open the desired project, and go to "Cloud Messaging". Click Send your first message.

• Enter an appropriate character string in "Notification title" and "Notification text".
• Enter the application ID in "Target".

If it is the second time or later, the messages sent so far are listed. Click "New Notification" at the top left of the screen to send a new message. You can also duplicate an existing message.

b. Send using cURL

Then use cURL to send both the notification message and the data message. I will omit how to install and use cURL.

Check the server key. Click the gear-shaped setting icon ① on the Firebase console to open the screen. On the setting screen, click the "Cloud Messaging" tab ②. "Server key" ③ will be displayed, so make a copy of it.

The following is an example of a command that sends a data message.

SERVER_KEY=(Server key)
TARGET_TOKEN=(token)

curl -X POST -H "Content-Type:application/json" \
     -H "Authorization:key=$SERVER_KEY" \
     -d "{\"data\":{\"name\" : \"Taro Nihon\",\"age\" : \"20\",\"address\" : \"Tokyo\"},\"to\" : \"$TARGET_TOKEN\"}" \
     https://fcm.googleapis.com/fcm/send

Summary

I wrote from writing the code to receiving the message. We've created an FCM message with minimal content here, but you can include a variety of other information such as expiration dates and priorities. Please refer to the following and try various implementations.

• Check here (https://firebase.google.com/docs/cloud-messaging/concept-options) for more information on FCM messages, including the differences between notification and data messages.
• You can check the contents that can be defined in JSON at the time of sending in Reference.

Revision history

• 2019/05/24
• The operation / verification environment has been changed.
• Fixed Java code.
• Added Kotlin code.
• FirebaseInstanceIdService was deprecated, so I removed the description.
• All screenshots have been retaken.