CompletableFuture
请直接看原文:
异步编程利器：CompletableFuture详解 ｜Java 开发实战 - 掘金 (juejin.cn)
-------------------------------------------------------------------------------------------------------------------------------
前言
遇到了一个问题,使用多个异步的Future接口去处理多个异步任务,但是我需要用get()方法拿到这几个异步返回的结果,但是get()是阻塞的, 这又变成了同步, 怎么办
下面就是解决办法
几种多线程并发取结果方式的总结
下面我只重点讲CompletableFuture,因为CompletableFuture是目前最新推出的,功能最全的解决多线程异步取结果的实现方案.
CompletableFuture
CompletableFuture是jdk8的新特性。CompletableFuture实现了CompletionStage接口和Future接口，前者是对后者的一个扩展，增加了异步会点、流式处理、多个Future组合处理的能力，使Java在处理多任务的协同工作时更加顺畅便利。
来看下需求例子,异步执行3个任务,得到3个任务的返回值,如果返回的都是0,那么就代表成功,否则,就是失败.
public int doTask(XycFindDto xycFindDto) {
// 创建异步任务,同时执行3个异步任务
CompletableFuture punishmentInfoTask = CompletableFuture.supplyAsync(() -> tycLawPlusService.punishmentInfo(xycFindDto));
CompletableFuture executeListFindTask = CompletableFuture.supplyAsync(() -> tycLawPlusService.executeListFind(xycFindDto));
CompletableFuture loseCreditListFindTask = CompletableFuture.supplyAsync(() -> tycLawPlusService.loseCreditListFind(xycFindDto));
// 使用 CompletableFuture.allOf 等待所有任务完成
CompletableFuture allOf = CompletableFuture.allOf(punishmentInfoTask, executeListFindTask, loseCreditListFindTask);
// 在所有任务完成后，使用 join 获取各个任务的结果
try {
allOf.get(); // 等待所有任务完成 获得3个任务的返回值
Integer result1 = punishmentInfoTask.join();
Integer result2 = executeListFindTask.join();
Integer result3 = loseCreditListFindTask.join();
//如果返回值都为0,就代表成功,否则就代表失败
if (0 == result1 && 0 == result2 && 0 == result3) {
return 0;
}else {
return 1;
}
} catch (InterruptedException | ExecutionException e) {
e.printStackTrace();
return 1;
}
} CompletableFuture的方法
一、创建异步任务+获取返回结果
1. supplyAsync
supplyAsync是创建带有返回值的异步任务。它有如下两个方法，一个是使用默认线程池（ForkJoinPool.commonPool()）的方法，一个是带有自定义线程池的重载方法
// 带返回值异步请求，默认线程池
public static CompletableFuture supplyAsync(Supplier supplier)
// 带返回值的异步请求，可以自定义线程池
public static CompletableFuture supplyAsync(Supplier supplier, Executor executor)
测试代码：
public static void main(String[] args) throws ExecutionException, InterruptedException {
CompletableFuture cf = CompletableFuture.supplyAsync(() -> {
System.out.println("do something....");
return "result";
});
//等待任务执行完成
System.out.println("结果->" + cf.get());
}
public static void main(String[] args) throws ExecutionException, InterruptedException {
// 自定义线程池
ExecutorService executorService = Executors.newSingleThreadExecutor();
CompletableFuture cf = CompletableFuture.supplyAsync(() -> {
System.out.println("do something....");
return "result";
}, executorService);
//等待子任务执行完成
System.out.println("结果->" + cf.get());
} 测试结果：
2. runAsync
runAsync是创建没有返回值的异步任务。它有如下两个方法，一个是使用默认线程池（ForkJoinPool.commonPool()）的方法，一个是带有自定义线程池的重载方法
// 不带返回值的异步请求，默认线程池
public static CompletableFuture runAsync(Runnable runnable)
// 不带返回值的异步请求，可以自定义线程池
public static CompletableFuture runAsync(Runnable runnable, Executor executor) 3.获取任务结果的方法
// 如果完成则返回结果，否则就抛出具体的异常
public T get() throws InterruptedException, ExecutionException
// 最大时间等待返回结果，否则就抛出具体异常
public T get(long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException
// 完成时返回结果值，否则抛出unchecked异常。为了更好地符合通用函数形式的使用，如果完成此 CompletableFuture所涉及的计算引发异常，则此方法将引发unchecked异常并将底层异常作为其原因
public T join()
// 如果完成则返回结果值（或抛出任何遇到的异常），否则返回给定的 valueIfAbsent。
public T getNow(T valueIfAbsent)
// 如果任务没有完成，返回的值设置为给定值
public boolean complete(T value)
// 如果任务没有完成，就抛出给定异常
public boolean completeExceptionally(Throwable ex)
二、异步回调处理
1.thenApply和thenApplyAsync
thenApply 表示某个任务执行完成后执行的动作，即回调方法，会将该任务的执行结果即方法返回值作为入参传递到回调方法中，带有返回值。
从下面代码和测试结果我们发现thenApply和thenApplyAsync区别在于，使用thenApply方法时子任务与父任务使用的是同一个线程，而thenApplyAsync在子任务中是另起一个线程执行任务，并且thenApplyAsync可以自定义线程池，默认的使用ForkJoinPool.commonPool()线程池。
测试代码：
public static void main(String[] args) throws ExecutionException, InterruptedException {
CompletableFuture cf1 = CompletableFuture.supplyAsync(() -> {
System.out.println(Thread.currentThread() + " cf1 do something....");
return 1;
});
CompletableFuture cf2 = cf1.thenApplyAsync((result) -> {
System.out.println(Thread.currentThread() + " cf2 do something....");
result += 2;
return result;
});
//等待任务1执行完成
System.out.println("cf1结果->" + cf1.get());
//等待任务2执行完成
System.out.println("cf2结果->" + cf2.get());
}
public static void main(String[] args) throws ExecutionException, InterruptedException {
CompletableFuture cf1 = CompletableFuture.supplyAsync(() -> {
System.out.println(Thread.currentThread() + " cf1 do something....");
return 1;
});
CompletableFuture cf2 = cf1.thenApply((result) -> {
System.out.println(Thread.currentThread() + " cf2 do something....");
result += 2;
return result;
});
//等待任务1执行完成
System.out.println("cf1结果->" + cf1.get());
//等待任务2执行完成
System.out.println("cf2结果->" + cf2.get());
} 测试结果：
2.thenAccept和thenAcceptAsync
thenAccep表示某个任务执行完成后执行的动作，即回调方法，会将该任务的执行结果即方法返回值作为入参传递到回调方法中，无返回值。 测试参照1.thenApply和thenApplyAsync
3. thenRun 任务完成后触发的回调
thenRun 是上一个任务完成后触发的回调，没有入参，也没有返回值。
public CompletionStage thenRun(Runnable action);
public CompletionStage thenRunAsync(Runnable action);
public CompletionStage thenRunAsync(Runnable action,Executor executor);
需求：
- 在main线程里创建一个线程异步获取id=1的部门
- 上面线程结束后，执行thenRun里的回调，没有入参和返回值
public class Thread05_SupplyAsync_ThenRun {
public static void main(String[] args) throws ExecutionException, InterruptedException {
DeptService deptService = new DeptService();
CompletableFuture voidCompletableFuture = CompletableFuture.supplyAsync(() -> {
Dept dept = deptService.getById(1);
return dept;
})
.thenRun(() -> {//注意没有入参
System.out.println("线程：" + Thread.currentThread().getName() + " do something");
//thenRun注意没有入参，也没有返回值
});
System.out.println("线程：" + Thread.currentThread().getName() +
" 结果：" + voidCompletableFuture.get());
}
}
运行结果如下：
线程：ForkJoinPool.commonPool-worker-1 getById(1)
线程：main do something
线程：main 结果：null
4. exceptionally
CompletableFuture的exceptionally方法表示，某个任务执行异常时，执行的回调方法;并且有抛出异常作为参数，传递到回调方法。
public class FutureExceptionTest {
public static void main(String[] args) throws ExecutionException, InterruptedException {
CompletableFuture orgFuture = CompletableFuture.supplyAsync(
()->{
System.out.println("当前线程名称：" + Thread.currentThread().getName());
throw new RuntimeException();
}
);
CompletableFuture exceptionFuture = orgFuture.exceptionally((e) -> {
e.printStackTrace();
return "你的程序异常啦";
});
System.out.println(exceptionFuture.get());
}
}
//输出
当前线程名称：ForkJoinPool.commonPool-worker-1
java.util.concurrent.CompletionException: java.lang.RuntimeException
at java.util.concurrent.CompletableFuture.encodeThrowable(CompletableFuture.java:273)
at java.util.concurrent.CompletableFuture.completeThrowable(CompletableFuture.java:280)
at java.util.concurrent.CompletableFuture$AsyncSupply.run(CompletableFuture.java:1592)
at java.util.concurrent.CompletableFuture$AsyncSupply.exec(CompletableFuture.java:1582)
at java.util.concurrent.ForkJoinTask.doExec(ForkJoinTask.java:289)
at java.util.concurrent.ForkJoinPool$WorkQueue.runTask(ForkJoinPool.java:1056)
at java.util.concurrent.ForkJoinPool.runWorker(ForkJoinPool.java:1692)
at java.util.concurrent.ForkJoinWorkerThread.run(ForkJoinWorkerThread.java:157)
Caused by: java.lang.RuntimeException
at cn.eovie.future.FutureWhenTest.lambda$main$0(FutureWhenTest.java:13)
at java.util.concurrent.CompletableFuture$AsyncSupply.run(CompletableFuture.java:1590)
... 5 more
你的程序异常啦
5. whenComplete方法
CompletableFuture的whenComplete方法表示，某个任务执行完成后，执行的回调方法，无返回值；并且whenComplete方法返回的CompletableFuture的result是上个任务的结果。
public class FutureWhenTest {
public static void main(String[] args) throws ExecutionException, InterruptedException {
CompletableFuture orgFuture = CompletableFuture.supplyAsync(
()->{
System.out.println("当前线程名称：" + Thread.currentThread().getName());
try {
Thread.sleep(2000L);
} catch (InterruptedException e) {
e.printStackTrace();
}
return "捡田螺的小男孩";
}
);
CompletableFuture rstFuture = orgFuture.whenComplete((a, throwable) -> {
System.out.println("当前线程名称：" + Thread.currentThread().getName());
System.out.println("上个任务执行完啦，还把" + a + "传过来");
if ("捡田螺的小男孩".equals(a)) {
System.out.println("666");
}
System.out.println("233333");
});
System.out.println(rstFuture.get());
}
}
//输出
当前线程名称：ForkJoinPool.commonPool-worker-1
当前线程名称：ForkJoinPool.commonPool-worker-1
上个任务执行完啦，还把捡田螺的小男孩传过来
666
233333
捡田螺的小男孩
6. handle方法
CompletableFuture的handle方法表示，某个任务执行完成后，执行回调方法，并且是有返回值的;并且handle方法返回的CompletableFuture的result是回调方法执行的结果。
public class FutureHandlerTest {
public static void main(String[] args) throws ExecutionException, InterruptedException {
CompletableFuture orgFuture = CompletableFuture.supplyAsync(
()->{
System.out.println("当前线程名称：" + Thread.currentThread().getName());
try {
Thread.sleep(2000L);
} catch (InterruptedException e) {
e.printStackTrace();
}
return "捡田螺的小男孩";
}
);
CompletableFuture rstFuture = orgFuture.handle((a, throwable) -> {
System.out.println("上个任务执行完啦，还把" + a + "传过来");
if ("捡田螺的小男孩".equals(a)) {
System.out.println("666");
return "关注了";
}
System.out.println("233333");
return null;
});
System.out.println(rstFuture.get());
}
}
//输出
当前线程名称：ForkJoinPool.commonPool-worker-1
上个任务执行完啦，还把捡田螺的小男孩传过来
666
关注了
三.多个任务组合处理
AND组合关系
thenCombine / thenAcceptBoth / runAfterBoth都表示：将两个CompletableFuture组合起来，只有这两个都正常执行完了，才会执行某个任务。
区别在于：
- thenCombine：会将两个任务的执行结果作为方法入参，传递到指定方法中，且有返回值
- thenAcceptBoth: 会将两个任务的执行结果作为方法入参，传递到指定方法中，且无返回值
- runAfterBoth 不会把执行结果当做方法入参，且没有返回值。
OR 组合的关系
applyToEither / acceptEither / runAfterEither 都表示：将两个CompletableFuture组合起来，只要其中一个执行完了,就会执行某个任务。
区别在于：
- applyToEither：会将已经执行完成的任务，作为方法入参，传递到指定方法中，且有返回值
- acceptEither: 会将已经执行完成的任务，作为方法入参，传递到指定方法中，且无返回值
- runAfterEither： 不会把执行结果当做方法入参，且没有返回值。
AllOf
所有任务都执行完成后，才执行 allOf返回的CompletableFuture。如果任意一个任务异常，allOf的CompletableFuture，执行get方法，会抛出异常
public class allOfFutureTest {
public static void main(String[] args) throws ExecutionException, InterruptedException {
CompletableFuture a = CompletableFuture.runAsync(()->{
System.out.println("我执行完了");
});
CompletableFuture b = CompletableFuture.runAsync(() -> {
System.out.println("我也执行完了");
});
CompletableFuture allOfFuture = CompletableFuture.allOf(a, b).whenComplete((m,k)->{
System.out.println("finish");
});
}
}
//输出
我执行完了
我也执行完了
finish
AnyOf
任意一个任务执行完，就执行anyOf返回的CompletableFuture。如果执行的任务异常，anyOf的CompletableFuture，执行get方法，会抛出异常
public class AnyOfFutureTest {
public static void main(String[] args) throws ExecutionException, InterruptedException {
CompletableFuture a = CompletableFuture.runAsync(()->{
try {
Thread.sleep(3000L);
} catch (InterruptedException e) {
e.printStackTrace();
}
System.out.println("我执行完了");
});
CompletableFuture b = CompletableFuture.runAsync(() -> {
System.out.println("我也执行完了");
});
CompletableFuture thenCompose
thenCompose方法会在某个任务执行完成后，将该任务的执行结果,作为方法入参,去执行指定的方法。该方法会返回一个新的CompletableFuture实例
- 如果该CompletableFuture实例的result不为null，则返回一个基于该result新的CompletableFuture实例；
- 如果该CompletableFuture实例为null，然后就执行这个新任务
本文只复制常用的几个方法,更多方法请自己百度