Các phương pháp hay nhất để quản lý mã thông báo đăng ký FCM

Nếu sử dụng API FCM để tạo yêu cầu gửi theo phương thức lập trình, bạn có thể nhận thấy rằng theo thời gian, bạn đang lãng phí tài nguyên bằng cách gửi thông báo đến các thiết bị không hoạt động bằng mã thông báo đăng ký cũ. Tình huống này có thể ảnh hưởng đến dữ liệu phân phối thông báo được báo cáo trong bảng điều khiển Firebase hoặc dữ liệu được xuất sang BigQuery, thể hiện dưới dạng mức giảm đáng kể (nhưng không thực sự hợp lệ) về tỷ lệ phân phối. Hướng dẫn này thảo luận một số biện pháp bạn có thể thực hiện để đảm bảo tính năng nhắm mục tiêu thông báo hiệu quả và báo cáo phân phối hợp lệ.

Mã thông báo đăng ký cũ và đã hết hạn

Mã thông báo đăng ký cũ là mã thông báo liên kết với các thiết bị không hoạt động và không kết nối với FCM trong hơn một tháng. Theo thời gian, thiết bị sẽ ít có khả năng kết nối lại với FCM hơn. Các lượt gửi thông báo và phân phối chủ đề cho các mã thông báo cũ này có thể sẽ không bao giờ được phân phối.

Có một số lý do khiến mã thông báo có thể trở nên lỗi thời. Ví dụ: thiết bị liên kết với mã thông báo có thể bị mất, bị huỷ hoặc bị cất vào kho lưu trữ và bị quên.

Khi mã thông báo cũ không hoạt động trong 270 ngày, FCM sẽ coi đó là mã thông báo đã hết hạn. Sau khi mã thông báo hết hạn, FCM sẽ đánh dấu mã đó là không hợp lệ và từ chối gửi đến mã đó. Tuy nhiên, FCM sẽ phát hành một mã thông báo mới cho thực thể ứng dụng trong trường hợp hiếm hoi thiết bị kết nối lại và ứng dụng được mở.

Các phương pháp hay nhất cơ bản

Có một số phương pháp cơ bản mà bạn nên làm theo trong mọi ứng dụng sử dụng API FCM để tạo yêu cầu gửi theo phương thức lập trình. Sau đây là các phương pháp hay nhất chính:

  • Truy xuất mã thông báo đăng ký từ FCM và lưu trữ các mã đó trên máy chủ của bạn. Vai trò quan trọng của máy chủ là theo dõi mã thông báo của từng ứng dụng khách và cập nhật danh sách mã thông báo đang hoạt động. Bạn nên triển khai dấu thời gian mã thông báo trong mã và máy chủ của mình, đồng thời cập nhật dấu thời gian này theo chu kỳ đều đặn.
  • Duy trì tính mới của mã thông báo và xoá mã thông báo cũ. Ngoài việc xoá các mã thông báo mà FCM không còn coi là hợp lệ, bạn nên theo dõi các dấu hiệu khác cho thấy mã thông báo đã lỗi thời và chủ động xoá các mã thông báo đó. Hướng dẫn này thảo luận một số lựa chọn để đạt được điều này.

Truy xuất và lưu trữ mã thông báo đăng ký

Khi khởi động ứng dụng lần đầu, SDK FCM sẽ tạo một mã thông báo đăng ký cho thực thể ứng dụng khách. Đây là mã thông báo mà bạn phải đưa vào các yêu cầu gửi được nhắm mục tiêu từ API hoặc thêm vào gói thuê bao chủ đề để nhắm mục tiêu chủ đề.

Ứng dụng của bạn nên truy xuất mã thông báo này khi khởi động ban đầu và lưu mã thông báo đó vào máy chủ ứng dụng cùng với dấu thời gian. Mã và máy chủ của bạn phải triển khai dấu thời gian này vì SDK FCM không cung cấp cho bạn.

Ngoài ra, bạn cần lưu mã thông báo vào máy chủ và cập nhật dấu thời gian bất cứ khi nào mã thông báo thay đổi, chẳng hạn như khi:

  • Ứng dụng được khôi phục trên thiết bị mới
  • Người dùng gỡ cài đặt hoặc cài đặt lại ứng dụng
  • Người dùng xoá dữ liệu ứng dụng
  • Ứng dụng sẽ hoạt động trở lại sau khi FCM hết hạn mã thông báo hiện tại

Ví dụ: lưu trữ mã thông báo và dấu thời gian trong Cloud Firestore

Ví dụ: bạn có thể sử dụng Cloud Firestore để lưu trữ mã thông báo trong một bộ sưu tập có tên là fcmTokens. Mỗi mã tài liệu trong tập hợp tương ứng với một mã nhận dạng người dùng và tài liệu này lưu trữ mã đăng ký hiện tại cũng như dấu thời gian cập nhật gần đây nhất. Sử dụng hàm set như trong ví dụ về Kotlin sau:

    /**
     * Persist token to third-party servers.
     *
     * Modify this method to associate the user's FCM registration token with any server-side account
     * maintained by your application.
     *
     * @param token The new token.
     */
    private fun sendTokenToServer(token: String?) {
        // If you're running your own server, call API to send token and today's date for the user

        // Example shown below with Firestore
        // Add token and timestamp to Firestore for this user
        val deviceToken = hashMapOf(
            "token" to token,
            "timestamp" to FieldValue.serverTimestamp(),
        )
        // Get user ID from Firebase Auth or your own server
        Firebase.firestore.collection("fcmTokens").document("myuserid")
            .set(deviceToken)
    }

Bất cứ khi nào một mã thông báo được truy xuất, mã thông báo đó sẽ được lưu trữ trong Cloud Firestore bằng cách gọi sendTokenToServer:

    /**
     * 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.
        sendTokenToServer(token)
    }
        var token = Firebase.messaging.token.await()

        // Check whether the retrieved token matches the one on your server for this user's device
        val preferences = this.getPreferences(Context.MODE_PRIVATE)
        val tokenStored = preferences.getString("deviceToken", "")
        lifecycleScope.launch {
            if (tokenStored == "" || tokenStored != token)
            {
                // If you have your own server, call API to send the above token and Date() for this user's device

                // Example shown below with Firestore
                // Add token and timestamp to Firestore for this user
                val deviceToken = hashMapOf(
                    "token" to token,
                    "timestamp" to FieldValue.serverTimestamp(),
                )

                // Get user ID from Firebase Auth or your own server
                Firebase.firestore.collection("fcmTokens").document("myuserid")
                    .set(deviceToken).await()
            }
        }

Duy trì tính mới của mã thông báo và xoá mã thông báo cũ

Việc xác định xem mã thông báo có mới hay cũ không phải lúc nào cũng đơn giản. Để xem xét tất cả trường hợp, bạn nên áp dụng một ngưỡng cho thời điểm bạn coi mã thông báo là cũ. Theo mặc định, FCM coi một mã thông báo là cũ nếu thực thể ứng dụng của mã thông báo đó không kết nối trong một tháng. Mọi mã thông báo cũ hơn một tháng đều có thể là thiết bị không hoạt động; nếu không, thiết bị đang hoạt động sẽ làm mới mã thông báo của mình.

Tuỳ thuộc vào trường hợp sử dụng, một tháng có thể quá ngắn hoặc quá dài, vì vậy, bạn có thể tự xác định tiêu chí phù hợp với mình.

Phát hiện phản hồi mã thông báo không hợp lệ từ phần phụ trợ FCM

Hãy nhớ phát hiện các phản hồi mã thông báo không hợp lệ từ FCM và phản hồi bằng cách xoá mọi mã thông báo đăng ký được xác định là không hợp lệ hoặc đã hết hạn khỏi hệ thống. Với API HTTP v1, các thông báo lỗi này có thể cho biết rằng yêu cầu gửi của bạn nhắm đến các mã thông báo không hợp lệ hoặc đã hết hạn:

  • UNREGISTERED (HTTP 404)
  • INVALID_ARGUMENT (HTTP 400)

Nếu bạn chắc chắn rằng tải trọng thông báo là hợp lệ và bạn nhận được một trong hai phản hồi này cho mã thông báo được nhắm mục tiêu, thì bạn có thể xoá bản ghi của mã thông báo này một cách an toàn vì mã thông báo này sẽ không bao giờ hợp lệ nữa. Ví dụ: để xoá mã thông báo không hợp lệ khỏi Cloud Firestore, bạn có thể triển khai và chạy một hàm như sau:

    // Registration token comes from the client FCM SDKs
    const registrationToken = 'YOUR_REGISTRATION_TOKEN';

    const message = {
    data: {
        // Information you want to send inside of notification
    },
    token: registrationToken
    };

    // Send message to device with provided registration token
    getMessaging().send(message)
    .then((response) => {
        // Response is a message ID string.
    })
    .catch((error) => {
        // Delete token for user if error code is UNREGISTERED or INVALID_ARGUMENT.
        if (errorCode == "messaging/registration-token-not-registered") {
            // If you're running your own server, call API to delete the
            token for the user

            // Example shown below with Firestore
            // Get user ID from Firebase Auth or your own server
            Firebase.firestore.collection("fcmTokens").document(user.uid).delete()
        }
    });

FCM sẽ chỉ trả về phản hồi mã thông báo không hợp lệ nếu mã thông báo hết hạn sau 270 ngày hoặc nếu ứng dụng đã huỷ đăng ký một cách rõ ràng. Nếu cần theo dõi chính xác hơn tình trạng cũ theo định nghĩa của riêng mình, bạn có thể chủ động xoá mã thông báo đăng ký cũ.

Thường xuyên cập nhật mã thông báo

Bạn nên định kỳ truy xuất và cập nhật tất cả mã thông báo đăng ký trên máy chủ của mình. Để làm việc này, bạn phải:

  • Thêm logic ứng dụng trong ứng dụng khách để truy xuất mã thông báo hiện tại bằng lệnh gọi API thích hợp (chẳng hạn như token(completion): cho các nền tảng của Apple hoặc getToken() cho Android), sau đó gửi mã thông báo hiện tại đến máy chủ ứng dụng để lưu trữ (có dấu thời gian). Đây có thể là một công việc hằng tháng được định cấu hình để bao gồm tất cả ứng dụng hoặc mã thông báo.
  • Thêm logic máy chủ để cập nhật dấu thời gian của mã thông báo theo các khoảng thời gian đều đặn, bất kể mã thông báo có thay đổi hay không.

Để biết ví dụ về logic Android để cập nhật mã thông báo bằng WorkManager, hãy xem bài viết Quản lý mã thông báo Gửi thông báo qua đám mây trên blog Firebase.

Dù bạn tuân theo mẫu thời gian nào, hãy nhớ cập nhật mã thông báo định kỳ. Tần suất cập nhật một lần mỗi tháng sẽ tạo ra sự cân bằng tốt giữa mức tác động đến pin và việc phát hiện mã thông báo đăng ký không hoạt động. Bằng cách làm mới này, bạn cũng đảm bảo rằng mọi thiết bị không hoạt động sẽ làm mới thông tin đăng ký khi thiết bị đó hoạt động trở lại. Việc làm mới thường xuyên hơn một tuần sẽ không mang lại lợi ích gì.

Xoá mã thông báo đăng ký cũ

Trước khi gửi thông báo đến một thiết bị, hãy đảm bảo rằng dấu thời gian của mã thông báo đăng ký của thiết bị nằm trong khoảng thời gian lỗi thời. Ví dụ: bạn có thể triển khai Cloud Functions for Firebase để chạy quy trình kiểm tra hằng ngày nhằm đảm bảo rằng dấu thời gian nằm trong khoảng thời gian đã xác định (chẳng hạn như const EXPIRATION_TIME = 1000 * 60 * 60 * 24 * 30;) rồi xoá các mã thông báo cũ:

exports.pruneTokens = functions.pubsub.schedule('every 24 hours').onRun(async (context) => {
  // Get all documents where the timestamp exceeds is not within the past month
  const staleTokensResult = await admin.firestore().collection('fcmTokens')
      .where("timestamp", "<", Date.now() - EXPIRATION_TIME)
      .get();
  // Delete devices with stale tokens
  staleTokensResult.forEach(function(doc) { doc.ref.delete(); });
});

Huỷ đăng ký các mã thông báo cũ khỏi chủ đề

Nếu sử dụng chủ đề, bạn cũng nên huỷ đăng ký các mã thông báo cũ khỏi các chủ đề mà chúng đã đăng ký. Quá trình này bao gồm hai bước:

  1. Ứng dụng của bạn nên đăng ký lại các chủ đề mỗi tháng một lần và mỗi khi mã thông báo đăng ký thay đổi. Đây là một giải pháp tự khắc phục, trong đó các gói thuê bao sẽ tự động xuất hiện trở lại khi ứng dụng hoạt động trở lại.
  2. Nếu một thực thể ứng dụng ở trạng thái rảnh trong một tháng (hoặc khoảng thời gian lỗi thời của riêng bạn), bạn nên huỷ đăng ký thực thể đó khỏi các chủ đề bằng cách sử dụng SDK quản trị Firebase để xoá mối liên kết mã thông báo với chủ đề khỏi phần phụ trợ FCM.

Lợi ích của hai bước này là việc phân phát sẽ diễn ra nhanh hơn vì có ít mã thông báo cũ hơn để phân phát và các phiên bản ứng dụng cũ sẽ tự động đăng ký lại sau khi hoạt động trở lại.

Đo lường mức độ thành công của việc phân phối

Để có được thông tin chính xác nhất về việc phân phối thông báo, tốt nhất bạn chỉ nên gửi thông báo đến các phiên bản ứng dụng đang được sử dụng. Điều này đặc biệt quan trọng nếu bạn thường xuyên gửi tin nhắn đến các chủ đề có nhiều người đăng ký; nếu một phần người đăng ký đó thực sự không hoạt động, thì theo thời gian, điều này có thể ảnh hưởng đáng kể đến số liệu thống kê về việc phân phối.

Trước khi nhắm mục tiêu thông báo đến một mã thông báo, hãy cân nhắc:

  • Google Analytics, dữ liệu được ghi lại trong BigQuery hoặc các tín hiệu theo dõi khác có cho biết mã thông báo đang hoạt động không?
  • Các lần phân phối trước đó có liên tục không thành công trong một khoảng thời gian không?
  • Mã thông báo đăng ký có được cập nhật trên máy chủ của bạn trong tháng qua không?
  • Đối với thiết bị Android, API Dữ liệu FCM có báo cáo tỷ lệ cao về việc không gửi được thông báo do droppedDeviceInactive không?

Để biết thêm thông tin về việc phân phối, hãy xem bài viết Tìm hiểu về việc phân phối thông báo.