Потоки в ListenableWorker

В определенных ситуациях вам может потребоваться предоставить собственную стратегию потоковой обработки. Например, вам может потребоваться обработать асинхронную операцию на основе обратного вызова. WorkManager поддерживает этот вариант использования с помощью ListenableWorker . ListenableWorker — это самый простой рабочий API; Worker , CoroutineWorker и RxWorker являются производными от этого класса. ListenableWorker сигнализирует только о том, когда работа должна начинаться и останавливаться, и оставляет управление потоками полностью на ваше усмотрение. Сигнал начала работы вызывается в основном потоке, поэтому очень важно вручную перейти к фоновому потоку по вашему выбору.

Абстрактный метод ListenableWorker.startWork() возвращает ListenableFuture Result . ListenableFuture — это облегченный интерфейс: это Future , предоставляющий функциональные возможности для подключения прослушивателей и распространения исключений. Ожидается, что в методе startWork вы вернете ListenableFuture , который вы установите вместе с Result операции после ее завершения. Экземпляры ListenableFuture можно создавать одним из двух способов:

  1. Если вы используете Guava, используйте ListeningExecutorService .
  2. В противном случае включите councurrent-futures в свой файл градиента и используйте CallbackToFutureAdapter .

Если вы хотите выполнить какую-то работу на основе асинхронного обратного вызова, вы должны сделать что-то вроде этого:

Котлин 

class CallbackWorker(
        context: Context,
        params: WorkerParameters
) : ListenableWorker(context, params) {
    override fun startWork(): ListenableFuture<Result> {
        return CallbackToFutureAdapter.getFuture { completer ->
            val callback = object : Callback {
                var successes = 0

                override fun onFailure(call: Call, e: IOException) {
                    completer.setException(e)
                }

                override fun onResponse(call: Call, response: Response) {
                    successes++
                    if (successes == 100) {
                        completer.set(Result.success())
                    }
                }
            }

            repeat(100) {
                downloadAsynchronously("https://example.com", callback)
            }

            callback
        }
    }
}

Ява 

public class CallbackWorker extends ListenableWorker {

    public CallbackWorker(Context context, WorkerParameters params) {
        super(context, params);
    }

    @NonNull
    @Override
    public ListenableFuture<Result> startWork() {
        return CallbackToFutureAdapter.getFuture(completer -> {
            Callback callback = new Callback() {
                int successes = 0;

                @Override
                public void onFailure(Call call, IOException e) {
                    completer.setException(e);
                }

                @Override
                public void onResponse(Call call, Response response) {
                    successes++;
                    if (successes == 100) {
                        completer.set(Result.success());
                    }
                }
            };

            for (int i = 0; i < 100; i++) {
                downloadAsynchronously("https://www.example.com", callback);
            }
            return callback;
        });
    }
}

Что произойдет, если вашу работу остановят ? ListenableFuture объекта ListenableWorker всегда отменяется, когда ожидается остановка работы. Используя CallbackToFutureAdapter , вам просто нужно добавить прослушиватель отмены, как показано ниже:

Котлин 

class CallbackWorker(
        context: Context,
        params: WorkerParameters
) : ListenableWorker(context, params) {
    override fun startWork(): ListenableFuture<Result> {
        return CallbackToFutureAdapter.getFuture { completer ->
            val callback = object : Callback {
                var successes = 0

                override fun onFailure(call: Call, e: IOException) {
                    completer.setException(e)
                }

                override fun onResponse(call: Call, response: Response) {
                    ++successes
                    if (successes == 100) {
                        completer.set(Result.success())
                    }
                }
            }

 completer.addCancellationListener(cancelDownloadsRunnable, executor)

            repeat(100) {
                downloadAsynchronously("https://example.com", callback)
            }

            callback
        }
    }
}

Ява 

public class CallbackWorker extends ListenableWorker {

    public CallbackWorker(Context context, WorkerParameters params) {
        super(context, params);
    }

    @NonNull
    @Override
    public ListenableFuture<Result> startWork() {
        return CallbackToFutureAdapter.getFuture(completer -> {
            Callback callback = new Callback() {
                int successes = 0;

                @Override
                public void onFailure(Call call, IOException e) {
                    completer.setException(e);
                }

                @Override
                public void onResponse(Call call, Response response) {
                    ++successes;
                    if (successes == 100) {
                        completer.set(Result.success());
                    }
                }
            };

            completer.addCancellationListener(cancelDownloadsRunnable, executor);

            for (int i = 0; i < 100; ++i) {
                downloadAsynchronously("https://www.example.com", callback);
            }
            return callback;
        });
    }
}

Запуск ListenableWorker в другом процессе

Вы также можете привязать работника к определенному процессу с помощью RemoteListenableWorker , реализации ListenableWorker .

RemoteListenableWorker привязывается к конкретному процессу с помощью двух дополнительных аргументов, которые вы предоставляете как часть входных данных при создании рабочего запроса: ARGUMENT_CLASS_NAME и ARGUMENT_PACKAGE_NAME .

В следующем примере показано создание рабочего запроса, привязанного к определенному процессу:

Котлин 

val PACKAGE_NAME = "com.example.background.multiprocess"

val serviceName = RemoteWorkerService::class.java.name
val componentName = ComponentName(PACKAGE_NAME, serviceName)

val data: Data = Data.Builder()
   .putString(ARGUMENT_PACKAGE_NAME, componentName.packageName)
   .putString(ARGUMENT_CLASS_NAME, componentName.className)
   .build()

return OneTimeWorkRequest.Builder(ExampleRemoteListenableWorker::class.java)
   .setInputData(data)
   .build()

Ява 

String PACKAGE_NAME = "com.example.background.multiprocess";

String serviceName = RemoteWorkerService.class.getName();
ComponentName componentName = new ComponentName(PACKAGE_NAME, serviceName);

Data data = new Data.Builder()
        .putString(ARGUMENT_PACKAGE_NAME, componentName.getPackageName())
        .putString(ARGUMENT_CLASS_NAME, componentName.getClassName())
        .build();

return new OneTimeWorkRequest.Builder(ExampleRemoteListenableWorker.class)
        .setInputData(data)
        .build();

Для каждого RemoteWorkerService вам также необходимо добавить определение службы в файл AndroidManifest.xml :

<manifest ... >
    <service
            android:name="androidx.work.multiprocess.RemoteWorkerService"
            android:exported="false"
            android:process=":worker1" />

        <service
            android:name=".RemoteWorkerService2"
            android:exported="false"
            android:process=":worker2" />
    ...
</manifest>

Образцы