FCM 用戶端僅適用於搭載 Android 4.4 以上版本的裝置,且已安裝 Google Play 商店應用程式,或是搭載 Google API 的 Android 4.4 模擬器。請注意,您不限於透過 Google Play 商店部署 Android 應用程式。
設定 SDK
本節說明如果您為應用程式啟用了其他 Firebase 功能,可能已完成的工作。如果尚未將 Firebase 新增至 Android 專案,請先完成這項操作。
編輯應用程式資訊清單
在應用程式的資訊清單中加入以下內容:
- 擴充
FirebaseMessagingService
的服務。除了在背景中接收通知的應用程式之外,如果您想執行任何訊息處理作業,就必須使用這項設定。如要在前景應用程式中接收通知、接收資料酬載、傳送上游訊息等,您必須擴充這項服務。
<service android:name=".java.MyFirebaseMessagingService" android:exported="false"> <intent-filter> <action android:name="com.google.firebase.MESSAGING_EVENT" /> </intent-filter> </service>
<!-- 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" />
default_notification_channel_id
設為通知管道物件的 ID,如圖所示。只要傳入訊息未明確設定通知管道,FCM 就會使用這個值。詳情請參閱「
管理通知管道」一文。<meta-data android:name="com.google.firebase.messaging.default_notification_channel_id" android:value="@string/default_notification_channel_id" />
在 Android 13 以上版本要求執行階段通知權限
Android 13 導入了新的執行階段權限來顯示通知。這會影響在 Android 13 以上版本中執行,且使用 FCM 通知的應用程式。
根據預設,FCM SDK (23.0.6 以上版本) 包含資訊清單中定義的 POST_NOTIFICATIONS
權限。不過,應用程式也必須透過常數 android.permission.POST_NOTIFICATIONS
,要求這項權限的執行階段版本。使用者必須授予此權限,應用程式才會顯示通知。
如何要求新的執行階段權限:
Kotlin+KTX
// Declare the launcher at the top of your Activity/Fragment: private val requestPermissionLauncher = registerForActivityResult( ActivityResultContracts.RequestPermission(), ) { isGranted: Boolean -> if (isGranted) { // FCM SDK (and your app) can post notifications. } else { // TODO: Inform user that that your app will not show notifications. } } private fun askNotificationPermission() { // This is only necessary for API level >= 33 (TIRAMISU) if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) { if (ContextCompat.checkSelfPermission(this, Manifest.permission.POST_NOTIFICATIONS) == PackageManager.PERMISSION_GRANTED ) { // FCM SDK (and your app) can post notifications. } else if (shouldShowRequestPermissionRationale(Manifest.permission.POST_NOTIFICATIONS)) { // TODO: display an educational UI explaining to the user the features that will be enabled // by them granting the POST_NOTIFICATION permission. This UI should provide the user // "OK" and "No thanks" buttons. If the user selects "OK," directly request the permission. // If the user selects "No thanks," allow the user to continue without notifications. } else { // Directly ask for the permission requestPermissionLauncher.launch(Manifest.permission.POST_NOTIFICATIONS) } } }
Java
// Declare the launcher at the top of your Activity/Fragment: private final ActivityResultLauncher<String> requestPermissionLauncher = registerForActivityResult(new ActivityResultContracts.RequestPermission(), isGranted -> { if (isGranted) { // FCM SDK (and your app) can post notifications. } else { // TODO: Inform user that that your app will not show notifications. } }); private void askNotificationPermission() { // This is only necessary for API level >= 33 (TIRAMISU) if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) { if (ContextCompat.checkSelfPermission(this, Manifest.permission.POST_NOTIFICATIONS) == PackageManager.PERMISSION_GRANTED) { // FCM SDK (and your app) can post notifications. } else if (shouldShowRequestPermissionRationale(Manifest.permission.POST_NOTIFICATIONS)) { // TODO: display an educational UI explaining to the user the features that will be enabled // by them granting the POST_NOTIFICATION permission. This UI should provide the user // "OK" and "No thanks" buttons. If the user selects "OK," directly request the permission. // If the user selects "No thanks," allow the user to continue without notifications. } else { // Directly ask for the permission requestPermissionLauncher.launch(Manifest.permission.POST_NOTIFICATIONS); } } }
一般而言,您應顯示使用者介面,在使用者授予應用程式發布通知權限時,說明將啟用的功能。此 UI 應讓使用者選擇同意或拒絕選項,例如「OK」和「不用了,謝謝」按鈕。如果使用者選取「OK」,請直接要求權限。如果使用者選取「不用了,謝謝」,請允許使用者在不收到通知的情況下繼續操作。
如要進一步瞭解應用程式何時應要求使用者授予 POST_NOTIFICATIONS
權限,請參閱「通知執行階段權限」。
指定 Android 12L (API 級別 32) 以下版本的應用程式通知權限
只要應用程式在前景運作,Android 就會自動在應用程式首次建立通知管道時要求使用者授予權限。不過,建立頻道和權限要求的時機有一些重要注意事項:
- 如果應用程式在背景執行時建立了第一個通知管道 (FCM SDK 收到 FCM 通知時會採用此設定),則 Android 將不允許顯示通知,也不會在下次開啟應用程式時提示使用者授予通知權限。也就是說,應用程式開啟前收到的所有通知,而且使用者接受權限後,該通知就會遺失。
- 我們強烈建議您將應用程式更新為指定 Android 13 以上版本,利用平台的 API 要求權限。如果這個方法不可行,應用程式應先建立通知管道再傳送通知至應用程式,以便觸發通知權限對話方塊,並確保不會遺失任何通知。詳情請參閱通知權限最佳做法。
選用:移除 POST_NOTIFICATIONS
權限
根據預設,FCM SDK 包含 POST_NOTIFICATIONS
權限。如果應用程式沒有使用通知訊息 (無論是透過 FCM 通知、其他 SDK 或由應用程式直接發布),您不希望應用程式加入這項權限,可以使用資訊清單合併工具的 remove
標記將其移除。請注意,移除這項權限會讓系統顯示所有通知,而不只是 FCM 通知。請在應用程式的資訊清單檔案中加入以下內容:
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" tools:node="remove"/>
存取裝置註冊權杖
在應用程式初始啟動時,FCM SDK 會為用戶端應用程式執行個體產生註冊權杖。如要指定單一裝置或建立裝置群組,您必須擴充
FirebaseMessagingService
並覆寫 onNewToken
,才能存取這個權杖。
本節說明如何擷取權杖,以及如何監控權杖變更。權杖可能會在初始啟動後輪替,因此強烈建議您擷取最新更新的註冊權杖。
在下列情況下,註冊權杖可能會變更:
- 應用程式已在新裝置上還原
- 使用者解除安裝/重新安裝應用程式
- 使用者清除應用程式資料。
擷取目前的註冊權杖
如果需要擷取目前的權杖,請呼叫
FirebaseMessaging.getInstance().getToken()
:
Kotlin+KTX
FirebaseMessaging.getInstance().token.addOnCompleteListener(OnCompleteListener { task -> if (!task.isSuccessful) { Log.w(TAG, "Fetching FCM registration token failed", task.exception) return@OnCompleteListener } // Get new FCM registration token val token = task.result // Log and toast val msg = getString(R.string.msg_token_fmt, token) Log.d(TAG, msg) Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show() })
Java
FirebaseMessaging.getInstance().getToken() .addOnCompleteListener(new OnCompleteListener<String>() { @Override public void onComplete(@NonNull Task<String> task) { if (!task.isSuccessful()) { Log.w(TAG, "Fetching FCM registration token failed", task.getException()); return; } // Get new FCM registration token String token = task.getResult(); // Log and toast String msg = getString(R.string.msg_token_fmt, token); Log.d(TAG, msg); Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show(); } });
監控權杖產生作業
每當產生新權杖時,onNewToken
回呼就會觸發。
Kotlin+KTX
/** * Called if the FCM registration token is updated. This may occur if the security of * the previous token had been compromised. Note that this is called when the * FCM registration token is initially generated so this is where you would retrieve the token. */ override fun onNewToken(token: String) { Log.d(TAG, "Refreshed token: $token") // If you want to send messages to this application instance or // manage this apps subscriptions on the server side, send the // FCM registration token to your app server. sendRegistrationToServer(token) }
Java
/** * There are two scenarios when onNewToken is called: * 1) When a new token is generated on initial app startup * 2) Whenever an existing token is changed * Under #2, there are three scenarios when the existing token is changed: * A) App is restored to a new device * B) User uninstalls/reinstalls the app * C) User clears app data */ @Override public void onNewToken(@NonNull String token) { Log.d(TAG, "Refreshed token: " + token); // If you want to send messages to this application instance or // manage this apps subscriptions on the server side, send the // FCM registration token to your app server. sendRegistrationToServer(token); }
取得權杖後,您就能將權杖傳送至應用程式伺服器,並使用偏好的方法儲存權杖。
檢查 Google Play 服務
使用 Play 服務 SDK 的應用程式在存取 Google Play 服務功能前,應一律先檢查裝置是否有相容的 Google Play 服務 APK。建議在以下兩個位置執行這項操作:主要活動的 onCreate()
方法,以及在其 onResume()
方法中。onCreate()
中的檢查可確保應用程式必須通過檢查才能使用。檢查 onResume()
可確保即便使用者透過其他方式 (例如透過返回按鈕) 返回執行中的應用程式,系統仍會執行檢查。
如果裝置沒有相容的 Google Play 服務版本,應用程式可以呼叫 GoogleApiAvailability.makeGooglePlayServicesAvailable()
,讓使用者從 Play 商店下載 Google Play 服務。
禁止自動初始化
產生 FCM 註冊權杖時,程式庫會將 ID 和設定資料上傳至 Firebase。如果您想避免系統自動產生權杖,請將下列中繼資料值新增至 AndroidManifest.xml
,藉此停用 Analytics (分析) 收集功能和 FCM 自動初始化功能 (您必須停用兩者):
<meta-data android:name="firebase_messaging_auto_init_enabled" android:value="false" /> <meta-data android:name="firebase_analytics_collection_enabled" android:value="false" />
如要重新啟用 FCM 自動初始化,請發出執行階段呼叫:
Kotlin+KTX
Firebase.messaging.isAutoInitEnabled = true
Java
FirebaseMessaging.getInstance().setAutoInitEnabled(true);
如要重新啟用 Analytics (分析) 收集功能,請呼叫 FirebaseAnalytics
類別的 setAnalyticsCollectionEnabled()
方法。例如:
setAnalyticsCollectionEnabled(true);
這些值會在應用程式重新啟動後保留下來。
後續步驟
用戶端應用程式設定完成後,您就可以開始使用 通知編輯器傳送下游訊息。此功能已在快速入門導覽課程範例中示範,您可以下載、執行和查看。
若想在應用程式中加入其他進階行為,您可以宣告意圖篩選器並實作活動來回應傳入的訊息。如需詳細資料,請參閱從應用程式伺服器傳送郵件的指南:
請注意,如要利用這些功能,您需要 伺服器實作和伺服器通訊協定 (HTTP 或 XMPP),或實作 Admin SDK。