Android アプリでメッセージを受信する

Firebase Notifications は、受信側アプリがフォアグラウンド状態であるかバックグラウンド状態であるかによって、動作が異なります。フォアグラウンドアプリで通知メッセージまたはデータメッセージを受信する場合は、onMessageReceived コールバックを処理するコードを記述する必要があります。通知メッセージとデータメッセージの違いの説明については、メッセージのタイプをご覧ください。

メッセージの処理

メッセージを受信するには、FirebaseMessagingService を拡張したサービスを使用します。このサービスは onMessageReceived コールバックと onDeletedMessages コールバックをオーバーライドする必要があります。

onMessageReceived は次の例外を除いて、ほとんどのメッセージタイプに提供されます。

アプリがバックグラウンドで動作しているときに配信された通知メッセージ。この場合、通知はデバイスのシステムトレイに配信されます。ユーザーが通知をタップすると、デフォルトでアプリランチャーが開きます。
バックグラウンドで受信されたときに通知とデータペイロードの両方を持つメッセージ。この場合、通知はデバイスのシステムトレイに配信され、データペイロードはランチャーアクティビティのインテントの追加部分に配信されます。

要約:

アプリの状態	通知	データ	両方
フォアグラウンド	`onMessageReceived`	`onMessageReceived`	`onMessageReceived`
バックグラウンド	システムトレイ	`onMessageReceived`	通知: システムトレイデータ: インテントの追加部分内

メッセージタイプの詳細については、通知とデータメッセージをご覧ください。

onMessageReceived コールバックには、通知を簡単に送信できるようにするタイムアウトが指定されていますが、このタイマーはアプリがネットワークにアクセスしたり、追加の作業を行ったりすることを想定していません。したがって、アプリでより複雑な処理を行う場合は、アプリが確実に処理を完了できるよう、追加の対応が必要となります。

アプリでのメッセージの処理に 10 秒近くかかる可能性がある場合は、WorkManager ジョブをスケジュール設定するか、下記の WakeLock のガイダンスに沿って対応する必要があります。場合によっては、メッセージを処理するための時間枠は、onMessageReceived の呼び出しに先立って発生する遅延（OS の遅延、アプリの起動時間、他のオペレーションによってブロックされているメインスレッド、または onMessageReceived の呼び出し時間がかかりすぎるなど）に応じて 10 秒より短くなる場合があります。タイマーが切れると、アプリはプロセス強制終了またはバックグラウンド実行制限の対象となる可能性があります。ネットワークトランザクションやアプリの起動のレイテンシは大きくなる可能性があるため、ネットワークアクセスや大量のデータ読み込みの要件といった非同期の依存関係がある場合は、メッセージ処理に時間がかかることを想定して計画を立ててください。

アプリマニフェストの編集

FirebaseMessagingService を使用するには、アプリマニフェストに次の設定を追加する必要があります。

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

通知のデザインをカスタマイズするためのデフォルト値を設定することもおすすめします。通知ペイロード内にアイコンやカラーの値が設定されていない場合に適用される、カスタムデフォルトアイコンとカスタムデフォルトカラーを指定できます。

カスタムデフォルトアイコンとカスタムカラーを設定するには、次の行を application タグに追加します。

<!-- Set custom default icon. This is used when no icon is set for incoming notification messages.
     See README(https://goo.gl/l4GJaQ) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_icon"
    android:resource="@drawable/ic_stat_ic_notification" />
<!-- Set color used with incoming notification messages. This is used when no color is set for the incoming
     notification message. See README(https://goo.gl/6BKBk7) for more. -->
<meta-data
    android:name="com.google.firebase.messaging.default_notification_color"
    android:resource="@color/colorAccent" />AndroidManifest.xml

Android では、以下に対してカスタムデフォルトアイコンが表示されます。

Notifications Composer から送信されたすべての通知メッセージ。
通知ペイロード内にアイコンが明示的に設定されていない通知メッセージ。

Android では、以下に対してカスタムデフォルトカラーが使用されます。

Notifications Composer から送信されたすべての通知メッセージ。
通知ペイロード内にカラーが明示的に設定されていない通知メッセージ。

カスタムデフォルトアイコンが設定されず、通知ペイロード内にもアイコンが設定されていない場合は、Android では白色でレンダリングされたアプリケーションアイコンが表示されます。

`onMessageReceived` のオーバーライド

FirebaseMessagingService.onMessageReceived メソッドをオーバーライドすると、受信した RemoteMessage オブジェクトに基づいてアクションを実行し、メッセージデータを取得できます。

Kotlin

override fun onMessageReceived(remoteMessage: RemoteMessage) {
    // TODO(developer): Handle FCM messages here.
    // Not getting messages here? See why this may be: https://goo.gl/39bRNJ
    Log.d(TAG, "From: ${remoteMessage.from}")

    // Check if message contains a data payload.
    if (remoteMessage.data.isNotEmpty()) {
        Log.d(TAG, "Message data payload: ${remoteMessage.data}")

        // Check if data needs to be processed by long running job
        if (needsToBeScheduled()) {
            // For long-running tasks (10 seconds or more) use WorkManager.
            scheduleJob()
        } else {
            // Handle message within 10 seconds
            handleNow()
        }
    }

    // Check if message contains a notification payload.
    remoteMessage.notification?.let {
        Log.d(TAG, "Message Notification Body: ${it.body}")
    }

    // Also if you intend on generating your own notifications as a result of a received FCM
    // message, here is where that should be initiated. See sendNotification method below.
}MyFirebaseMessagingService.kt

Java

@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
    // TODO(developer): Handle FCM messages here.
    // Not getting messages here? See why this may be: https://goo.gl/39bRNJ
    Log.d(TAG, "From: " + remoteMessage.getFrom());

    // Check if message contains a data payload.
    if (remoteMessage.getData().size() > 0) {
        Log.d(TAG, "Message data payload: " + remoteMessage.getData());

        if (/* Check if data needs to be processed by long running job */ true) {
            // For long-running tasks (10 seconds or more) use WorkManager.
            scheduleJob();
        } else {
            // Handle message within 10 seconds
            handleNow();
        }

    }

    // Check if message contains a notification payload.
    if (remoteMessage.getNotification() != null) {
        Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody());
    }

    // Also if you intend on generating your own notifications as a result of a received FCM
    // message, here is where that should be initiated. See sendNotification method below.
}MyFirebaseMessagingService.java

FCM メッセージの処理中にデバイスの起動状態を維持する

FCM メッセージの処理中にデバイスを起動状態に保つ必要があるアプリは、この間 WakeLock を保持するか、WorkManager ジョブを作成する必要があります。WakeLock は、onMessageReceived のデフォルトのタイムアウトを超える可能性のある短い処理アクティビティに適しています。サーバーに複数のシリアル RPC を送信するといった拡張ワークフローでは、WakeLock よりも WorkManager ジョブを使用する方が適しています。このセクションでは、WakeLock の使用方法について説明します。WakeLock は、アプリの実行中にデバイスがスリープ状態になるのを防ぎます。これにより、バッテリーの使用量が増える可能性があるため、WakeLock の使用は、メッセージの処理中にアプリを一時停止すべきでない場合に限定する必要があります。たとえば、次のような場合です。

時間的制約のあるユーザーへの通知。
デバイス外とのインタラクションで中断すべきでないもの（ネットワーク転送や、ペア設定されたスマートウォッチなどの別のデバイスとの通信など）。

まず、アプリが WakeLock 権限をリクエストしていることを確認する必要があります（FCM SDK にはデフォルトで含まれているため、通常は何も追加する必要はありません）。

<uses-permission android:name="android.permission.WAKE_LOCK" />

アプリは、FirebaseMessagingService.onMessageReceived() コールバックの開始時に WakeLock を取得し、コールバックの終了時に解放する必要があります。

アプリのカスタム FirebaseMessagingService:

@Override
public void onMessageReceived(final RemoteMessage message) {
  // If this is a message that is time sensitive or shouldn't be interrupted
  WakeLock wakeLock = getSystemService(PowerManager.class).newWakeLock(PARTIAL_WAKE_LOCK, "myApp:messageReceived");
  try {
    wakeLock.acquire(TIMEOUT_MS);
    // handle message
    ...
  finally {
    wakeLock.release();
  }
}

`onDeletedMessages` のオーバーライド

状況によっては、FCM からメッセージが配信されないことがあります。これは、特定のデバイスが接続されたときにそのデバイスにまだ配信されていないアプリのメッセージが多すぎる（100 件を超えている）場合や、デバイスが 1 か月以上 FCM に接続されていない場合に起こります。このような場合、FirebaseMessagingService.onDeletedMessages() へのコールバックを受け取ることがあります。アプリインスタンスがこのコールバックを受け取った場合は、アプリサーバーとの完全な同期を実行する必要があります。過去 4 週間以内にそのデバイスのアプリにメッセージを送信していない場合、FCM はonDeletedMessages()を呼び出しません。

バックグラウンドアプリの通知メッセージの処理

アプリがバックグラウンドで動作しているとき、Android ではシステムトレイに通知メッセージが送られます。ユーザーが通知をタップすると、デフォルトでアプリランチャーが開きます。

通知とデータペイロードの両方を含むメッセージ（および Notifications コンソールから送信されたすべてのメッセージ）がここに含まれます。この場合、通知はデバイスのシステムトレイに配信され、データペイロードはランチャーアクティビティのインテントの追加部分に配信されます。

アプリへのメッセージ配信については、FCM レポートダッシュボードをご覧ください。このダッシュボードには、Android アプリの「インプレッション」（ユーザーが表示した通知）のデータとともに、Apple と Android のデバイスで送信および開封されたメッセージの数が記録されています。

ダイレクトブートモードで FCM メッセージを受信する

デバイスのロックが解除される前にアプリに FCM メッセージを送信したい場合は、デバイスがダイレクトブートモードのときにメッセージを受信するように Android アプリを設定できます。たとえば、ロックされたデバイスでも、アラーム通知がアプリのユーザーに届くようにしたい場合があるかもしれません。

このユースケースを構築する場合は、ダイレクトブートモードに関する一般的なベストプラクティスと制限事項を遵守してください。ダイレクトブートに対応したメッセージの可視性を考慮することが特に重要です。デバイスにアクセスできるユーザーであれば、ユーザーの認証情報を入力しなくてもこれらのメッセージを見ることができるためです。

前提条件

デバイスをダイレクトブートモードに設定する必要があります。
デバイスに Google Play 開発者サービスの新しいバージョン（19.0.54 以降）がインストールされている必要があります。
アプリは FCM SDK（com.google.firebase:firebase-messaging）を使用して FCM メッセージを受信する必要があります。

アプリでダイレクトブートモードのメッセージ処理を有効にする

アプリレベルの Gradle ファイルで、FCM ダイレクトブートサポートライブラリの依存関係を追加します。
```
implementation 'com.google.firebase:firebase-messaging-directboot:20.2.0'
```

アプリマニフェストで android:directBootAware="true" 属性を追加して、アプリの FirebaseMessagingService をダイレクトブート対応にします。

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

この FirebaseMessagingService をダイレクトブートモードで実行できるようにすることが重要です。次の要件を確認してください。

ダイレクトブートモードでの実行中、サービスは認証情報で保護されたストレージにアクセスできません。
ダイレクトブートモードでの実行中、サービスはダイレクトブート対応として指定されていない Activities、BroadcastReceivers、Services などのコンポーネントを使用できません。
ダイレクトブートモードでの実行中、サービスで使用するライブラリは、認証情報で保護されたストレージにアクセスしたり、ダイレクトブートに対応しないコンポーネントを呼び出したりすることはできません。つまり、アプリが使用し、サービスから呼び出されるライブラリは、ダイレクトブート対応である必要があります。ダイレクトブート対応でないライブラリについては、アプリは現在実行中のモードを確認し、ダイレクトブートモードで実行中の場合はそれらのライブラリを呼び出さないようにする必要があります。たとえば、Firebase SDK はダイレクトブートで動作しますが（アプリに含めてもダイレクトブートモードでアプリのクラッシュを発生させることはありません）、多くの Firebase API はダイレクトブートモードでの呼び出しに対応していません。
アプリでカスタムの Application を使用している場合は、Application もダイレクトブート対応である必要があります（ダイレクトブートモードでは認証情報で保護されたストレージにアクセスできません）。

ダイレクトブートモードのデバイスにメッセージを送信する場合のガイダンスについては、ダイレクトブート対応のメッセージを送信するをご覧ください。

Android アプリでメッセージを受信する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

メッセージの処理

アプリ マニフェストの編集

onMessageReceived のオーバーライド