تقديم الدعم للعاملين الدائمين

يتضمّن WorkManager دعمًا مضمّنًا لعمليات التشغيل الطويلة. في هذه الحالات، يمكن أن يرسل WorkManager إشارة إلى نظام التشغيل بأنّه يجب إبقاء العملية مفعّلة إذا أمكن أثناء تنفيذ هذا العمل. يمكن تشغيل هذه "العمال" لأكثر من 10 دقائق. تشمل أمثلة حالات استخدام هذه الميزة الجديدة عمليات التحميل أو التحميل المُجمَّع (التي لا يمكن تقسيمها) أو معالجة نموذج تعلُّم آلي على الجهاز أو مهمة مهمة للمستخدم في التطبيق.

في الخلفية، يدير WorkManager خدمة تعمل في المقدّمة ويشغّلها نيابةً عنك لتنفيذ WorkRequest، مع عرض إشعار قابل للضبط في الوقت نفسه.

تتيح منصة ListenableWorker الآن استخدام واجهة برمجة التطبيقات setForegroundAsync()، وCoroutineWorker تتيح استخدام واجهة برمجة التطبيقات setForeground() المخصّصة للتعليق. تسمح واجهتَي برمجة التطبيقات هاتَين للمطوّرين بتحديد أنّ WorkRequest هذه مُهمّة (من وجهة نظر المستخدِم) أو طويلة الأمد.

اعتبارًا من الإصدار 2.3.0-alpha03، يتيح لك WorkManager أيضًا إنشاء PendingIntent، والذي يمكن استخدامه لإلغاء عمليات التشغيل بدون الحاجة إلى تسجيل مكوّن Android جديد باستخدام واجهة برمجة التطبيقات createCancelPendingIntent(). يكون هذا النهج مفيدًا بشكل خاص عند استخدامه مع واجهتَي برمجة التطبيقات setForegroundAsync() أو setForeground()، اللتين يمكن استخدامهما لإضافة إجراء إشعار لإلغاءWorker.

إنشاء وإدارة عمليات العمل التي تستغرق وقتًا طويلاً

ستستخدم نهجًا مختلفًا قليلاً حسب ما إذا كنت تُنشئ الرموز البرمجية باستخدام Kotlin أو Java.

Kotlin

على مطوّري لغة Kotlin استخدام CoroutineWorker. بدلاً من استخدام setForegroundAsync()، يمكنك استخدام الإصدار المعلّق من هذه الطريقة، وهو setForeground().

class DownloadWorker(context: Context, parameters: WorkerParameters) :
   CoroutineWorker(context, parameters) {

   private val notificationManager =
       context.getSystemService(Context.NOTIFICATION_SERVICE) as
               NotificationManager

   override suspend fun doWork(): Result {
       val inputUrl = inputData.getString(KEY_INPUT_URL)
                      ?: return Result.failure()
       val outputFile = inputData.getString(KEY_OUTPUT_FILE_NAME)
                      ?: return Result.failure()
       // Mark the Worker as important
       val progress = "Starting Download"
       setForeground(createForegroundInfo(progress))
       download(inputUrl, outputFile)
       return Result.success()
   }

   private fun download(inputUrl: String, outputFile: String) {
       // Downloads a file and updates bytes read
       // Calls setForeground() periodically when it needs to update
       // the ongoing Notification
   }
   // Creates an instance of ForegroundInfo which can be used to update the
   // ongoing notification.
   private fun createForegroundInfo(progress: String): ForegroundInfo {
       val id = applicationContext.getString(R.string.notification_channel_id)
       val title = applicationContext.getString(R.string.notification_title)
       val cancel = applicationContext.getString(R.string.cancel_download)
       // This PendingIntent can be used to cancel the worker
       val intent = WorkManager.getInstance(applicationContext)
               .createCancelPendingIntent(getId())

       // Create a Notification channel if necessary
       if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
           createChannel()
       }

       val notification = NotificationCompat.Builder(applicationContext, id)
           .setContentTitle(title)
           .setTicker(title)
           .setContentText(progress)
           .setSmallIcon(R.drawable.ic_work_notification)
           .setOngoing(true)
           // Add the cancel action to the notification which can
           // be used to cancel the worker
           .addAction(android.R.drawable.ic_delete, cancel, intent)
           .build()

       return ForegroundInfo(notificationId, notification)
   }

   @RequiresApi(Build.VERSION_CODES.O)
   private fun createChannel() {
       // Create a Notification channel
   }

   companion object {
       const val KEY_INPUT_URL = "KEY_INPUT_URL"
       const val KEY_OUTPUT_FILE_NAME = "KEY_OUTPUT_FILE_NAME"
   }
}

Java

يمكن للمطوّرين الذين يستخدمون ListenableWorker أو Worker استدعاء واجهة برمجة التطبيقات setForegroundAsync() التي تعرض ListenableFuture<Void>. يمكنك أيضًا الاتصال برقم setForegroundAsync() لتعديل Notification قيد التنفيذ.

في ما يلي مثال بسيط على عملية تشغيل طويلة لعامل ينزِّل ملفًا. يتتبّع Worker هذا مستوى التقدّم لتعديل Notification قيد التقدّم والذي يعرض مستوى التقدّم في عملية التنزيل.

public class DownloadWorker extends Worker {
   private static final String KEY_INPUT_URL = "KEY_INPUT_URL";
   private static final String KEY_OUTPUT_FILE_NAME = "KEY_OUTPUT_FILE_NAME";

   private NotificationManager notificationManager;

   public DownloadWorker(
       @NonNull Context context,
       @NonNull WorkerParameters parameters) {
           super(context, parameters);
           notificationManager = (NotificationManager)
               context.getSystemService(NOTIFICATION_SERVICE);
   }

   @NonNull
   @Override
   public Result doWork() {
       Data inputData = getInputData();
       String inputUrl = inputData.getString(KEY_INPUT_URL);
       String outputFile = inputData.getString(KEY_OUTPUT_FILE_NAME);
       // Mark the Worker as important
       String progress = "Starting Download";
       setForegroundAsync(createForegroundInfo(progress));
       download(inputUrl, outputFile);
       return Result.success();
   }

   private void download(String inputUrl, String outputFile) {
       // Downloads a file and updates bytes read
       // Calls setForegroundAsync(createForegroundInfo(myProgress))
       // periodically when it needs to update the ongoing Notification.
   }

   @NonNull
   private ForegroundInfo createForegroundInfo(@NonNull String progress) {
       // Build a notification using bytesRead and contentLength

       Context context = getApplicationContext();
       String id = context.getString(R.string.notification_channel_id);
       String title = context.getString(R.string.notification_title);
       String cancel = context.getString(R.string.cancel_download);
       // This PendingIntent can be used to cancel the worker
       PendingIntent intent = WorkManager.getInstance(context)
               .createCancelPendingIntent(getId());

       if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
           createChannel();
       }

       Notification notification = new NotificationCompat.Builder(context, id)
               .setContentTitle(title)
               .setTicker(title)
               .setSmallIcon(R.drawable.ic_work_notification)
               .setOngoing(true)
               // Add the cancel action to the notification which can
               // be used to cancel the worker
               .addAction(android.R.drawable.ic_delete, cancel, intent)
               .build();

       return new ForegroundInfo(notificationId, notification);
   }

   @RequiresApi(Build.VERSION_CODES.O)
   private void createChannel() {
       // Create a Notification channel
   }
}

إضافة نوع خدمة تعمل في المقدّمة إلى عملية معالجة طويلة الأمد

ملاحظة: استنادًا إلى مستوى واجهة برمجة التطبيقات الذي يستهدفه تطبيقك ونوع العمل الذي تؤديه الخدمة، قد يُطلب منك الإفصاح عن نوع الخدمة التي تعمل في المقدّمة. يُعدّ تقديم بيان عن نوع الخدمة التي تعمل في المقدّمة من أفضل الممارسات بغض النظر عن إصدار Android الذي تستهدفه. لمزيد من التفاصيل، يُرجى الاطّلاع على الإفصاح عن الخدمات التي تعمل في المقدّمة وطلب الأذونات.

إذا كان تطبيقك يستهدف الإصدار 14 من نظام التشغيل Android (المستوى 34 لواجهة برمجة التطبيقات) أو الإصدارات الأحدث، يجب تحديد نوع الخدمة التي تعمل في المقدّمة لجميع مهام العمل التي تستغرق وقتًا طويلاً. إذا كان تطبيقك يستهدف الإصدار 10 من نظام التشغيل Android (المستوى 29 من واجهة برمجة التطبيقات) أو إصدارًا أحدث وكان يحتوي على عملية معالجة تستغرق وقتًا طويلاً وتتطلّب الوصول إلى الموقع الجغرافي، يجب الإشارة إلى أنّ عملية المعالجة تستخدم نوع الخدمة التي تعمل في المقدّمة location.

إذا كان تطبيقك يستهدف الإصدار 11 من نظام التشغيل Android (المستوى 30 لواجهة برمجة التطبيقات) أو إصدارًا أحدث ويتضمّن عملية طويلة الأمد تتطلّب الوصول إلى الكاميرا أو الميكروفون، عليك تقديم بيان عن نوعَي الخدمة camera أو microphone التي تعمل في المقدّمة، على التوالي.

لإضافة أنواع الخدمات هذه التي تعمل في المقدّمة، أكمِل الخطوات الموضّحة في الأقسام التالية.

تقديم بيان عن أنواع الخدمات التي تعمل في المقدّمة في بيان التطبيق

عرِّف نوع الخدمة التي تعمل في المقدّمة لعامل الخدمة في بيان تطبيقك. في المثال التالي، يحتاج العامل إلى إذن الوصول إلى الموقع الجغرافي والميكروفون:

AndroidManifest.xml

<service
   android:name="androidx.work.impl.foreground.SystemForegroundService"
   android:foregroundServiceType="location|microphone"
   tools:node="merge" />

ملاحظة: تجمع أداة دمج البيان بين تعريف العنصر <service> من مقتطف الرمز السابق وتعريف SystemForegroundService الذي يحدّده WorkManager في بيانه الخاص.

تحديد أنواع الخدمات التي تعمل في المقدّمة أثناء التشغيل

عند الاتصال بـ setForeground() أو setForegroundAsync()، تأكَّد من تحديد نوع الخدمة التي تعمل في المقدّمة.

ملاحظة: بدءًا من الإصدار 14 من نظام التشغيل Android (المستوى 34 لواجهة برمجة التطبيقات)، عند طلب setForeground() أو setForegroundAsync()، يتحقّق النظام من متطلبات أساسية معيّنة استنادًا إلى نوع الخدمة. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة الإفصاح عن الخدمات التي تعمل في المقدّمة وطلب الأذونات.

MyLocationAndMicrophoneWorker

Kotlin

private fun createForegroundInfo(progress: String): ForegroundInfo {
   // ...
   return ForegroundInfo(NOTIFICATION_ID, notification,
           FOREGROUND_SERVICE_TYPE_LOCATION or
FOREGROUND_SERVICE_TYPE_MICROPHONE) }

Java

@NonNull
private ForegroundInfo createForegroundInfo(@NonNull String progress) {
   // Build a notification...
   Notification notification = ...;
   return new ForegroundInfo(NOTIFICATION_ID, notification,
           FOREGROUND_SERVICE_TYPE_LOCATION | FOREGROUND_SERVICE_TYPE_MICROPHONE);
}