Google は、黒人コミュニティに対する人種平等の促進に取り組んでいます。取り組みを見る

ListenableWorker でのスレッド化

状況によっては、カスタムのスレッド戦略が必要になることもあります。たとえば、コールバック ベースの非同期操作への対処が必要になることがあります。この場合、ブロック方式で処理を行うことはできないため、単純に Worker を使用することはできません。WorkManager は ListenableWorker を通じてこのようなユースケースに対応します。ListenableWorker は最下位レベルの Worker API です。WorkerCoroutineWorkerRxWorker はすべて、このクラスの派生クラスです。ListenableWorker は、処理の開始および停止のタイミングのみを通知し、スレッド化はすべてデベロッパーに委ねられます。処理の開始通知はメインスレッドで行われるため、選択したバックグラウンド スレッドに手動で移動することが非常に重要です。

抽象メソッド ListenableWorker.startWork() は、ResultListenableFuture を返します。ListenableFuture は軽量のインターフェースで、リスナーのアタッチと例外の伝達を行う機能を提供する Future です。startWork メソッドでは、ListenableFuture を返すことが求められます。このクラスは、処理の完了後にその Result を使用して設定します。ListenableFuture は次のいずれかの方法で作成できます。

  1. Guava を使用する場合、ListeningExecutorService を使用する。
  2. Guava を使用していない場合は、gradle ファイルに councurrent-futures を追加して CallbackToFutureAdapter を使用する。

非同期コールバックに基づいてなんらかの処理を実行する場合は、次のようにします。

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.google.com", callback);
            }
            return callback;
        });
    }
}

処理が停止された場合はどうなるでしょうか。処理の停止が期待される場合は、ListenableWorkerListenableFuture を必ずキャンセルします。そのため、CallbackToFutureAdapter を使用して、次のようにキャンセル リスナーを追加する必要があります。

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.google.com", callback);
            }
            return callback;
        });
    }
}