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 các yêu cầu gửi theo phương thức lập trình, bạn có thể thấy rằng theo thời gian, mình đang lãng phí tài nguyên khi gửi thông báo đến các thiết bị không hoạt động có 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 của Firebase hoặc dữ liệu được xuất sang BigQuery, thể hiện dưới dạng sự sụt 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 nhắm mục tiêu thư 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à các mã thông báo được liên kết với các thiết bị không hoạt động và chưa kết nối với FCM trong hơn một tháng. Theo thời gian, thiết bị sẽ ngày càng ít kết nối lại với FCM. Các hoạt động gửi tin nhắn và fanout chủ đề cho những mã thông báo cũ này sẽ khó có khả năng đượ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ị được liên kết với mã thông báo có thể bị mất, bị huỷ hoặc được đưa vào bộ nhớ và bị quên.

Khi mã thông báo cũ không còn hoạt động sau 270 ngày, FCM sẽ coi đó là các 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 mã thông báo đó. Tuy nhiên, FCM sẽ đưa ra mã thông báo mới cho phiên bản ứng dụng trong trường hợp hiếm hoi là thiết bị kết nối lại và ứng dụng được mở.

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

Có một số phương pháp cơ bản mà bạn nên thực hiện 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 chính hay nhất:

  • 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 đối với máy chủ là theo dõi mã thông báo của từng ứng dụng và cập nhật danh sách các mã thông báo đang hoạt động. Bạn nên triển khai dấu thời gian của mã thông báo trong mã và máy chủ, đồng thời cập nhật thường xuyên dấu thời gian này.
  • Duy trì độ mới của mã thông báo và xoá các 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ã đó. Hướng dẫn này trình bày một số phương án bạn có thể thực hiện để đạt được mục tiê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 phiên bản ứ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 đến các chủ đề.

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

Ngoài ra, bạn cần phải 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ã này thay đổi, chẳng hạn như khi:

  • Ứng dụng đó được khôi phục trên một 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 có

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 tập hợp có tên là fcmTokens. Mỗi mã tài liệu trong tập hợp này tương ứng với một mã nhận dạng người dùng. Tài liệu này lưu trữ mã thông báo đă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ụ sau về Kotlin:

    /**
     * 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ã đó 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ì độ mới của mã thông báo và xoá các mã thông báo cũ

Việc xác định xem một mã thông báo là mới hay cũ không phải lúc nào cũng đơn giản. Để bao gồm mọi trường hợp, bạn nên đặt một ngưỡng cho thời điểm xem xét các mã thông báo đã lỗi thời. Theo mặc định, FCM sẽ coi một mã thông báo là đã lỗi thời nếu bản sao ứng dụng của mã đó chưa được kết nối trong một tháng. Bất kỳ mã thông báo nào cũ hơn một tháng đều có khả năng là thiết bị không hoạt động; nếu không thì một 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 của bạn, một tháng có thể quá ngắn hoặc quá dài. Vì vậy, bạn có thể quyết đị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á khỏi hệ thống 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. Với API HTTP v1, những thông báo lỗi sau đây có thể cho biết 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à nhận được một trong hai phản hồi này cho một mã thông báo được nhắm mục tiêu, thì bạn có thể yên tâm xoá bản ghi của mã thông báo này vì mã thông báo này sẽ không còn hợp lệ nữa. Ví dụ: để xoá các 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 lỗi thời theo định nghĩa của riêng mình, bạn có thể chủ động xoá các 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 truy xuất và cập nhật định kỳ tất cả các mã thông báo đăng ký trên máy chủ của mình. Việc này yêu cầu bạn phải:

  • Thêm logic ứng dụng vào ứ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): đối với các nền tảng của Apple hoặc getToken() đối với 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ả cá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 định kỳ, bất kể mã thông báo có thay đổi hay không.

Để xem 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 về 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 giúp cân bằng hợp lý giữa tác động của 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ị ngừng hoạt động sẽ làm mới gói đăng ký khi hoạt động trở lại. Việc làm mới thường xuyên hơn hằng 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 của khoảng thời gian lỗi thời. Ví dụ: bạn có thể triển khai Cloud Functions cho 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 lỗi thời đã xác định, chẳng hạn như const EXPIRATION_TIME = 1000 * 60 * 60 * 24 * 30;, sau đó 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ý mã thông báo cũ khỏi các chủ đề

Nếu sử dụng các 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ột lần mỗi tháng và bất cứ khi nào 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 lại khi một ứng dụng hoạt động trở lại.
  2. Nếu một phiên bản ứng dụng không hoạt động trong một tháng (hoặc khoảng thời gian lỗi thời của riêng bạn), thì bạn nên huỷ đăng ký phiên bản đó khỏi các chủ đề bằng cách sử dụng SDK quản trị của Firebase để xoá mã thông báo đến liên kết chủ đề khỏi phần phụ trợ FCM.

Lợi ích của 2 bước này là hoạt động hâm mộ sẽ diễn ra nhanh hơn vì có ít mã thông báo cũ hơn để phân phát, đồng thời 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 khả năng phân phối thành công

Để có được hình ảnh chính xác nhất về quá trình gửi tin nhắn, tốt nhất là bạn chỉ nên gửi tin nhắn đế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 thông báo đến những chủ đề có nhiều người đăng ký; nếu một phần những người đăng ký đó thực sự không hoạt động, thì tác động đối với số liệu thống kê về việc phân phối có thể là đáng kể theo thời gian.

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 thu thập 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?
  • Bạn có liên tục các lần phân phối trước đây 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 trước không?
  • Đối với các thiết bị Android, FCM Data API có báo cáo tỷ lệ phần trăm lỗi gửi tin nhắn cao do droppedDeviceInactive không?

Để biết thêm thông tin về tính năng gửi, hãy xem phần Tìm hiểu về tính năng gửi thư.