Просмотр промежуточного прогресса рабочих процессов

В WorkManager есть встроенная поддержка настройки и отслеживания промежуточного прогресса для исполнителей. Если рабочий поток выполнялся, когда приложение было в активном режиме, эту информацию также можно показать пользователю с помощью API, которые возвращают LiveData для WorkInfo.

ListenableWorker теперь поддерживает API setProgressAsync(), который позволяет сохранять промежуточный прогресс. Эти API позволяют разработчикам задавать промежуточный прогресс, который можно наблюдать в интерфейсе. Прогресс представлен типом Data, который является сериализуемым контейнером свойств (аналогично input и output и с теми же ограничениями).

Информацию о ходе выполнения можно просматривать и обновлять только во время работы ListenableWorker. Попытки задать прогресс для ListenableWorker после завершения его выполнения игнорируются.

Вы также можете отслеживать ход выполнения с помощью методов getWorkInfoBy…() или getWorkInfoBy…LiveData(). Эти методы возвращают экземпляры объекта WorkInfo, у которого есть новый метод getProgress(), возвращающий Data.

Обновление прогресса

Для разработчиков Java, использующих ListenableWorker или Worker, API setProgressAsync() возвращает ListenableFuture<Void>. Обновление прогресса происходит асинхронно, поскольку этот процесс включает сохранение информации о прогрессе в базе данных. В Kotlin для обновления информации о прогрессе можно использовать функцию расширения setProgress() объекта CoroutineWorker.

В этом примере показан ProgressWorker. В начале работы Worker устанавливает значение прогресса равным 0, а по завершении – 100.

Kotlin

import android.content.Context
import androidx.work.CoroutineWorker
import androidx.work.Data
import androidx.work.WorkerParameters
import kotlinx.coroutines.delay

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

    companion object {
        const val Progress = "Progress"
        private const val delayDuration = 1L
    }

    override suspend fun doWork(): Result {
        val firstUpdate = workDataOf(Progress to 0)
        val lastUpdate = workDataOf(Progress to 100)
        setProgress(firstUpdate)
        delay(delayDuration)
        setProgress(lastUpdate)
        return Result.success()
    }
}

Java

import android.content.Context;
import androidx.annotation.NonNull;
import androidx.work.Data;
import androidx.work.Worker;
import androidx.work.WorkerParameters;

public class ProgressWorker extends Worker {

    private static final String PROGRESS = "PROGRESS";
    private static final long DELAY = 1000L;

    public ProgressWorker(
        @NonNull Context context,
        @NonNull WorkerParameters parameters) {
        super(context, parameters);
        // Set initial progress to 0
        setProgressAsync(new Data.Builder().putInt(PROGRESS, 0).build());
    }

    @NonNull
    @Override
    public Result doWork() {
        try {
            // Doing work.
            Thread.sleep(DELAY);
        } catch (InterruptedException exception) {
            // ... handle exception
        }
        // Set progress to 100 after you are done doing your work.
        setProgressAsync(new Data.Builder().putInt(PROGRESS, 100).build());
        return Result.success();
    }
}

Дождитесь завершения процесса

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

Ниже приведен пример, в котором используется getWorkInfoByIdFlow для Kotlin и getWorkInfoByIdLiveData для Java.

Kotlin

WorkManager.getInstance(applicationContext)
      // requestId is the WorkRequest id
      .getWorkInfoByIdFlow(requestId)
      .collect { workInfo: WorkInfo? ->
          if (workInfo != null) {
              val progress = workInfo.progress
              val value = progress.getInt("Progress", 0)
              // Do something with progress information
          }
      }

Java

WorkManager.getInstance(getApplicationContext())
     // requestId is the WorkRequest id
     .getWorkInfoByIdLiveData(requestId)
     .observe(lifecycleOwner, new Observer<WorkInfo>() {
             @Override
             public void onChanged(@Nullable WorkInfo workInfo) {
                 if (workInfo != null) {
                     Data progress = workInfo.getProgress();
                     int value = progress.getInt(PROGRESS, 0)
                     // Do something with progress
             }
      }
});

Наблюдать за состоянием причины остановки

Чтобы узнать, почему объект Worker был остановлен, вы можете зарегистрировать причину остановки, вызвав метод WorkInfo.getStopReason():

Kotlin

workManager.getWorkInfoByIdFlow(syncWorker.id)
  .collect { workInfo ->
      if (workInfo != null) {
        val stopReason = workInfo.stopReason
        logStopReason(syncWorker.id, stopReason)
      }
  }

Java

  workManager.getWorkInfoByIdLiveData(syncWorker.id)
    .observe(getViewLifecycleOwner(), workInfo -> {
        if (workInfo != null) {
          int stopReason = workInfo.getStopReason();
          logStopReason(syncWorker.id, workInfo.getStopReason());
        }
  });

Дополнительную информацию о жизненном цикле и состояниях объектов Worker можно найти в статье Состояния работы.