CompletableFuture的使用记录

电玩女神 2023-10-06 14:52 18阅读 0赞

#### jdk 1.8的新特性 CompletableFuture ####

最近在项目开发中 用到了 java 8提供异步编程的新的工具, CompletableFuture 这是 Java8 带来的一个非常好用的用于异步编程的类。  
这个类 在 java.util.concurrent 并发包下,  
java.util.concurrent.CompletableFuture 继承于java.util.concurrent.Future

###### 简单描述 一下 Future ######

一个Future接口表示一个未来可能会返回的结果，它定义的方法有：

*  get()：获取结果（可能会等待）
 *  get(long timeout, TimeUnit unit)：获取结果，但只等待指定的时间；
 *  cancel(boolean mayInterruptIfRunning)：取消当前任务；
 *  isDone()：判断任务是否已完成。

###### CompletableFuture 与 Future对比 ######

Future 的缺陷 如下:

1.  Future虽然可以实现异步获取线程的执行结果，但是future没有提供通知机制，调用方无法得知future什么时候执行完的问题。
2.  要么使用阻塞， 在future.get()的地方等待future返回结果，这时  
    会变成同步操作。如果使用isDone()方法进行循环判断，就会消耗cpu资源。  
    CompletableFuture 它的比 Future 优势 在于 异步回调/转换,这能使得  
    任何线程在任何时刻都可以设置CompletableFuture的值.

#### CompletableFuture提供的方法和具体用法 ####

###### 1 怎么用 CompletableFuture? ######

在我们操作想用这个线程类的时候,实例化 是一种方式.

CompletableFuture<String> future = new CompletableFuture<String>();
 // 这个就是它可以在任何时候红设置 CompletableFuture的值
 // 可以选择在当前线程结束，也可以在其他线程结束
 cf.complete("要执行的代码");

想获取结果  
String res= cf.get(); 还可以用 join() 的方法,功能个 get() 一样,都是阻塞获取值,  
但是使用join( ) 会抛出 unchecked Exception异常.

###### 2 CompletableFuture的 4种 静态方法 (开发常用) ######

public static CompletableFuture<Void> runAsync(Runnable runnable)
 public static CompletableFuture<Void> runAsync(Runnable runnable, Executor executor)
 public static CompletableFuture supplyAsync(Supplier supplier)
 public static CompletableFuture supplyAsync(Supplier supplier, Executor executor)

这里说一下 如果没有指定Executor的方法会使用ForkJoinPool.commonPool()  
作为它的线程池执行异步代码。如果指定线程池，则使用指定的线程池运行。  
调用方法:  
runAsync方法不支持返回值。  
supplyAsync可以支持返回值。  
demo 代码示例

###### 3 任务计算完成时的回调方法 ######

public 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)
 public CompletableFuture<T> exceptionally(Function<Throwable,? extends T> fn)

可以看到Action的类型是BiConsumer<? super T,? super Throwable>它可以处理正常的计算结果，或者异常情况。

whenComplete 和 whenCompleteAsync 的区别：  
whenComplete：是执行当前任务的线程执行继续执行 whenComplete 的任务。  
whenCompleteAsync：是执行把 whenCompleteAsync 这个任务继续提交给线程池来进行执行.

###### 4 thenApply 方法 ######

当一个线程依赖另一个线程时，可以使用 thenApply 方法来把这两个线程串行化

public CompletableFuture thenApply(Function<? super T,? extends U> fn)
 public CompletableFuture thenApplyAsync(Function<? super T,? extends U> fn)
 public CompletableFuture thenApplyAsync(Function<? super T,? extends U> fn, Executor executor)

Function<? super T,? extends U> 
T：上一个任务返回结果的类型 
U：当前任务的返回值类型

###### 5 handle 方法 ######

handle 是执行任务完成时对结果的处理。  
handle 方法和 thenApply 方法处理方式基本一样。不同的是 handle 是在任务完成后再执行，还可以处理异常的任务。thenApply 只可以执行正常的任务，任务出现异常则不执行 thenApply 方法。

public CompletionStage handle(BiFunction<? super T, Throwable, ? extends U> fn);
 public CompletionStage handleAsync(BiFunction<? super T, Throwable, ? extends U> fn);
 public CompletionStage handleAsync(BiFunction<? super T, Throwable, ? extends U> fn,Executor executor);

###### 6 thenAccept 消费处理结果 / thenRun 方法 ######

接收任务的处理结果，并消费处理，无返回结果。

public CompletionStage<Void> thenAccept(Consumer<? super T> action);
 public CompletionStage<Void> thenAcceptAsync(Consumer<? super T> action);
 public CompletionStage<Void> thenAcceptAsync(Consumer<? super T> action,Executor executor);

public CompletionStage<Void> thenRun(Runnable action);
 public CompletionStage<Void> thenRunAsync(Runnable action);
 public CompletionStage<Void> thenRunAsync(Runnable action,Executor executor);

thenRun 方法 跟 thenAccept 方法不一样的是，不关心任务的处理结果。  
只要上面的任务执行完成，就开始执行 thenAccept 。

###### 7 thenCombine 合并任务 ######

thenCombine 会把 两个 CompletionStage 的任务都执行完成后，把两个任务的结果一块交给 thenCombine 来处理。

public <U,V> CompletionStage<V> thenCombine(CompletionStage<? extends U> other,BiFunction<? super T,? super U,? extends V> fn);
 public <U,V> CompletionStage<V> thenCombineAsync(CompletionStage<? extends U> other,BiFunction<? super T,? super U,? extends V> fn);
 public <U,V> CompletionStage<V> thenCombineAsync(CompletionStage<? extends U> other,BiFunction<? super T,? super U,? extends V> fn,Executor executor);