Hướng dẫn bắt đầu nhanh này mô tả cách thiết lập Firebase Cloud Messaging trong các ứng dụng web và ứng dụng di động của bạn để có thể gửi tin nhắn một cách đáng tin cậy. Đối với môi trường máy chủ, hãy xem phần Môi trường máy chủ và FCM.
Làm quen với Firebase Cloud Messaging và Android
FCM yêu cầu các thiết bị chạy Android 5.0 trở lên đã cài đặt ứng dụng Cửa hàng Google Play hoặc một trình mô phỏng chạy Android 5.0 có API Google. Xin lưu ý rằng bạn không bị giới hạn trong việc triển khai các ứng dụng Android thông qua Cửa hàng Google Play.
Thiết lập SDK
Nếu bạn chưa thực hiện, hãy thêm Firebase vào dự án Android.
Để có trải nghiệm tối ưu với FCM, bạn nên bật Google Analytics trong dự án của mình. Google Analytics là yêu cầu đối với báo cáo gửi tin nhắn của FCM.
Chỉnh sửa tệp kê khai ứng dụng
Thêm nội dung sau vào tệp kê khai của ứng dụng:
- Một dịch vụ mở rộng
FirebaseMessagingService
. Bạn phải làm việc này nếu muốn xử lý mọi thông báo ngoài việc nhận thông báo trên các ứng dụng ở chế độ nền. Để nhận thông báo trong các ứng dụng trên nền trước, nhận tải trọng dữ liệu và nhiều thông tin khác, bạn phải mở rộng dịch vụ này. - (Không bắt buộc) Trong thành phần ứng dụng, các phần tử siêu dữ liệu để đặt biểu tượng và màu thông báo mặc định. Android sử dụng các giá trị này bất cứ khi nào thông báo đến không đặt biểu tượng hoặc màu một cách rõ ràng.
- (Không bắt buộc) Từ Android 8.0 (API cấp 26) trở lên,
kênh thông báo được hỗ trợ và nên dùng. FCM cung cấp một kênh thông báo mặc định với các chế độ cài đặt cơ bản. Nếu bạn muốn
tạo và sử dụng kênh mặc định của riêng mình, hãy đặt
default_notification_channel_id
thành mã nhận dạng của đối tượng kênh thông báo như minh hoạ; FCM sẽ sử dụng giá trị này bất cứ khi nào các thông báo đến không đặt rõ ràng một kênh thông báo. Để tìm hiểu thêm, hãy xem bài viết Quản lý kênh thông báo.
<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" />
<meta-data android:name="com.google.firebase.messaging.default_notification_channel_id" android:value="@string/default_notification_channel_id" />
Yêu cầu cấp quyền gửi thông báo khi bắt đầu chạy trên Android 13 trở lên
Android 13 giới thiệu một quyền khi bắt đầu chạy mới để hiển thị thông báo. Điều này ảnh hưởng đến tất cả các ứng dụng chạy trên Android 13 trở lên sử dụng thông báo FCM.
Theo mặc định, SDK FCM (phiên bản 23.0.6 trở lên) bao gồm quyền POST_NOTIFICATIONS
được xác định trong tệp kê khai.
Tuy nhiên, ứng dụng của bạn cũng sẽ cần yêu cầu phiên bản thời gian chạy của quyền này bằng hằng số android.permission.POST_NOTIFICATIONS
.
Ứng dụng của bạn sẽ không được phép hiển thị thông báo cho đến khi người dùng cấp quyền này.
Cách yêu cầu quyền khi bắt đầu chạy mới:
Kotlin
// 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); } } }
Thông thường, bạn nên hiển thị một giao diện người dùng giải thích cho người dùng về những tính năng sẽ được bật nếu họ cấp quyền cho ứng dụng đăng thông báo. Giao diện người dùng này phải cung cấp cho người dùng các lựa chọn đồng ý hoặc từ chối, chẳng hạn như các nút OK và Không, cảm ơn. Nếu người dùng chọn OK, hãy yêu cầu quyền trực tiếp. Nếu người dùng chọn Không, cảm ơn, hãy cho phép người dùng tiếp tục mà không cần thông báo.
Hãy xem phần Quyền khi bắt đầu chạy đối với thông báo để biết thêm các phương pháp hay nhất về thời điểm ứng dụng của bạn nên yêu cầu người dùng cấp quyền POST_NOTIFICATIONS
.
Quyền nhận thông báo cho các ứng dụng nhắm đến Android 12L (API cấp 32) trở xuống
Android sẽ tự động yêu cầu người dùng cấp quyền vào lần đầu tiên ứng dụng của bạn tạo kênh thông báo, miễn là ứng dụng ở nền trước. Tuy nhiên, có một số lưu ý quan trọng về thời điểm tạo kênh và yêu cầu cấp quyền:
- Nếu ứng dụng của bạn tạo kênh thông báo đầu tiên khi đang chạy ở chế độ nền (FCM SDK sẽ làm như vậy khi nhận được thông báo FCM), thì Android sẽ không cho phép thông báo xuất hiện và sẽ không nhắc người dùng cấp quyền nhận thông báo cho đến lần tiếp theo ứng dụng của bạn được mở. Điều này có nghĩa là mọi thông báo nhận được trước khi ứng dụng của bạn được mở và người dùng chấp nhận quyền sẽ bị mất.
- Bạn nên cập nhật ứng dụng để nhắm đến Android 13 trở lên nhằm tận dụng các API của nền tảng để yêu cầu quyền. Nếu không thể, ứng dụng của bạn nên tạo các kênh thông báo trước khi bạn gửi bất kỳ thông báo nào đến ứng dụng để kích hoạt hộp thoại quyền thông báo và đảm bảo không có thông báo nào bị mất. Hãy xem các phương pháp hay nhất về quyền gửi thông báo để biết thêm thông tin.
Không bắt buộc: xoá quyền POST_NOTIFICATIONS
Theo mặc định, SDK FCM bao gồm quyền POST_NOTIFICATIONS
.
Nếu ứng dụng của bạn không sử dụng thông báo (dù là thông qua thông báo FCM, thông qua một SDK khác hay do ứng dụng của bạn đăng trực tiếp) và bạn không muốn ứng dụng của mình có quyền này, thì bạn có thể xoá quyền này bằng cách sử dụng dấu remove
của trình hợp nhất tệp kê khai. Xin lưu ý rằng việc xoá quyền này sẽ ngăn hiển thị tất cả thông báo, chứ không chỉ thông báo FCM. Thêm nội dung sau vào tệp kê khai của ứng dụng:
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" tools:node="remove"/>
Truy cập vào mã thông báo đăng ký thiết bị
Khi khởi động ứng dụng lần đầu, SDK FCM sẽ tạo mã thông báo đăng ký cho phiên bản ứng dụng khách. Nếu muốn nhắm đến các thiết bị riêng lẻ hoặc tạo nhóm thiết bị, bạn cần truy cập vào mã thông báo này bằng cách mở rộng
FirebaseMessagingService
và ghi đè onNewToken
. Vì mã thông báo có thể được xoay sau khi khởi động ban đầu, nên bạn nên truy xuất mã thông báo đăng ký được cập nhật mới nhất.
Mã thông báo đăng ký có thể thay đổi khi:
- Ứng dụng được khôi phục trên thiết bị mới
- Người dùng gỡ cài đặt/cài đặt lại ứng dụng
- Người dùng xoá dữ liệu ứng dụng.
Truy xuất mã thông báo đăng ký hiện tại
Khi cần truy xuất mã thông báo hiện tại, hãy gọi
FirebaseMessaging.getInstance().getToken()
:
Kotlin
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(); } });
Theo dõi quá trình tạo mã thông báo
lệnh gọi lại onNewToken
sẽ kích hoạt bất cứ khi nào một mã thông báo mới được tạo.
Kotlin
/** * 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); }
Sau khi nhận được mã thông báo, bạn có thể gửi mã thông báo đó đến máy chủ ứng dụng và lưu trữ bằng phương thức mà bạn muốn.
Kiểm tra Dịch vụ Google Play
Những ứng dụng dựa vào Play Services SDK phải luôn kiểm tra thiết bị để tìm APK Dịch vụ Google Play tương thích trước khi truy cập vào các tính năng của Dịch vụ Google Play. Bạn nên thực hiện việc này ở hai nơi: trong phương thức onCreate()
của hoạt động chính và trong phương thức onResume()
của hoạt động đó. Hoạt động kiểm tra trong onCreate()
đảm bảo rằng ứng dụng không thể được sử dụng nếu không kiểm tra thành công. Thao tác kiểm tra trong onResume()
đảm bảo rằng nếu người dùng quay lại ứng dụng đang chạy bằng một số cách khác, chẳng hạn như thông qua nút quay lại, thì thao tác kiểm tra vẫn được thực hiện.
Nếu thiết bị không có phiên bản Dịch vụ Google Play tương thích, ứng dụng của bạn có thể gọi GoogleApiAvailability.makeGooglePlayServicesAvailable()
để cho phép người dùng tải Dịch vụ Google Play xuống từ Cửa hàng Play.
Ngăn quá trình khởi chạy tự động
Khi mã thông báo đăng ký FCM được tạo, thư viện sẽ tải giá trị nhận dạng và dữ liệu cấu hình lên Firebase. Nếu muốn ngăn việc tự động tạo mã thông báo, hãy tắt tính năng thu thập dữ liệu của Analytics và tính năng tự động khởi chạy FCM (bạn phải tắt cả hai) bằng cách thêm các giá trị siêu dữ liệu này vào AndroidManifest.xml
:
<meta-data android:name="firebase_messaging_auto_init_enabled" android:value="false" /> <meta-data android:name="firebase_analytics_collection_enabled" android:value="false" />
Để bật lại tính năng tự động khởi tạo FCM, hãy thực hiện một lệnh gọi thời gian chạy:
Kotlin
Firebase.messaging.isAutoInitEnabled = true
Java
FirebaseMessaging.getInstance().setAutoInitEnabled(true);
Để bật lại tính năng thu thập dữ liệu Analytics, hãy gọi phương thức setAnalyticsCollectionEnabled()
của lớp FirebaseAnalytics
. Ví dụ:
setAnalyticsCollectionEnabled(true);
Các giá trị này vẫn giữ nguyên khi ứng dụng khởi động lại sau khi được đặt.
Gửi thông báo
Để đảm bảo rằng bạn đã thiết lập ứng dụng Android đúng cách, bạn có thể gửi một thông báo kiểm thử theo hướng dẫn sau:
- Cài đặt và chạy ứng dụng trên thiết bị mục tiêu.
- Đảm bảo ứng dụng đang chạy ở chế độ nền trên thiết bị.
- Trong bảng điều khiển Firebase, hãy mở trang Nhắn tin.
- Nếu đây là thông báo đầu tiên của bạn, hãy chọn Tạo chiến dịch đầu tiên, Thông báo của Firebase rồi chọn Tạo.
- Nếu không, trên thẻ Chiến dịch, hãy chọn Chiến dịch mới rồi chọn Thông báo.
- Nhập nội dung tin nhắn. Tất cả các trường khác đều không bắt buộc.
- Chọn Gửi tin nhắn thử nghiệm trong ngăn bên phải.
- Trong trường có nhãn Thêm mã thông báo đăng ký FCM, hãy nhập mã thông báo đăng ký mà bạn đã nhận được trong một phần trước đó của hướng dẫn này.
- Chọn Kiểm tra.
Thiết bị đích của ứng dụng (với ứng dụng ở chế độ nền) sẽ nhận được thông báo.
Để biết thêm thông tin về việc gửi thông báo đến ứng dụng của bạn, hãy xem FCMbảng điều khiển báo cáo. Bảng điều khiển này ghi lại số lượng thông báo đã gửi và đã mở trên các thiết bị Apple và Android, cùng với dữ liệu về lượt hiển thị (thông báo mà người dùng nhìn thấy) cho các ứng dụng Android.
Các bước tiếp theo
Sau khi thiết lập ứng dụng khách, bạn có thể bắt đầu nhận hoặc gửi tin nhắn cho người dùng: