Поддержка долго работающих воркеров

В WorkManager есть встроенная поддержка долго выполняющихся задач. В таких случаях WorkManager может отправить ОС сигнал о том, что процесс должен оставаться активным, пока выполняется задача. Эти воркеры могут работать дольше 10 минут. Примеры использования этой новой функции включают массовую загрузку или скачивание (которые нельзя разбить на части), локальную обработку модели ML или задачу, которая важна для пользователя приложения.

WorkManager управляет активной службой и запускает ее от вашего имени, чтобы выполнить WorkRequest, а также показывает настраиваемое уведомление.

ListenableWorker теперь поддерживает API setForegroundAsync(), а CoroutineWorker – приостанавливающий API setForeground(). Эти API позволяют разработчикам указать, что WorkRequest является важным (с точки зрения пользователя) или длительным.

Начиная с версии 2.3.0-alpha03 WorkManager также позволяет создавать PendingIntent, который можно использовать для отмены рабочих процессов без необходимости регистрировать новый компонент Android с помощью API createCancelPendingIntent(). Этот подход особенно полезен при использовании с API 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, могут вызвать API 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 (уровень API 34) или более поздней версии, вы должны указать тип активной службы для всех долго выполняющихся задач. Если ваше приложение предназначено для Android 10 (уровень API 29) или более поздней версии и содержит долго работающий воркер, которому требуется доступ к данным о местоположении, укажите, что воркер использует тип активной службы location.

Если ваше приложение предназначено для Android 11 (уровень API 30) или более поздней версии и содержит долго работающий исполнитель, которому требуется доступ к камере или микрофону, объявите типы активных служб camera или microphone соответственно.

Чтобы добавить эти типы активных служб, выполните действия, описанные в разделах ниже.

Объявите типы активных служб в манифесте приложения

Объявите тип активной службы в манифесте приложения. В следующем примере работнику требуется доступ к местоположению и микрофону:

AndroidManifest.xml

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

Укажите типы активных служб во время выполнения

При вызове 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);
}