wiki
CompletableFuture
类实现了CompletionStage
接口,它代表了一个特定的计算的阶段,可以同步或者异步的被完成。可以把它看成一个计算流水线上的一个单元,最终会产生一个最终结果,这意味着几个CompletionStage
可以串联起来,一个完成的阶段可以触发下一阶段的执行,接着触发下一次。CompletableFuture
也实现了future
接口,代表一个未完成的异步事件。其提供了方法,能够显式地完成这个future
,所以它叫CompletableFuture
。
1. 总览
1. 创建异步任务
runAsync
: 执行任务, 无返回值1
2
3
4//使用默认内置线程池ForkJoinPool.commonPool(),根据runnable构建执行任务
public static CompletableFuture<Void> runAsync(Runnable runnable)
//自定义线程,根据runnable构建执行任务
public static CompletableFuture<Void> runAsync(Runnable runnable, Executor executor)supplyAsync
: 执行任务, 有返回值1
2
3
4//使用默认内置线程池 ForkJoinPool.commonPool(),根据 supplier 构建执行任务
public static <U> CompletableFuture<U> supplyAsync(Supplier<U> supplier)
//自定义线程池,根据 supplier 构建执行任务
public static <U> CompletableFuture<U> supplyAsync(Supplier<U> supplier, Executor executor)
2. 任务异步回调
thenRun/thenRunAsync
: 第一个任务完成后, 执行第二个任务, 两者间无传参, 后者无返回值1
2
3// 两者区别是前者与调用它的任务共用一个线程池, 后者会新创建一个线程池
public CompletableFuture<Void> thenRun(Runnable action)
public CompletableFuture<Void> thenRunAsync(Runnable action)thenAccept/thenAcceptAsync
: 第一个任务完成后, 会将该任务的执行结果传递到第二个方法中, 两者间有传参, 后者无返回值1
2public CompletableFuture<Void> thenAccept(Consumer<? super T> action)
public CompletableFuture<Void> thenAcceptAsync(Consumer<? super T> action)thenApply/thenApplyAsync
: 第一个任务完成后, 会将该任务的执行结果传递到第二个方法中, 两者间有传参, 后者有返回值1
2
3public <U> CompletableFuture<U> thenApply(Function<? super T,? extends U> fn)
public <U> CompletableFuture<U> thenApplyAsync(Function<? super T,? extends U> fn)
public <U> CompletableFuture<U> thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)exceptionally
: 某个任务执行异常时, 执行的回调方法, 并且有抛出异常作为参数, 传递到回调方法1
public CompletableFuture<T> exceptionally(Function<Throwable, ? extends T> fn)
whenComplete/whenCompleteAsync
: 某个任务执行完成后,执行的回调方法,无返回值;并且该方法返回的CompletableFuture的result是上个任务的结果1
2
3public CompletableFuture<T> whenComplete(BiConsumer<? super T, ? super Throwable> action)
public CompletableFuture<T> whenCompleteAsync(BiConsumer<? super T, ? super Throwable> action)
public CompletableFuture<T> whenCompleteAsync(BiConsumer<? super T, ? super Throwable> action, Executor executor)handle
: 某个任务执行完成后,执行回调方法,有返回值的; 并且该方法返回的CompletableFuture的result是回调方法执行的结果1
2
3public <U> CompletableFuture<U> handle(BiFunction<? super T, Throwable, ? extends U> fn)
public <U> CompletableFuture<U> handleAsync(BiFunction<? super T, Throwable, ? extends U> fn)
public <U> CompletableFuture<U> handleAsync(BiFunction<? super T, Throwable, ? extends U> fn, Executor executor)
3. 多任务组合处理
1. 组合多个 CompletableFuture 静态方法
allOf
: 所有任务都执行完成后, 才执行 allOf 返回的 CompletableFuture, 如果任意一个任务异常, allOf 的 CompletableFuture 执行 get 方法, 会抛出异常anyOf
: 任意任务都执行完成后, 就执行 AnyOf 返回的 CompletableFuture, 如果任意一个任务异常, allOf 的 CompletableFuture 执行 get 方法, 会抛出异常1
2public static CompletableFuture<Void> allOf(CompletableFuture<?>... cfs)
public static CompletableFuture<Object> anyOf(CompletableFuture<?>... cfs)
2. AND : 组合两个 CompletableFuture, 当两者正常执行后, 就执行某个任务
runAfterBoth/runAfterBothAsync
: 不会把执行结果当做方法入参, 且无返回值thenAcceptBoth/thenAcceptBothAsync
: 会将两个任务的执行结果作为方法入参, 传递到指定方法中, 且无返回值thenCombine/thenCombineAsync
: 会将两个任务的执行结果作为方法入参, 传递到指定方法中, 且有返回值1
2
3
4
5
6
7
8
9
10
11public CompletableFuture<Void> runAfterBoth(CompletionStage<?> other, Runnable action)
public CompletableFuture<Void> runAfterBothAsync(CompletionStage<?> other, Runnable action)
public CompletableFuture<Void> runAfterBothAsync(CompletionStage<?> other, Runnable action, Executor executor)
public <U> CompletableFuture<Void> thenAcceptBoth(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action)
public <U> CompletableFuture<Void> thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action)
public <U> CompletableFuture<Void> thenAcceptBothAsync(CompletionStage<? extends U> other, BiConsumer<? super T, ? super U> action, Executor executor)
public <U,V> CompletableFuture<V> thenCombine(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
public <U,V> CompletableFuture<V> thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn)
public <U,V> CompletableFuture<V> thenCombineAsync(CompletionStage<? extends U> other, BiFunction<? super T,? super U,? extends V> fn, Executor executor)
3. OR : 组合两个 CompletableFuture, 只要其中一个正常执行后, 就执行某个任务
runAfterEither
: 不会把执行结果当做方法入参, 且无返回值。acceptEither
: 会将已经执行完成的任务结果作为方法入参, 传递到指定方法中, 且无返回值applyToEither
: 会将已经执行完成的任务结果作为方法入参, 传递到指定方法中, 且有返回值1
2
3
4
5
6
7
8
9
10
11public CompletableFuture<Void> runAfterEither(CompletionStage<?> other, Runnable action)
public CompletableFuture<Void> runAfterEitherAsync(CompletionStage<?> other, Runnable action)
public CompletableFuture<Void> runAfterEitherAsync(CompletionStage<?> other, Runnable action, Executor executor)
public CompletableFuture<Void> acceptEither(CompletionStage<? extends T> other, Consumer<? super T> action)
public CompletableFuture<Void> acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action)
public CompletableFuture<Void> acceptEitherAsync(CompletionStage<? extends T> other, Consumer<? super T> action, Executor executor)
public <U> CompletableFuture<U> applyToEither(CompletionStage<? extends T> other, Function<? super T, U> fn)
public <U> CompletableFuture<U> applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T, U> fn)
public <U> CompletableFuture<U> applyToEitherAsync(CompletionStage<? extends T> other, Function<? super T, U> fn, Executor executor)
4. thenCompose/thenComposeAsync
该方法会在某个任务执行完成后, 将该任务的执行结果作为方法入参, 去执行指定的方法, 该方法会返回一个新的 CompletableFuture 实例
- 如果该 CompletableFuture 实例的 result 不为 null,则返回一个基于该 result 新的 CompletableFuture 实例
- 如果该 CompletableFuture 实例为 null,然后就执行这个新任务
1
2
3public <U> CompletableFuture<U> thenCompose(Function<? super T, ? extends CompletionStage<U>> fn)
public <U> CompletableFuture<U> thenComposeAsync(Function<? super T, ? extends CompletionStage<U>> fn)
public <U> CompletableFuture<U> thenComposeAsync(Function<? super T, ? extends CompletionStage<U>> fn, Executor executor)
2. 实例
1. 创建一个完成的 CompletableFuture
使用一个预定义的结果创建一个完成的CompletableFuture
,通常我们会在计算的开始阶段使用它。
1 | static void completedFutureExample() { |
getNow(null)
方法在future
完成的情况下会返回结果,就比如上面这个例子,否则返回null
(传入的参数)。
2. 运行一个简单的异步阶段
创建一个一个异步执行的阶段:
1 | static void runAsyncExample() { |
CompletableFuture
的方法如果以Async
结尾,它会异步的执行(没有指定executor
的情况下), 异步执行通过ForkJoinPool
实现, 它使用守护线程去执行任务。注意这是CompletableFuture
的特性, 其它CompletionStage
可以override
这个默认的行为。
3. 在前一个阶段上应用函数
下面这个例子使用前面 #1 的完成的CompletableFuture
, #1返回结果为字符串 message ,然后应用一个函数把它变成大写字母。
1 | static void thenApplyExample() { |
注意thenApply
方法名称代表的行为。
then
意味着这个阶段的动作发生当前的阶段正常完成之后。本例中,当前节点完成,返回字符串 message 。Apply
意味着返回的阶段将会对结果前一阶段的结果应用一个函数。
函数的执行会被阻塞 ,这意味着getNow()
只有打斜操作被完成后才返回。
4. 在前一个阶段上异步应用函数
通过调用异步方法(方法后边加Async
后缀),串联起来的CompletableFuture
可以异步地执行(使用ForkJoinPool.commonPool()
)。
1 | static void thenApplyAsyncExample() { |
5. 使用定制的Executor
在前一个阶段上异步应用函数
异步方法一个非常有用的特性就是能够提供一个Executor
来异步地执行CompletableFuture
。这个例子演示了如何使用一个固定大小的线程池来应用大写函数。
1 | static ExecutorService executor = Executors.newFixedThreadPool(3, new ThreadFactory() { |
6. 消费前一阶段的结果
如果下一阶段接收了当前阶段的结果,但是在计算的时候不需要返回值(它的返回类型是 void), 那么它可以不应用一个函数,而是一个消费者, 调用方法也变成了thenAccept
:
1 | static void thenAcceptExample() { |
本例中消费者同步地执行,所以我们不需要在CompletableFuture
调用join
方法。
7. 异步地消费迁移阶段的结果
同样,可以使用thenAcceptAsync
方法, 串联的CompletableFuture
可以异步地执行。
1 | static void thenAcceptAsyncExample() { |
8. 完成计算异常
我们使用thenApplyAsync(Function, Executor)
方法,第一个参数传入大写函数, executor
是一个delayed executor
,在执行前会延迟一秒。
1 | static void completeExceptionallyExample() { |
首先我们创建了一个CompletableFuture
,完成后返回一个字符串 message ,接着我们调用thenApplyAsync
方法,它返回一个CompletableFuture
。这个方法在第一个函数完成后,异步地应用转大写字母函数。
这个例子还演示了如何通过delayedExecutor(timeout, timeUnit)
延迟执行一个异步任务。
我们创建了一个分离的handler
阶段:exceptionHandler
, 它处理异常异常,在异常情况下返回message upon cancel
。
下一步我们显式地用异常完成第二个阶段。在阶段上调用join
方法,它会执行大写转换,然后抛出CompletionException
(正常的join
会等待1秒,然后得到大写的字符串。不过我们的例子还没等它执行就完成了异常), 然后它触发了handler
阶段。
9. 取消计算
和完成异常类似,我们可以调用cancel(boolean mayInterruptIfRunning)
取消计算。对于CompletableFuture
类,布尔参数并没有被使用,这是因为它并没有使用中断去取消操作,相反,cancel
等价于completeExceptionally(new CancellationException())
。
1 | static void cancelExample() { |
10. 在两个完成的阶段其中之一上应用函数
下面的例子创建了CompletableFuture
,applyToEither
处理两个阶段,在其中之一上应用函数(包保证哪一个被执行)。本例中的两个阶段一个是应用大写转换在原始的字符串上, 另一个阶段是应用小写转换。
1 | static void applyToEitherExample() { |
11. 在两个完成的阶段其中之一上调用消费函数
和前一个例子很类似,只不过我们调用的是消费者函数 (Function
变成Consumer
):
1 | static void acceptEitherExample() { |
12. 在两个阶段都执行完后运行一个 Runnable
这个例子演示了依赖的CompletableFuture
如果等待两个阶段完成后执行了一个Runnable
。注意下面所有的阶段都是同步执行的,第一个阶段执行大写转换,第二个阶段执行小写转换。
1 | static void runAfterBothExample() { |
13. 使用 BiConsumer
处理两个阶段的结果
上面的例子还可以通过BiConsumer
来实现:
1 | static void thenAcceptBothExample() { |
14. 使用BiFunction
处理两个阶段的结果
如果CompletableFuture
依赖两个前面阶段的结果,它复合两个阶段的结果再返回一个结果,我们就可以使用thenCombine()
函数。整个流水线是同步的,所以getNow()
会得到最终的结果,它把大写和小写字符串连接起来。
1 | static void thenCombineExample() { |
15. 异步使用BiFunction
处理两个阶段的结果
类似上面的例子,但是有一点不同:依赖的前两个阶段异步地执行,所以thenCombine()
也异步地执行,即时它没有Async
后缀。
所以我们需要join
方法等待结果的完成。
1 | static void thenCombineAsyncExample() { |
16. 组合 CompletableFuture
我们可以使用thenCompose()
完成上面两个例子。这个方法等待第一个阶段的完成(大写转换), 它的结果传给一个指定的返回CompletableFuture
函数,它的结果就是返回的CompletableFuture
的结果。
看例子来理解。函数需要一个大写字符串做参数,然后返回一个CompletableFuture
,这个CompletableFuture
会转换字符串变成小写然后连接在大写字符串的后面。
1 | static void thenComposeExample() { |
17. 当几个阶段中的一个完成,创建一个完成的阶段
待处理的阶段首先创建, 每个阶段都是转换一个字符串为大写。因为本例中这些阶段都是同步地执行(thenApply
),从anyOf
中创建的CompletableFuture
会立即完成,这样所有的阶段都已完成,我们使用whenComplete(BiConsumer<? super Object, ? super Throwable> action)
处理完成的结果。
1 | static void anyOfExample() { |
18. 当所有的阶段都完成后创建一个阶段
上一个例子是当任意一个阶段完成后接着处理,接下来的两个例子演示当所有的阶段完成后才继续处理, 同步地方式和异步地方式两种。
1 | static void allOfExample() { |
19. 当所有的阶段都完成后异步地创建一个阶段
使用thenApplyAsync()
替换那些单个的CompletableFutures
的方法,allOf()
会在通用池中的线程中异步地执行。所以我们需要调用join
方法等待它完成。
1 | static void allOfAsyncExample() { |
20. 真实的例子
- 首先异步调用 cars 方法获得 Car 的列表,它返回
CompletionStage
场景。cars 消费一个远程的REST API
。 - 然后我们复合一个
CompletionStage
填写每个汽车的评分,通过rating(manufacturerId)
返回一个CompletionStage
,它会异步地获取汽车的评分(可能又是一个REST API
调用)。 - 当所有的汽车填好评分后,我们结束这个列表,所以我们调用
allOf
得到最终的阶段, 它在前面阶段所有阶段完成后才完成。 - 在最终的阶段调用
whenComplete()
,我们打印出每个汽车和它的评分。因为每个汽车的实例都是独立的,得到每个汽车的评分都可以异步地执行,这会提高系统的性能(延迟),而且,等待所有的汽车评分被处理使用的是1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18cars().thenCompose(cars -> {
List<CompletionStage> updatedCars = cars.stream()
.map(car -> rating(car.manufacturerId).thenApply(r -> {
car.setRating(r);
return car;
})).collect(Collectors.toList());
CompletableFuture done = CompletableFuture
.allOf(updatedCars.toArray(new CompletableFuture[updatedCars.size()]));
return done.thenApply(v -> updatedCars.stream().map(CompletionStage::toCompletableFuture)
.map(CompletableFuture::join).collect(Collectors.toList()));
}).whenComplete((cars, th) -> {
if (th == null) {
cars.forEach(System.out::println);
} else {
throw new RuntimeException(th);
}
}).toCompletableFuture().join();allOf
方法,而不是手工的线程等待(Thread#join()
或 一个CountDownLatch
)。