با استفاده از Firebase Cloud Messaging پیام ها را دریافت کنید

این راهنما نحوه راه‌اندازی Firebase Cloud Messaging در برنامه‌های موبایل و کلاینت وب خود توضیح می‌دهد تا بتوانید پیام‌ها را به‌طور مطمئن دریافت کنید.

برای دریافت پیام، از سرویسی استفاده کنید که FirebaseMessagingService گسترش دهد. سرویس شما باید تماس‌های onMessageReceived و onDeletedMessages را لغو کند.

onMessageReceived برای اکثر انواع پیام، با استثنائات زیر ارائه شده است:

• پیام‌های اعلان زمانی که برنامه شما در پس‌زمینه است ارسال می‌شود . در این حالت اعلان به سینی سیستم دستگاه تحویل داده می شود. ضربه زدن کاربر روی یک اعلان، راه‌انداز برنامه را به‌طور پیش‌فرض باز می‌کند.

• پیام‌هایی با اعلان و بار داده، وقتی در پس‌زمینه دریافت می‌شوند . در این حالت، اعلان به سینی سیستم دستگاه تحویل داده می‌شود و محموله داده‌ها در موارد اضافی هدف فعالیت راه‌انداز شما تحویل داده می‌شود.

به طور خلاصه:

برای اطلاعات بیشتر درباره انواع پیام، به اعلان‌ها و پیام‌های داده مراجعه کنید.

پاسخ به تماس onMessageReceived دارای وقفه هایی است که به شما امکان می دهد اعلان ارسال کنید، اما تایمرها طوری طراحی نشده اند که به برنامه اجازه دسترسی به شبکه یا انجام کارهای اضافی را بدهد. به این ترتیب، اگر برنامه شما کار پیچیده تری انجام می دهد، باید کارهای بیشتری انجام دهید تا مطمئن شوید که برنامه می تواند کار خود را کامل کند.

اگر انتظار دارید برنامه شما نزدیک به 10 ثانیه برای مدیریت یک پیام نیاز داشته باشد، باید یک کار WorkManager را برنامه ریزی کنید یا دستورالعمل WakeLock زیر را دنبال کنید. در برخی موارد، بسته به تأخیرهای پیش از تماس onMessageReceived ، از جمله تأخیرهای سیستم عامل، زمان راه‌اندازی برنامه، مسدود شدن رشته اصلی توسط عملیات‌های دیگر، یا تماس‌های قبلی onMessageReceived که بیش از حد طولانی می‌شوند، پنجره زمانی برای مدیریت پیام ممکن است کمتر از 10 ثانیه باشد. پس از انقضای آن تایمر، برنامه شما ممکن است در معرض محدودیت‌های کشتن فرآیند یا اجرای پس‌زمینه باشد. به خاطر داشته باشید که تاخیر برای تراکنش‌های شبکه و راه‌اندازی برنامه‌ها می‌تواند قابل توجه باشد، بنابراین در صورت شک، برنامه‌ریزی کنید که پردازش پیام‌تان طولانی شود، اگر وابستگی‌های ناهمزمانی مانند دسترسی به شبکه یا الزامات بارگیری شدید داده وجود دارد.

مانیفست برنامه را ویرایش کنید

برای استفاده از FirebaseMessagingService ، باید موارد زیر را در مانیفست برنامه خود اضافه کنید:

<service
    android:name=".java.MyFirebaseMessagingService"
    android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
</service>
AndroidManifest.xml

همچنین، توصیه می شود مقادیر پیش فرض را برای سفارشی کردن ظاهر اعلان ها تنظیم کنید. می‌توانید یک نماد پیش‌فرض سفارشی و یک رنگ پیش‌فرض سفارشی را مشخص کنید که هر زمان که مقادیر معادل در محموله اعلان تنظیم نشده باشند، اعمال شوند.

برای تنظیم نماد پیش‌فرض و رنگ سفارشی، این خطوط را داخل تگ application اضافه کنید:

<!-- 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" />
AndroidManifest.xml

اندروید نماد پیش‌فرض سفارشی را نمایش می‌دهد و از آن استفاده می‌کند

• همه پیام‌های اعلان ارسال شده از سازنده اعلان‌ها .
• هر پیام اعلانی که به صراحت نماد را در محموله اعلان تنظیم نکرده باشد.

اگر هیچ نماد پیش‌فرض سفارشی تنظیم نشده باشد و هیچ نمادی در بار اعلان تنظیم نشده باشد، Android نماد برنامه را به رنگ سفید نمایش می‌دهد.

لغو روی onMessageReceived

با نادیده گرفتن روش FirebaseMessagingService.onMessageReceived ، می توانید اقداماتی را بر اساس شی RemoteMessage دریافتی انجام دهید و داده پیام را دریافت کنید:

override fun onMessageReceived(remoteMessage: RemoteMessage) {
    // TODO(developer): Handle FCM messages here.
    // Not getting messages here? See why this may be: https://goo.gl/39bRNJ
    Log.d(TAG, "From: ${remoteMessage.from}")

    // Check if message contains a data payload.
    if (remoteMessage.data.isNotEmpty()) {
        Log.d(TAG, "Message data payload: ${remoteMessage.data}")

        // Check if data needs to be processed by long running job
        if (needsToBeScheduled()) {
            // For long-running tasks (10 seconds or more) use WorkManager.
            scheduleJob()
        } else {
            // Handle message within 10 seconds
            handleNow()
        }
    }

    // Check if message contains a notification payload.
    remoteMessage.notification?.let {
        Log.d(TAG, "Message Notification Body: ${it.body}")
    }

    // Also if you intend on generating your own notifications as a result of a received FCM
    // message, here is where that should be initiated. See sendNotification method below.
}
MyFirebaseMessagingService.kt

@Override
public void onMessageReceived(RemoteMessage remoteMessage) {
    // TODO(developer): Handle FCM messages here.
    // Not getting messages here? See why this may be: https://goo.gl/39bRNJ
    Log.d(TAG, "From: " + remoteMessage.getFrom());

    // Check if message contains a data payload.
    if (remoteMessage.getData().size() > 0) {
        Log.d(TAG, "Message data payload: " + remoteMessage.getData());

        if (/* Check if data needs to be processed by long running job */ true) {
            // For long-running tasks (10 seconds or more) use WorkManager.
            scheduleJob();
        } else {
            // Handle message within 10 seconds
            handleNow();
        }

    }

    // Check if message contains a notification payload.
    if (remoteMessage.getNotification() != null) {
        Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody());
    }

    // Also if you intend on generating your own notifications as a result of a received FCM
    // message, here is where that should be initiated. See sendNotification method below.
}
MyFirebaseMessagingService.java

هنگام مدیریت پیام های FCM، دستگاه را بیدار نگه دارید

اگر برنامه شما باید هنگام پردازش یک پیام FCM دستگاه را بیدار نگه دارد، در این زمان باید WakeLock را نگه دارد یا باید یک کار WorkManager ایجاد کند. WakeLocks برای فعالیت‌های پردازش کوتاهی که ممکن است از مهلت زمانی پیش‌فرض onMessageReceived فراتر رود، به خوبی کار می‌کند. برای گردش‌های کاری گسترده، مانند ارسال چندین RPC سریال به سرورهای شما، استفاده از کار WorkManager مناسب‌تر از WakeLock است. در این بخش بر روی نحوه استفاده از WakeLocks تمرکز می کنیم. WakeLock از خوابیدن دستگاه در حین اجرای برنامه جلوگیری می‌کند، که می‌تواند منجر به افزایش مصرف باتری شود، بنابراین استفاده از WakeLocks باید برای مواردی که برنامه شما نباید در هنگام مدیریت پیام متوقف شود، رزرو شود، مانند:

• اعلان هایی به کاربر که به زمان حساس هستند.
• فعل و انفعالات با یک دستگاه خاموش که نباید قطع شود (مانند انتقال شبکه یا ارتباطات با دستگاه دیگر، مانند ساعت جفت شده).

ابتدا باید مطمئن شوید که برنامه شما مجوز WakeLock را درخواست می‌کند (FCM SDK به طور پیش‌فرض این مورد را شامل می‌شود، بنابراین معمولاً نیازی به اضافه کردن چیزی نیست).

<uses-permission android:name="android.permission.WAKE_LOCK" />

سپس برنامه شما باید در ابتدای فراخوانی FirebaseMessagingService.onMessageReceived() یک WakeLock دریافت کند و در پایان تماس آن را آزاد کند.

FirebaseMessagingService سفارشی برنامه:

@Override
public void onMessageReceived(final RemoteMessage message) {
  // If this is a message that is time sensitive or shouldn't be interrupted
  WakeLock wakeLock = getSystemService(PowerManager.class).newWakeLock(PARTIAL_WAKE_LOCK, "myApp:messageReceived");
  try {
    wakeLock.acquire(TIMEOUT_MS);
    // handle message
    ...
  finally {
    wakeLock.release();
  }
}

لغو onDeletedMessages

در برخی شرایط، FCM ممکن است پیامی را ارائه نکند. این زمانی اتفاق می‌افتد که پیام‌های زیادی (بیش از 100) برای برنامه شما در زمان اتصال دستگاه خاص در انتظار آن باشد یا اگر دستگاه بیش از یک ماه است که به FCM متصل نشده باشد. در این موارد، ممکن است یک تماس به FirebaseMessagingService.onDeletedMessages() دریافت کنید. وقتی نمونه برنامه این پاسخ تماس را دریافت می‌کند، باید یک همگام‌سازی کامل با سرور برنامه شما انجام دهد. اگر در 4 هفته گذشته پیامی برای برنامه در آن دستگاه ارسال نکرده باشید، FCM با onDeletedMessages() تماس نخواهد گرفت.

پیام‌های اعلان را در یک برنامه پس‌زمینه مدیریت کنید

وقتی برنامه شما در پس‌زمینه است، Android پیام‌های اعلان را به سینی سیستم هدایت می‌کند. با ضربه زدن کاربر روی اعلان، راه‌انداز برنامه به‌طور پیش‌فرض باز می‌شود.

این شامل پیام‌هایی می‌شود که هم شامل اعلان و هم بار داده (و همه پیام‌های ارسال شده از کنسول اعلان‌ها) هستند. در این موارد، اعلان به سینی سیستم دستگاه تحویل داده می‌شود و محموله داده‌ها بر اساس هدف فعالیت راه‌انداز شما تحویل داده می‌شود.

برای اطلاعات بیشتر در مورد تحویل پیام به برنامه خود، به داشبورد گزارش FCM مراجعه کنید، که تعداد پیام‌های ارسال شده و باز شده در دستگاه‌های Apple و Android را به همراه داده‌های «impressions» (اعلان‌هایی که کاربران مشاهده می‌کنند) را برای برنامه‌های Android ثبت می‌کند.