处理并发是一个很困难的问题,但是我们可以通过使用功能强大的抽象来简化这个工作。为了简化这个问题,Guava 提供了 ListenableFuture,它继承了 JDK 中的 Future 接口。
我们强烈建议:在你的代码中,使用ListenableFuture 来替代 Future,因为
- 很多Future 相关的方法需要它。
- 一开始就使用 ListenableFuture会省事很多。
- 这样工具方法提供者就不需要针对 Future 和 ListenableFuture 都提供方法。
<meta charset="utf-8">
接口
Future
代表了异步执行的结果:一个可能还没有产生结果的执行过程。 Future
可以正在被执行,但是会保证返回一个结果。
ListenableFuture
可以使你注册回调函数,使得在结果计算完成的时候可以回调你的函数。如果结果已经算好,那么将会立即回调。这个简单的功能使得可以完成很多 Future
支持不了的操作。
ListenableFuture
添加的基本函数是 addListener(Runnable, Executor)
。通过这个函数,当 Future
中的结果执行完成时,传入的 Runnable
会在传入的 Executor
中执行。
添加回调函数
使用者偏向于使用 Futures.addCallback(ListenableFuture<V>, FutureCallback<V>, Executor)
, 或者当需要注册轻量级的回调的时候,可以使用默认为 MoreExecutors.directExecutor()
的版本。
FutureCallback<V>
实现了两个方法:
-
onSuccess(V)
:当 future 执行成功时候的反应。 -
onFailure(Throwable)
:当 future 执行失败时候的反应。
创建
与 JDK 中 通过 ExecutorService.submit(Callable)
来初始化一个异步的任务相似,Guava 提供了一个 ListeningExecutorService
接口,这个接口可以返回一个 ListenableFuture
(ExecutorService
只是返回一个普通的 Future
)。如果需要将一个 ExecutorService
转换为 ListeningExecutorService
,可以使用 MoreExecutors.listeningDecorator(ExecutorService)
。一个使用示例如下:
ListeningExecutorService service = MoreExecutors.listeningDecorator(Executors.newFixedThreadPool(10));
ListenableFuture<Explosion> explosion = service.submit(new Callable<Explosion>() {
public Explosion call() {
return pushBigRedButton();
}
});
Futures.addCallback(explosion, new FutureCallback<Explosion>() {
// we want this handler to run immediately after we push the big red button!
public void onSuccess(Explosion explosion) {
walkAwayFrom(explosion);
}
public void onFailure(Throwable thrown) {
battleArchNemesis(); // escaped the explosion!
}
});
如果你想从一个基于 FutureTask
的 API 转换过来,Guava 提供了 ListenableFutureTask.create(Callable<V>)
和 ListenableFutureTask.create(Runnable, V)
。和 JDK 不一样,ListenableFutureTask
并不意味着可以直接扩展。
如果你更喜欢可以设置 future 值的抽象,而不是实现一个方法来计算结果,那么可以考虑直接扩展 AbstractFuture<V>
或者 SettableFuture
。
如果你一定要将一个基于 Future
的 API 转换为基于 ListenableFuture
的话,你不得不采用硬编码的方式 JdkFutureAdapters.listenInPoolThread(Future)
来实现从 Future
到 ListenableFuture
的转换。所以,尽可能地使用 ListenableFuture
。
应用
使用 ListenableFuture
一个最重要的原因就是:可以基于他实现负责的异步执行链。如下所示:
ListenableFuture<RowKey> rowKeyFuture = indexService.lookUp(query);
AsyncFunction<RowKey, QueryResult> queryFunction =
new AsyncFunction<RowKey, QueryResult>() {
public ListenableFuture<QueryResult> apply(RowKey rowKey) {
return dataService.read(rowKey);
}
};
ListenableFuture<QueryResult> queryFuture =
Futures.transformAsync(rowKeyFuture, queryFunction, queryExecutor);
很多不能被 Future
支持的方法可以通过 ListenableFuture
被高效地支持。不同的操作可能被不同的执行器执行,而且一个 ListenableFuture
可以有多个响应操作。
当 ListenableFuture
有多个后续操作的时候,这样的操作称为:“扇出”。当它依赖多个输入 future 同时完成时,称作“扇入”。可以参考 Futures.allAsList
的实现。
方法 | 描述 | 参考 |
---|---|---|
transformAsync(ListenableFuture<A>, AsyncFunction<A, B>, Executor) |
返回新的 ListenableFuture ,它是给定 AsyncFunction 结合的结果 |
transformAsync(ListenableFuture<A>, AsyncFunction<A, B>) |
transform(ListenableFuture<A>, Function<A, B>, Executor) |
返回新的 ListenableFuture ,它是给定 Function 结合的结果 |
transform(ListenableFuture<A>, Function<A, B>) |
allAsList(Iterable<ListenableFuture<V>>) |
返回一个 ListenableFuture ,它的值是一个输入 futures 的值的按序列表,任何一个 future 的失败都会导致最后结果的失败 |
allAsList(ListenableFuture<V>...) |
successfulAsList(Iterable<ListenableFuture<V>>) |
返回一个 ListenableFuture ,它的值是一个输入 futures 的成功执行值的按序列表,对于取消或者失败的任务,对应的值是 null
|
successfulAsList(ListenableFuture<V>...) |
AsyncFunction<A, B>
提供了一个方法:ListenableFuture<B> apply(A input)
。可以被用来异步转换一个值。
List<ListenableFuture<QueryResult>> queries;
// The queries go to all different data centers, but we want to wait until they're all done or failed.
ListenableFuture<List<QueryResult>> successfulQueries = Futures.successfulAsList(queries);
Futures.addCallback(successfulQueries, callbackOnSuccessfulQueries);
避免嵌套 Future
在使用通用接口返回 Future
的代码中,很有可能会嵌套 Future
。例如:
executorService.submit(new Callable<ListenableFuture<Foo>() {
@Override
public ListenableFuture<Foo> call() {
return otherExecutorService.submit(otherCallable);
}
});
上述代码将会返回:ListenableFuture<ListenableFuture<Foo>>
。这样的代码是不正确的,因为外层 future 的取消操作不能传递到内层的 future。此外,一个常犯的错误是:使用 get()
或者 listener 来检测其它 future 的失败。为了避免这样的情况,Guava 所有处理 future 的方法(以及一些来自 JDK 的代码)具有安全解决嵌套的版本。
CheckedFuture
Guava 也提供 CheckedFuture<V, X extends Exception>
接口。
CheckedFuture
是这样的一个 ListenableFuture
:具有多个可以抛出受保护异常的 get
方法。这使得创建一个执行逻辑可能抛出异常的 future 变得容易。使用 Futures.makeChecked(ListenableFuture<V>, Function<Exception, X>)
可以将 ListenableFuture
转换为 CheckedFuture
。
测试demo
public class ListenableFutureDemo {
/**
* 执行任务器
*/
private static ListeningExecutorService listeningExecutorService =MoreExecutors.listeningDecorator(Executors.newCachedThreadPool());
/**
*
* @param args
* @throws Exception
*/
public static void main(String[] args)throws Exception {
ListenableFutureDemo demo=new ListenableFutureDemo();
long beginTime = System.currentTimeMillis();
System.out.println("begin:"+beginTime);
List<ListenableFuture<String>> futures = new ArrayList<ListenableFuture<String>>();
futures.add(demo.getPackingTask("获取商品信息",1500));
futures.add(demo.getPackingTask("获取商品扩展信息",1200));
futures.add(demo.getPackingTask("获取库存信息",800));
futures.addAll(demo.getDoublePackingTask(demo,"订单信息",1100,"订单明细",1200));
System.out.println("================================================================================");
// 阻塞三个线程执行完成
Futures.allAsList(futures).get();
long endTime = System.currentTimeMillis();
System.out.println("end:"+endTime);
long uesdTime = endTime-beginTime;
System.out.println("usedTime:"+uesdTime);
listeningExecutorService.shutdown();
}
/**
* 执行任务
*/
static class TaskInfo implements Callable<String> {
/**
* 任务名称
*/
private String taskName;
/**
* 执行实际
*/
private long executionTime;
@Override
public String call() throws Exception {
System.out.println("taskName:" + taskName+"&线程名"+Thread.currentThread().getName());
Thread.sleep(executionTime);
return "任务名称"+taskName+"&执行时间"+executionTime;
}
}
/**
* 封装包装任务
*/
public ListenableFuture<String> getPackingTask(String taskName,long executionTime) {
//创建一个线程实例
ListenableFutureDemo.TaskInfo packingTask = new ListenableFutureDemo.TaskInfo();
packingTask.taskName=taskName;
packingTask.executionTime=executionTime;
ListenableFuture<String> packingTaskfuture = listeningExecutorService.submit(packingTask);
/**
* FutureCallBack接口可以对每个任务的成功或失败单独做出响应
*/
FutureCallback<String> futureCallback = new FutureCallback<String>() {
/**
* 返回成功后在调用商品扩展信息
* @param result
*/
@Override
public void onSuccess(String result) {
System.out.println("返回值:" + result+"&线程名"+Thread.currentThread().getName());
}
@Override
public void onFailure(Throwable t) {
System.out.println("返回值:"+t.getMessage()+"&线程名"+Thread.currentThread().getName());
}
};
/**
* 执行回调函数的是主线程或执行任务的线程
*/
Futures.addCallback(packingTaskfuture, futureCallback, MoreExecutors.directExecutor());
return packingTaskfuture;
}
/**
* 封装包装任务,包含子任务,既等父任务执行完,立马执行子任务
*/
public List<ListenableFuture<String>> getDoublePackingTask(ListenableFutureDemo demo, String taskName, long executionTime, String childTaskName, long childExecutionTime) {
List<ListenableFuture<String>> futures = new ArrayList<ListenableFuture<String>>();
ListenableFutureDemo.TaskInfo packingTask = new ListenableFutureDemo.TaskInfo();
packingTask.taskName = taskName;
packingTask.executionTime = executionTime;
ListenableFuture<String> packingTaskfuture = listeningExecutorService.submit(packingTask);
/**
* 监听器添加子任务
*/
packingTaskfuture.addListener(() -> {
futures.add(demo.getPackingTask(childTaskName, childExecutionTime));
}, listeningExecutorService);
futures.add(packingTaskfuture);
return futures;
}
}
返回结果
begin:1647350613374
taskName:获取商品信息&线程名pool-1-thread-1
taskName:获取商品扩展信息&线程名pool-1-thread-2
taskName:获取库存信息&线程名pool-1-thread-3
taskName:订单信息&线程名pool-1-thread-4
================================================================================
返回值:任务名称获取库存信息&执行时间800&线程名pool-1-thread-3
taskName:订单明细&线程名pool-1-thread-4
返回值:任务名称获取商品扩展信息&执行时间1200&线程名pool-1-thread-2
返回值:任务名称获取商品信息&执行时间1500&线程名pool-1-thread-1
end:1647350614910
usedTime:1536
返回值:任务名称订单明细&执行时间1200&线程名pool-1-thread-4
网友评论