スマホアプリ開発を加速する,Firebaseを使ってみよう

第9回 Firebase Cloud MessagingとFirebase Notificationsでメッセージを送信する

この記事を読むのに必要な時間:およそ 9 分

Android クライアントでプッシュ通知を受け取る

Firebase Cloud Messagingの概要とメッセージタイプがわかったところで,実際にAndroidでプッシュ通知を受け取ってNotificationを表示する方法を紹介したいと思います。

セットアップ

AndroidでFirebase Cloud Messagingを利用するにはアプリケーションモジュールのbuild.gradleに次のdependencyを追加するだけです。

dependencies {
    compile 'com.google.firebase:firebase-messaging:9.2.0'
}

Registration Tokenの取得

Firebase Cloud Messagingではメッセージを送信する対象のユーザをRegistration Tokenという識別子で区別します。このRegistration Tokenを指定することであるユーザだけにピンポイントでメッセージを送るといったことが可能になります。

Registration Tokenは前述のセットアップが完了するとアプリインストール時に自動的に生成されるので,ユーザが特に生成コードを呼び出す必要はありません。現在のRegistration Tokenにアクセスするには次のようにします。

String registrationToken = FirebaseInstanceId.getInstance().getToken();
Log.d(TAG, "InstanceID token: " + registrationToken);

実際のアプリケーションでは,自社サービスのユーザ間でメッセージ送り合った際にプッシュ通知で知らせるなど,自社サーバで各ユーザのRegistration Tokenを保持しておいて,API越しにFirebase Cloud Messagingと連携するようなケースが非常に多いと思われます。そのような用途のために,ここで取得したRegistration Tokenを適宜サーバに送るコードを追加すると良いでしょう。

Registration Tokenの更新

Registration Tokenは,アプリの再インストールやアプリケーションキャッシュのクリアなど,いくつかのケースで再生成されることがあります。前述のように自社サーバでRegistration Tokenを保持している場合は,このようなTokenの再生成時に情報を更新する必要があります。

Registration Tokenの更新はFirebaseInstanceIdServiceの継承クラスでonTokenRefresh()メソッドをオーバーライドすることで,更新時に必ずコールバックを受け取ることができます。

import com.google.firebase.iid.FirebaseInstanceId;
import com.google.firebase.iid.FirebaseInstanceIdService;

public class MyFirebaseInstanceIDService extends FirebaseInstanceIdService {
    @Override
    public void onTokenRefresh() {
        String refreshedToken = FirebaseInstanceId.getInstance().getToken();
        Log.d(TAG, "Refreshed token: " + refreshedToken);
    }
}

先ほどの例と同様,新しく取得したRegistration Tokenは適宜自社サーバに送信して利用しましょう。

また,作成したServiceはAndroidManifest.xmlに忘れずに追加するようにしましょう。

<service
    android:name=".MyFirebaseInstanceIDService">
    <intent-filter>
        <action android:name="com.google.firebase.INSTANCE_ID_EVENT"/>
    </intent-filter>
</service>

プッシュ通知のハンドリング

いよいよプッシュ通知を受け取ってNotificationを表示してみたいと思います。

プッシュ通知はFirebaseMessagingServiceの継承クラスで,onMessageReceive()メソッドをオーバーライドすることでハンドリングすることができます。Firebase Cloud MessagingではNotification MessageとData Messageの2つのメッセージタイプがあることを紹介しましたが,それぞれでハンドリング方法が異なるので順番に解説したいと思います。

Notification Messageのハンドリング

Notification Messageを受信したことはRemoteMessage#getNotification()が非null値になることで判別することができます。次のコードをご覧ください。

import com.google.firebase.messaging.FirebaseMessagingService;
import com.google.firebase.messaging.RemoteMessage;

public class MyFirebaseMessagingService extends FirebaseMessagingService {
    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
        Log.d(TAG, "From: " + remoteMessage.getFrom());

        if (remoteMessage.getNotification() != null) {
            Log.d(TAG, "Notification Message");
            String title = remoteMessage.getNotification().getTitle();
            Log.d(TAG, "Notification Message Title: " + title);
            String body = remoteMessage.getNotification().getBody();
            Log.d(TAG, "Notification Message Body: " + body);
        }
    }
}

このように,remoteMessage.getNotification() != nullをチェックしてからremoteMessage.getNotification().getTitle()でタイトルを,remoteMessage.getNotification().getBody()で本文を取り出しています。

Data Messageのハンドリング

Data Messageを受信したことはRemoteMessage#getData()が非null値になることで判別することができます。次のコードをご覧ください。

import com.google.firebase.messaging.FirebaseMessagingService;
import com.google.firebase.messaging.RemoteMessage;
import java.util.Map;

public class MyFirebaseMessagingService extends FirebaseMessagingService {
    @Override
    public void onMessageReceived(RemoteMessage remoteMessage) {
        Log.d(TAG, "From: " + remoteMessage.getFrom());

        if (remoteMessage.getData() != null) {
            Log.d(TAG, "Data Message");
            Map<String, String> data = remoteMessage.getData();
            String customTitle = data.get("custom_title");
            Log.d(TAG, "Notification Message Title: " + customTitle);
            String customBody = data.get("custom_body");
            Log.d(TAG, "Notification Message Body: " + customBody);
        }
    }
}

こちらも同様にremoteMessage.getData() != nullをチェックしてからremoteMessage.getData()Map<String, String>を取り出して利用しています。Data Messageは任意のキーバリューペアを指定できるので,キーは間違いなく存在するものを指定する必要があるので注意が必要です。

なお,このServiceも忘れずにAndroidManifest.xmlに追加するようにしましょう。

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

著者プロフィール

白山文彦(しろやまふみひこ)

サーバサイド,インフラ,Androidなど何でもやるプログラマ。