Java CompletableFuture 详解

source: http://www.tuicool.com/articles/UVrMNrN

Java CompletableFuture 详解

时间 2016-02-29 16:49:32 colobu bolg

原文  http://colobu.com/2016/02/29/Java-CompletableFuture/

主题 Java

Future是Java 5添加的类，用来描述一个异步计算的结果。你可以使用 isDone方法检查计算是否完成，或者使用 get阻塞住调用线程，直到计算完成返回结果，你也可以使用 cancel方法停止任务的执行。

publicclassBasicFuture{
publicstaticvoidmain(String[] args)throwsExecutionException, InterruptedException {
 ExecutorService es = Executors.newFixedThreadPool(10);
 Future f = es.submit(() ->{
// 长时间的异步计算
// ……
// 然后返回结果
return100;
 });
// while(!f.isDone())
// ;
 f.get();
 }
}

虽然 Future以及相关使用方法提供了异步执行任务的能力，但是对于结果的获取却是很不方便，只能通过阻塞或者轮询的方式得到任务的结果。阻塞的方式显然和我们的异步编程的初衷相违背，轮询的方式又会耗费无谓的CPU资源，而且也不能及时地得到计算结果，为什么不能用观察者设计模式当计算结果完成及时通知监听者呢？

很多语言，比如Node.js，采用回调的方式实现异步编程。Java的一些框架，比如Netty，自己扩展了Java的 Future接口，提供了 addListener等多个扩展方法：

ChannelFuture future = bootstrap.connect(newInetSocketAddress(host, port));
 future.addListener(newChannelFutureListener()
 {
@Override
publicvoidoperationComplete(ChannelFuture future)throwsException
 {
if(future.isSuccess()) {
// SUCCESS
 }
else{
// FAILURE
 }
 }
 });

Google guava也提供了通用的扩展Future: ListenableFuture、 SettableFuture以及辅助类 Futures等,方便异步编程。

finalString name = ...;
inFlight.add(name);
ListenableFuture future = service.query(name);
future.addListener(newRunnable() {
publicvoidrun() {
 processedCount.incrementAndGet();
 inFlight.remove(name);
 lastProcessed.set(name);
 logger.info("Done with {0}", name);
 }
}, executor);

Scala也提供了简单易用且功能强大的Future/Promise 异步编程模式。

作为正统的Java类库，是不是应该做点什么，加强一下自身库的功能呢？

在Java 8中, 新增加了一个包含50个方法左右的类: CompletableFuture，提供了非常强大的Future的扩展功能，可以帮助我们简化异步编程的复杂性，提供了函数式编程的能力，可以通过回调的方式处理计算结果，并且提供了转换和组合CompletableFuture的方法。

下面我们就看一看它的功能吧。

主动完成计算

CompletableFuture类实现了 CompletionStage和 Future接口，所以你还是可以像以前一样通过阻塞或者轮询的方式获得结果，尽管这种方式不推荐使用。

publicTget()
publicTget(longtimeout, TimeUnit unit)
publicTgetNow(T valueIfAbsent)
publicTjoin()

getNow有点特殊，如果结果已经计算完则返回结果或者抛出异常，否则返回给定的 valueIfAbsent值。

join返回计算的结果或者抛出一个unchecked异常(CompletionException)，它和 get对抛出的异常的处理有些细微的区别，你可以运行下面的代码进行比较：

CompletableFuture future = CompletableFuture.supplyAsync(() -> { inti =1/0; return100; });
//future.join();
future.get();

尽管Future可以代表在另外的线程中执行的一段异步代码，但是你还是可以在本身线程中执行：

publicstaticCompletableFuture<Integer>compute() {
finalCompletableFuture<Integer> future =newCompletableFuture<>();

returnfuture;
}

上面的代码中 future没有关联任何的 Callback、线程池、异步任务等，如果客户端调用 future.get就会一致傻等下去。你可以通过下面的代码完成一个计算，触发客户端的等待：

f.complete(100);

当然你也可以抛出一个异常，而不是一个成功的计算结果：

f.completeExceptionally(newException());

完整的代码如下：

publicclassBasicMain{
publicstaticCompletableFuture<Integer>compute() {
finalCompletableFuture<Integer> future =newCompletableFuture<>();
returnfuture;
 }
publicstaticvoidmain(String[] args)throwsException {
finalCompletableFuture<Integer> f = compute();
 class Client extends Thread {
 CompletableFuture<Integer> f;
 Client(String threadName, CompletableFuture<Integer> f) {
super(threadName);
this.f = f;
 }
@Override
publicvoidrun() {
try{
 System.out.println(this.getName() +": "+ f.get());
 } catch(InterruptedException e) {
 e.printStackTrace();
 } catch(ExecutionException e) {
 e.printStackTrace();
 }
 }
 }
newClient("Client1", f).start();
newClient("Client2", f).start();
 System.out.println("waiting");
 f.complete(100);
//f.completeExceptionally(new Exception());
 System.in.read();
 }
}

可以看到我们并没有把 f.complete(100);放在另外的线程中去执行，但是在大部分情况下我们可能会用一个线程池去执行这些异步任务。 CompletableFuture.complete()、 CompletableFuture.completeExceptionally只能被调用一次。但是我们有两个后门方法可以重设这个值: obtrudeValue、 obtrudeException，但是使用的时候要小心，因为 complete已经触发了客户端，有可能导致客户端会得到不期望的结果。

创建CompletableFuture对象。

CompletableFuture.completedFuture是一个静态辅助方法，用来返回一个已经计算好的 CompletableFuture。

publicstatic<U> CompletableFuture<U>completedFuture(U value)

而以下四个静态方法用来为一段异步执行的代码创建 CompletableFuture对象：

publicstaticCompletableFuture<Void>runAsync(Runnable runnable)
publicstaticCompletableFuture<Void>runAsync(Runnable runnable, Executor executor)
publicstatic<U> CompletableFuture<U>supplyAsync(Supplier<U> supplier)
publicstatic<U> CompletableFuture<U>supplyAsync(Supplier<U> supplier, Executor executor)

以 Async结尾并且没有指定 Executor的方法会使用 ForkJoinPool.commonPool()作为它的线程池执行异步代码。

runAsync方法也好理解，它以 Runnable函数式接口类型为参数，所以 CompletableFuture的计算结果为空。

supplyAsync方法以 Supplier函数式接口类型为参数, CompletableFuture的计算结果类型为 U。

因为方法的参数类型都是函数式接口，所以可以使用lambda表达式实现异步任务，比如：

CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> {
//长时间的计算任务
return"·00";
});

计算结果完成时的处理

当 CompletableFuture的计算结果完成，或者抛出异常的时候，我们可以执行特定的 Action。主要是下面的方法：

publicCompletableFuturewhenComplete(BiConsumer<?superT,?superThrowable> action)
publicCompletableFuturewhenCompleteAsync(BiConsumer<?superT,?superThrowable> action)
publicCompletableFuturewhenCompleteAsync(BiConsumer<?superT,?superThrowable> action, Executor executor)
publicCompletableFutureexceptionally(Function,? extends T> fn)

可以看到 Action的类型是 BiConsumer，它可以处理正常的计算结果，或者异常情况。

方法不以 Async结尾，意味着 Action使用相同的线程执行，而 Async可能会使用其它的线程去执行(如果使用相同的线程池，也可能会被同一个线程选中执行)。

注意这几个方法都会返回 CompletableFuture，当 Action执行完毕后它的结果返回原始的 CompletableFuture的计算结果或者返回异常。

publicclassMain{
privatestaticRandom rand =newRandom();
privatestaticlongt = System.currentTimeMillis();
staticintgetMoreData() {
 System.out.println("begin to start compute");
try{
 Thread.sleep(10000);
 } catch(InterruptedException e) {
thrownewRuntimeException(e);
 }
 System.out.println("end to start compute. passed "+ (System.currentTimeMillis() - t)/1000+" seconds");
returnrand.nextInt(1000);
 }
publicstaticvoidmain(String[] args)throwsException {
 CompletableFuture future = CompletableFuture.supplyAsync(Main::getMoreData);
 Future f = future.whenComplete((v, e) -> { System.out.println(v); System.out.println(e); });
 System.out.println(f.get());
 System.in.read();
 }
}

exceptionally方法返回一个新的CompletableFuture，当原始的CompletableFuture抛出异常的时候，就会触发这个CompletableFuture的计算，调用function计算值，否则如果原始的CompletableFuture正常计算完后，这个新的CompletableFuture也计算完成，它的值和原始的CompletableFuture的计算的值相同。也就是这个 exceptionally方法用来处理异常的情况。

下面一组方法虽然也返回CompletableFuture对象，但是对象的值和原来的CompletableFuture计算的值不同。当原先的CompletableFuture的值计算完成或者抛出异常的时候，会触发这个CompletableFuture对象的计算，结果由 BiFunction参数计算而得。因此这组方法兼有 whenComplete和转换的两个功能。

public<U> CompletableFuture<U>handle(BiFunctionsuperT,Throwable,? extends U> fn)
public CompletableFuturehandleAsync(BiFunctionsuperT,Throwable,? extends U> fn)
public CompletableFuturehandleAsync(BiFunctionsuperT,Throwable,? extends U> fn, Executor executor)

同样，不以 Async结尾的方法由原来的线程计算，以 Async结尾的方法由默认的线程池 ForkJoinPool.commonPool()或者指定的线程池 executor运行。

转换

CompletableFuture可以作为monad(单子)和functor。由于回调风格的实现，我们不必因为等待一个计算完成而阻塞着调用线程，而是告诉 CompletableFuture当计算完成的时候请执行某个 function。而且我们还可以将这些操作串联起来，或者将 CompletableFuture组合起来。

public CompletableFuturethenApply(FunctionsuperT,? extends U> fn) public<U> CompletableFuture<U>thenApplyAsync(Function fn) public<U> CompletableFuture<U>thenApplyAsync(Function fn, Executor executor) 

这一组函数的功能是当原来的CompletableFuture计算完后，将结果传递给函数 fn，将 fn的结果作为新的 CompletableFuture计算结果。因此它的功能相当于将 CompletableFuture转换成 CompletableFuture。

这三个函数的区别和上面介绍的一样，不以 Async结尾的方法由原来的线程计算，以 Async结尾的方法由默认的线程池 ForkJoinPool.commonPool()或者指定的线程池 executor运行。Java的CompletableFuture类总是遵循这样的原则，下面就不一一赘述了。

使用例子如下：

CompletableFuture future = CompletableFuture.supplyAsync(() -> { return100; });
CompletableFuture<String> f = future.thenApplyAsync(i -> i * 10).thenApply(i -> i.toString());
System.out.println(f.get()); //"1000"

需要注意的是，这些转换并不是马上执行的，也不会阻塞，而是在前一个stage完成后继续执行。

它们与 handle方法的区别在于 handle方法会处理正常计算值和异常，因此它可以屏蔽异常，避免异常继续抛出。而 thenApply方法只是用来处理正常值，因此一旦有异常就会抛出。

纯消费(执行Action)

上面的方法是当计算完成的时候，会生成新的计算结果( thenApply, handle)，或者返回同样的计算结果 whenComplete， CompletableFuture还提供了一种处理结果的方法，只对结果执行 Action,而不返回新的计算值，因此计算值为 Void:

publicCompletableFuturethenAccept(Consumer<?superT> action)
publicCompletableFuturethenAcceptAsync(Consumer<?superT> action)
publicCompletableFuturethenAcceptAsync(Consumer<?superT> action, Executor executor)

看它的参数类型也就明白了，它们是函数式接口 Consumer，这个接口只有输入，没有返回值。

CompletableFuture future = CompletableFuture.supplyAsync(() -> { return100; });
CompletableFuture<Void> f = future.thenAccept(System.out::println);
System.out.println(f.get());

thenAcceptBoth以及相关方法提供了类似的功能，当两个CompletionStage都正常完成计算的时候，就会执行提供的 action，它用来组合另外一个异步的结果。

runAfterBoth是当两个CompletionStage都正常完成计算的时候,执行一个Runnable，这个Runnable并不使用计算的结果。

public<U> CompletableFuture<Void>thenAcceptBoth(CompletionStage extends U> other, BiConsumersuperT,?superU> action)
public CompletableFuturethenAcceptBothAsync(CompletionStage extends U> other, BiConsumersuperT,?superU> action)
public CompletableFuturethenAcceptBothAsync(CompletionStage extends U> other, BiConsumersuperT,?superU> action, Executor executor)
publicCompletableFuturerunAfterBoth(CompletionStage> other, Runnable action)

例子如下：

CompletableFuture future = CompletableFuture.supplyAsync(() -> { return100; });
CompletableFuture<Void> f = future.thenAcceptBoth(CompletableFuture.completedFuture(10), (x, y) -> System.out.println(x * y));
System.out.println(f.get());

更彻底地，下面一组方法当计算完成的时候会执行一个Runnable,与 thenAccept不同，Runnable并不使用CompletableFuture计算的结果。

publicCompletableFuturethenRun(Runnable action)
publicCompletableFuturethenRunAsync(Runnable action)
publicCompletableFuturethenRunAsync(Runnable action, Executor executor)

因此先前的CompletableFuture计算的结果被忽略了,这个方法返回 CompletableFuture类型的对象。

CompletableFuture future = CompletableFuture.supplyAsync(() -> { return100; });
CompletableFuture<Void> f = future.thenRun(() -> System.out.println("finished"));
System.out.println(f.get());

因此，你可以根据方法的参数的类型来加速你的记忆。 Runnable类型的参数会忽略计算的结果， Consumer是纯消费计算结果， BiConsumer会组合另外一个 CompletionStage纯消费， Function会对计算结果做转换， BiFunction会组合另外一个 CompletionStage的计算结果做转换。

组合

public CompletableFuturethenCompose(Function> fn)
public CompletableFuturethenComposeAsync(Function> fn)
public CompletableFuturethenComposeAsync(Function> fn, Executor executor)

这一组方法接受一个Function作为参数，这个Function的输入是当前的CompletableFuture的计算值，返回结果将是一个新的CompletableFuture，这个新的CompletableFuture会组合原来的CompletableFuture和函数返回的CompletableFuture。因此它的功能类似:

A +--> B +---> C

记住， thenCompose返回的对象并不一是函数 fn返回的对象，如果原来的 CompletableFuture还没有计算出来，它就会生成一个新的组合后的CompletableFuture。

例子：

CompletableFuture future = CompletableFuture.supplyAsync(() -> { return100; });
CompletableFuture<String> f = future.thenCompose( i -> { returnCompletableFuture.supplyAsync(() -> { return(i *10) +""; }); });
System.out.println(f.get()); //1000

而下面的一组方法 thenCombine用来复合另外一个CompletionStage的结果。它的功能类似：

A +
  |
  +------> C
  +------^
B +

两个CompletionStage是并行执行的，它们之间并没有先后依赖顺序， other并不会等待先前的 CompletableFuture

执行完毕后再执行。

public<U,V> CompletableFuture<V>thenCombine(CompletionStage extends U> other, BiFunctionsuperT,?superU,? extends V> fn)
public CompletableFuturethenCombineAsync(CompletionStage extends U> other, BiFunctionsuperT,?superU,? extends V> fn)
public CompletableFuturethenCombineAsync(CompletionStage extends U> other, BiFunctionsuperT,?superU,? extends V> fn, Executor executor)

其实从功能上来讲,它们的功能更类似 thenAcceptBoth，只不过 thenAcceptBoth是纯消费，它的函数参数没有返回值，而 thenCombine的函数参数 fn有返回值。

CompletableFuture future = CompletableFuture.supplyAsync(() -> { return100; });
CompletableFuture<String> future2 = CompletableFuture.supplyAsync(() -> { return"abc"; });
CompletableFuture<String> f = future.thenCombine(future2, (x,y) -> y + "-"+ x);
System.out.println(f.get()); //abc-100

Either

thenAcceptBoth和 runAfterBoth是当两个CompletableFuture都计算完成，而我们下面要了解的方法是当任意一个CompletableFuture计算完成的时候就会执行。

publicCompletableFuture<Void>acceptEither(CompletionStage extends T> other, ConsumersuperT> action)
publicCompletableFutureacceptEitherAsync(CompletionStage extends T> other, ConsumersuperT> action)
publicCompletableFutureacceptEitherAsync(CompletionStage extends T> other, ConsumersuperT> action, Executor executor)

public CompletableFutureapplyToEither(CompletionStage extends T> other, FunctionsuperT,U> fn) public<U> CompletableFuture<U>applyToEitherAsync(CompletionStage other, Function fn) public<U> CompletableFuture<U>applyToEitherAsync(CompletionStage other, Function fn, Executor executor) 

acceptEither方法是当任意一个CompletionStage完成的时候， action这个消费者就会被执行。这个方法返回 CompletableFuture
applyToEither方法是当任意一个CompletionStage完成的时候， fn会被执行，它的返回值会当作新的 CompletableFuture的计算结果。

下面这个例子有时会输出 100,有时候会输出 200,哪个Future先完成就会根据它的结果计算。

Random rand = newRandom();
CompletableFuture future = CompletableFuture.supplyAsync(() -> { try{ Thread.sleep(10000+ rand.nextInt(1000)); } catch(InterruptedException e) { e.printStackTrace(); } return100; });
CompletableFuture<Integer> future2 = CompletableFuture.supplyAsync(() -> { try{ Thread.sleep(10000+ rand.nextInt(1000)); } catch(InterruptedException e) { e.printStackTrace(); } return200; });
CompletableFuture<String> f = future.applyToEither(future2,i -> i.toString());

辅助方法 allOf和 anyOf

前面我们已经介绍了几个静态方法： completedFuture、 runAsync、 supplyAsync,下面介绍的这两个方法用来组合多个CompletableFuture。

publicstaticCompletableFuture<Void>allOf(CompletableFuture>... cfs)
publicstaticCompletableFuture