Android NDK开发详解后台任务之ListenableWorker 中的线程处理
在某些情况下,您可能需要提供自定义线程处理策略。例如,您可能需要处理基于回调的异步操作。 WorkManager 通过 ListenableWorker 支持此用例。ListenableWorker 是最基本的工作器 API;Worker、CoroutineWorker 和 RxWorker 均派生自此类。ListenableWorker 仅在工作应开始和停止时发出信号,而线程处理则完全由您自行决定。开始工作信号在主线程上调用,因此请务必手动转到您选择的后台线程。
抽象方法 ListenableWorker.startWork() 会返回 Result 的 ListenableFuture。ListenableFuture 是一个轻量级接口:它是一个 Future,可提供用于附加监听器和传播异常的功能。在 startWork 方法中,应返回 ListenableFuture,完成操作后,您将使用操作的 Result 设置它。您可以通过以下两种方式之一创建 ListenableFuture 实例:
如果您使用的是 Guava,请使用 ListeningExecutorService。
否则,请将 councurrent-futures 包含到 Gradle 文件中并使用 CallbackToFutureAdapter。
如果您想基于异步回调执行某些工作,可以采用如下方式:
Kotlin
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
}
}
}
Java
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;
});
}
}
如果您的工作停止,会发生什么情况?当工作预期停止时,系统始终会取消 ListenableWorker 的 ListenableFuture。使用 CallbackToFutureAdapter 时,您只需添加一个取消监听器,如下所示:
Kotlin
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
}
}
}
Java
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。
以下示例演示了如何构建绑定到特定进程的工作请求:
Kotlin
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()
Java
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>
示例
WorkManagerMultiProcessSample