Memo

メモ > 技術 > サービス: AmazonSNS > Android: アプリにPush通知受信機能を実装
Android: アプリにPush通知受信機能を実装
■app/build.gradledependencies {
    〜略〜
    implementation("com.google.firebase:firebase-analytics")
    implementation("com.google.firebase:firebase-messaging")		… 追加


「firebase-messaging」の最新バージョンは以下で確認できるが、今は常に「com.google.firebase:firebase-messaging-ktx」で問題無さそう。（バージョン情報以外にも、参考にできそうな情報がある。）
ただし2024年10月時点で確認すると、デフォルトで「com.google.firebase:firebase-analytics-ktx」ではなく「com.google.firebase:firebase-analytics」が使われるようになっている。
これに合わせて、今回は「com.google.firebase:firebase-messaging-ktx」ではなく「com.google.firebase:firebase-messaging」にしている。

Android プロジェクトに Firebase を追加する | Firebase for Android
https://firebase.google.com/docs/android/setup?hl=ja

追加したら、AndroidStudioの画面上部に「sync now」が表示されるのでクリックする。
念のため、この時点でアプリを起動できることを確認しておく。

■res/drawable/ic_notification.webp

プッシュ通知用のアイコンを作成する。
今回は res/mipmap-mdpi/ic_launcher.webp を複製して名前を変更した。

★アイコンの形式やサイズについて、何が適切かは確認しておきたい。
  また、アプリが起動中でもそうでなくても、プッシュ通知にアイコンが反映されるか確認する。

■res/values/colors.xml<?xml version="1.0" encoding="utf-8"?>
<resources>
    〜略〜
    <color name="notification">#AAAAAA</color>				… 追加
</resources>


※この色指定は必須のものか。
  テキスト色を指定していないので、「ダークモードで表示されない」などは無いか。
  省略してデフォルトの色を使ってくれるなら、それが良さそうだが。
  …と思ったが、このアイコンと色の指定は、上記のとおりデフォルト値として指定しておくことが推奨されるらしい。
    詳細は以下の記事を参照。

Android アプリでメッセージを受信する | Firebase Cloud Messaging
https://firebase.google.com/docs/cloud-messaging/android/receive?hl=ja

> 通知のデザインをカスタマイズするためのデフォルト値を設定することもおすすめします
> 通知ペイロード内にアイコンやカラーの値が設定されていない場合に適用される、カスタム デフォルト アイコンとカスタム デフォルト カラーを指定できます。
> 
> Android では、以下に対してカスタム デフォルト アイコンが表示されます。
> ・Notifications Composer から送信されたすべての通知メッセージ。
> ・通知ペイロード内にアイコンが明示的に設定されていない通知メッセージ。
> 
> Android では、以下に対してカスタム デフォルト カラーが使用されます。
> ・Notifications Composer から送信されたすべての通知メッセージ。
> ・通知ペイロード内にカラーが明示的に設定されていない通知メッセージ。

■app\src\main\AndroidManifest.xml    <uses-permission android:name="android.permission.POST_NOTIFICATIONS" />		… Android13用に追加

    <application
        android:allowBackup="true"
        〜略〜
        tools:targetApi="31">

        <meta-data									… ブロックを追加
            android:name="com.google.firebase.messaging.default_notification_icon"
            android:resource="@drawable/ic_notification" />
        <meta-data
            android:name="com.google.firebase.messaging.default_notification_color"
            android:resource="@color/notification" />

        <service									… ブロックを追加
            android:name=".MyFirebaseMessagingService"
            android:exported="true">
            <intent-filter>
                <action android:name="com.google.firebase.MESSAGING_EVENT" />
            </intent-filter>
        </service>

        <activity
            android:name=".MainActivity"
■app\src\main\java\net\refirio\pushtest1\MyFirebaseMessagingService.ktpackage net.refirio.pushtest1

import android.app.NotificationChannel
import android.app.NotificationManager
import android.app.PendingIntent
import android.content.Context
import android.content.Intent
import android.util.Log
import androidx.core.app.NotificationCompat
import com.google.firebase.messaging.FirebaseMessagingService
import com.google.firebase.messaging.RemoteMessage

class MyFirebaseMessagingService : FirebaseMessagingService() {

    override fun onMessageReceived(remoteMessage: RemoteMessage) {
        super.onMessageReceived(remoteMessage)

        Log.d("MyFirebaseMsgService", "showNotification Data Default: " + remoteMessage.data["default"])

        // 通知の内容を取得して表示する
        showNotification("通知タイトル", "通知メッセージ")
        //showNotification("PushTest1", remoteMessage.data["default"])
    }

    private fun showNotification(title: String?, body: String?) {
        val notificationManager = getSystemService(Context.NOTIFICATION_SERVICE) as NotificationManager
        val channelId = "notification"

        val channel = NotificationChannel(
            channelId,
            "通知",
            NotificationManager.IMPORTANCE_HIGH
        )
        notificationManager.createNotificationChannel(channel)

        val intent = Intent(this, MainActivity::class.java)
            .apply {
                flags = Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK
            }

        val pendingIntent = PendingIntent.getActivity(
            this,
            0,
            intent,
            PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_ONE_SHOT or PendingIntent.FLAG_IMMUTABLE
        )

        val notificationBuilder = NotificationCompat.Builder(this, channelId)
            .setContentTitle(title)
            .setContentText(body)
            .setSmallIcon(R.drawable.ic_notification) // 通知アイコン
            .setPriority(NotificationCompat.PRIORITY_HIGH)
            .setContentIntent(pendingIntent) // 通知をタップしたときの表示先
            .setAutoCancel(true) // 通知をタップしたら消去

        Log.d("MyFirebaseMsgService", "showNotification Title: $title")
        Log.d("MyFirebaseMsgService", "showNotification Body: $body")

        notificationManager.notify(0, notificationBuilder.build())
    }

}
■app\src\main\java\net\refirio\pushtest1\MainActivity.ktpackage net.refirio.pushtest1

import android.Manifest
import android.content.Context
import android.content.pm.PackageManager
import android.os.Bundle
import android.util.Log
import androidx.activity.ComponentActivity
import androidx.activity.compose.ManagedActivityResultLauncher
import androidx.activity.compose.rememberLauncherForActivityResult
import androidx.activity.compose.setContent
import androidx.activity.enableEdgeToEdge
import androidx.activity.result.contract.ActivityResultContracts
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.fillMaxSize
import androidx.compose.foundation.layout.padding
import androidx.compose.material3.Button
import androidx.compose.material3.Scaffold
import androidx.compose.material3.Text
import androidx.compose.runtime.Composable
import androidx.compose.runtime.MutableState
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.platform.LocalContext
import androidx.compose.ui.tooling.preview.Preview
import androidx.core.content.ContextCompat
import com.google.firebase.messaging.FirebaseMessaging
import net.refirio.pushtest1.ui.theme.PushTest1Theme

class MainActivity : ComponentActivity() {
    private var tokenState: MutableState<String?>? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        enableEdgeToEdge()
        setContent {
            PushTest1Theme {
                val localTokenState = remember { mutableStateOf<String?>(null) }
                tokenState = localTokenState

                Scaffold(modifier = Modifier.fillMaxSize()) { innerPadding ->
                    MainScreen(modifier = Modifier.padding(innerPadding), localTokenState)
                }
            }
        }

        // Firebaseのトークンを取得
        FirebaseMessaging.getInstance().token.addOnCompleteListener { task ->
            if (!task.isSuccessful) {
                Log.w("MainActivity", "Fetching FCM registration token failed", task.exception)
                return@addOnCompleteListener
            }

            // トークンを取得
            val token = task.result
            Log.d("MainActivity", "FCM Token: $token")
            tokenState?.value = token
        }
    }
}

fun checkAndRequestPermissions(
    context: Context,
    permissions: Array<String>,
    launcher: ManagedActivityResultLauncher<Array<String>, Map<String, Boolean>>
) {
    if (
        permissions.all {
            ContextCompat.checkSelfPermission(
                context,
                it
            ) == PackageManager.PERMISSION_GRANTED
        }
    ) {
        // パーミッションが与えられている
        Log.d("MainActivity", "Already granted")
    } else {
        // パーミッションを要求
        launcher.launch(permissions)
    }
}

@Composable
fun MainScreen(modifier: Modifier = Modifier, tokenState: MutableState<String?>) {
    val context = LocalContext.current
    val permissions = arrayOf(
        Manifest.permission.POST_NOTIFICATIONS
    )
    val launcherMultiplePermissions = rememberLauncherForActivityResult(
        ActivityResultContracts.RequestMultiplePermissions()
    ) { permissionsMap ->
        val areGranted = permissionsMap.values.reduce { acc, next -> acc && next }
        if (areGranted) {
            // パーミッションが与えられている
            Log.d("MainActivity", "Already granted")
        } else {
            // パーミッションを要求
            Log.d("MainActivity", "Show dialog")
        }
    }

    Column(modifier = modifier) {
        Text("FCM Token: ${tokenState.value ?: "Loading..."}")
        Button(
            onClick = {
                checkAndRequestPermissions(
                    context,
                    permissions,
                    launcherMultiplePermissions
                )
            }
        ) {
            Text("通知を許可（Android13用）")
        }
    }
}

@Preview(showBackground = true)
@Composable
fun MainScreenPreview() {
    var tokenState: MutableState<String?>? = null
    val localTokenState = remember { mutableStateOf<String?>(null) }
    tokenState = localTokenState

    MainScreen(modifier = Modifier, localTokenState)
}


※実際の実装では、トークンを画面に表示することなく「デバイス内に保存してサーバにも投げる」としておけば良さそう。
  後述の「アプリ起動時にデバイストークンをサーバ側に記録」も参照。

以下を参考にした。

2 Ways to Request Permissions in Jetpack Compose | by Igor Stevanovic | Better Programming
https://betterprogramming.pub/jetpack-compose-request-permissions-in-two-ways-fd81c4a702c

以下も参考にできるかもしれない。

AWS SNSからAndroidにプッシュ通知するためにやったこと、ハマったこと - Qiita
https://qiita.com/nashitake/items/4724527c5c6fef4427d2

Android 13で導入されるNotification runtime permissionについて調べてみた - Money Forward Developers Blog
https://moneyforward-dev.jp/entry/2022/04/11/android13-notification-runtime-permission/

【Androidで通知を出すために】通知の権限回りを整える
https://zenn.dev/tbsten/articles/droid-notification-permission

画面を表示したら通知の許可を求める…は、以下を参考にできそう。（未検証。）

Composableが表示されたタイミングでコルーチンを起動する(LaunchedEffect) | mokelab tech sheets
https://tech.mokelab.com/android/compose/effect/LaunchedEffect.html■動作確認

アプリを実行すると、画面にデバイストークンが表示される。
また、ログにもデバイストークンが表示されるようにしている。
以下は実際に表示された値。

2024-10-24 18:54:27.967 13887-13887 MainActivity            net.refirio.pushtest1               D  FCM Token: envzgXQ9Tm0000000000-K:APA91bFp66znOyBVMEkFCBRXhh-ssW2iQeDnXXKDGy-Ey-cN-T9FlaXFk0eKHlvfeYtoOYQjhqFN3WayxCtFwhZnOm48Mx99LIiXD2x7YQwZ8wwYw-X756tTgRAB1QvGDbdZBcp7_x69


この文字列をもとに、サーバサイドプログラムからプッシュ通知を送信する。
具体的な送信方法は引き続き後述する。

※ログに表示されない場合、Logcatの左上で対象のデバイスが選択されているか確認する。
Memo

Advertisement
