Наблюдайте за промежуточным прогрессом работника

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.

Котлин 

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.

Котлин 

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() :

Котлин 

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 , ознакомьтесь с разделом «Состояния объектов Work» .