CompletableFuture的介绍及使用

1、介绍

2、使用

2.1 异步执行

        CompletableFuture提供了四种异步方法执行任务,为以下4种

public static <U> CompletableFuture<U> supplyAsync(Supplier<U> supplier){
     return asyncSupplyStage(ASYNC_POOL, supplier);
}
public static <U> CompletableFuture<U> supplyAsync(Supplier<U> supplier,
                                                       Executor executor) {
     return asyncSupplyStage(screenExecutor(executor), supplier);
}
public static CompletableFuture<Void> runAsync(Runnable runnable) {
     return asyncRunStage(ASYNC_POOL, runnable);
}
public static CompletableFuture<Void> runAsync(Runnable runnable,
                                                   Executor executor) {
     return asyncRunStage(screenExecutor(executor), runnable);
}
  1. 结合入参及方法,我们可用看出,以上四种方法其实可以分为2种 runAsync、supplyAsyncExecutor executor 参数为指定的线程池,如果不指定则使用默认线程池。
  2. runAsync方法是返回值方法,supplyAsync为由返回值方法

2.2 并行方法

        添加异步执行方法

private static String sleepSecond(int x) {
        long sleep = 1000L * x;
        try {
            Thread.sleep(sleep);
        }catch (Exception e) {

        }
        String print = "睡眠%d秒";
        System.out.println(String.format(print, x));
        return String.valueOf(x);
    }
  • allOf():当给定的所有CompletableFuture执行完成时,返回结果
    • allOf() 方法返回值无法获取异步执行方法的值,可以直接根据执行supplyAsync返回结果get()获取值
    • 以下为执行过程及结果
        String print = "任务执行%d秒";
        long start = System.currentTimeMillis();
        CompletableFuture<String> future1 = CompletableFuture.supplyAsync(() -> sleepSecond(1));
        CompletableFuture<String> future2 = CompletableFuture.supplyAsync(() -> sleepSecond(2));
        CompletableFuture<String> future3 = CompletableFuture.supplyAsync(() -> sleepSecond(3));
        CompletableFuture<Void> voidCompletableFuture = CompletableFuture.allOf(future1, future2, future3);
        System.out.println(voidCompletableFuture.get());
        System.out.println(future1.get());
        System.out.println(future2.get());
        System.out.println(future3.get());
        System.out.println(String.format(print, ( System.currentTimeMillis() - start)/1000));

        

  • anyOf():当任意CompletableFuture执行完成时,返回结果
    • 使用anyOf()返回值对象进行get(),可以获取运行结果最快的方法的返回值
    • 当使用supplyAsync返回结果get()获取值时,如果,则结果和allOf()一致
        String print = "任务执行%d秒";
        long start = System.currentTimeMillis();
        CompletableFuture<String> future1 = CompletableFuture.supplyAsync(() -> sleepSecond(1));
        CompletableFuture<String> future2 = CompletableFuture.supplyAsync(() -> sleepSecond(2));
        CompletableFuture<String> future3 = CompletableFuture.supplyAsync(() -> sleepSecond(3));
        CompletableFuture<Object> objectCompletableFuture = CompletableFuture.anyOf(future1, future2, future3);
        System.out.println(objectCompletableFuture.get());
        System.out.println(String.format(print, (System.currentTimeMillis() - start) / 1000));

        

        String print = "任务执行%d秒";
        long start = System.currentTimeMillis();
        CompletableFuture<String> future1 = CompletableFuture.supplyAsync(() -> sleepSecond(1));
        CompletableFuture<String> future2 = CompletableFuture.supplyAsync(() -> sleepSecond(2));
        CompletableFuture<String> future3 = CompletableFuture.supplyAsync(() -> sleepSecond(3));
        CompletableFuture<Object> objectCompletableFuture = CompletableFuture.anyOf(future1, future2, future3);
        System.out.println(objectCompletableFuture.get());
        System.out.println(future1.get());
        System.out.println(future2.get());
        System.out.println(future3.get());
        System.out.println(String.format(print, (System.currentTimeMillis() - start) / 1000));

         

2.3 依赖关系

        异步执行方法见2.2

  • thenApply():将前面的任务执行的结果当作入参给thenApply()方法
    • 注:thenApply()的入参类型和前面执行方法的返回值类型相同
    • 以下为方法执行代码及结果
String print = "任务执行%d秒";
        long start = System.currentTimeMillis();
        CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> sleepSecond(1))
                .thenApply(e -> sleepSecond(Integer.parseInt(e) + 1));
        System.out.println(future.get());
        System.out.println(String.format(print, (System.currentTimeMillis() - start) / 1000));

        

  •  thenCompose():用来执行两个相关联的任务,返回结果为第二个任务的结果。一般用来执行第二个任务需要第一个任务返回结果处理业务
    • 以下为方法执行代码及结果
  
// 此处为2.2异步演示代码的关联演示代码
private static CompletionStage<String> completionTest(String x) {
        System.out.println("执行关联任务:" + x);
        CompletableFuture<String> future =CompletableFuture.supplyAsync(() -> sleepSecond(Integer.parseInt(x) + 1));
        return future;
}



 // 具体的代码演示
String print = "任务执行%d秒";
long start = System.currentTimeMillis();
CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> sleepSecond(1))
      .thenCompose(CompletableFutureDemo::completionTest);
System.out.println(future.get());
System.out.println(String.format(print, (System.currentTimeMillis() - start) / 1000));

                

 2.4 并且合集关系

        异步执行方法见2.2

  • thenCombine():将任务合并执行(多线程执行),并且可以将任务返回值进行一起处理
    • 以下为方法执行代码及结果
        String print = "任务执行%d秒";
        long start = System.currentTimeMillis();
        CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> sleepSecond(1));
        CompletableFuture<String> future1 = CompletableFuture.supplyAsync(() -> sleepSecond(2));
        CompletableFuture<String> combine = future.thenCombine(future1, new BiFunction<String, String, String>() {
            @Override
            public String apply(String s, String s2) {
                System.out.println(s + "," + s2);
                return s + s2;
            }
        });
        System.out.println(combine.get());
        System.out.println(String.format(print, (System.currentTimeMillis() - start) / 1000));

                

  •  thenAcceptBoth():两个任务执行完成后,将两个任务分返回值进行处理
    • 以下为方法执行代码及结果
        String print = "任务执行%d秒";
        long start = System.currentTimeMillis();
        CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> sleepSecond(1));
        CompletableFuture<String> future1 = CompletableFuture.supplyAsync(() -> sleepSecond(2));
        future.get();
        future1.get();
        future.thenAcceptBoth(future1, new BiConsumer<String, String>() {
           @Override
           public void accept(String s, String s2) {
               System.out.println(s + ',' + s2);
           }
        });
        System.out.println(String.format(print, (System.currentTimeMillis() - start) / 1000));

                

  •  runAfterBoth():正在两个方法都执行完成后,再执行下一步Runable()方法
    • 以下为方法执行代码及结果
        String print = "任务执行%d秒";
        long start = System.currentTimeMillis();
        CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> sleepSecond(1));
        CompletableFuture<String> future1 = CompletableFuture.supplyAsync(() -> sleepSecond(2));
        future.get();
        future1.get();
        future.runAfterBoth(future1, new Runnable() {
            @Override
            public void run() {
                System.out.println("执行 runAfterBoth()方法");
            }
        });
        System.out.println(String.format(print, (System.currentTimeMillis() - start) / 1000));

                

 2.5 或者聚合执行方法

        异步执行方法见2.2

  • applyToEither():两个执行的方法使用执行快的方法返回值,该方法有返回值
    • 以下为方法执行代码及结果
        String print = "任务执行%d秒";
        long start = System.currentTimeMillis();
        CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> sleepSecond(1))
                .applyToEither(CompletableFuture.supplyAsync(() -> sleepSecond(2)), new Function<String, String>() {
                    @Override
                    public String apply(String s) {
                        System.out.println("输出返回最快的结果值" + s);
                        return s;
                    }
                });
        future.get();
        System.out.println(String.format(print, (System.currentTimeMillis() - start) / 1000));

        ​​​​​​​        

  • acceptEither():两个任务执行后,去执行最快的结果
    • 以下为方法执行代码及结果
        String print = "任务执行%d秒";
        long start = System.currentTimeMillis();
        CompletableFuture<Void> either = CompletableFuture.supplyAsync(() -> sleepSecond(1))
                .acceptEither(CompletableFuture.supplyAsync(() -> sleepSecond(2)), new Consumer<String>() {
                    @Override
                    public void accept(String s) {
                        System.out.println("输出执行快的结果" + s);
                    }
                });
        either.get();
        System.out.println(String.format(print, (System.currentTimeMillis() - start) / 1000));

        

 

  • runAfterEither():任意一个任务执行完成,执行Runnable()方法
    • 以下为方法执行代码及结果
        String print = "任务执行%d秒";
        long start = System.currentTimeMillis();
        CompletableFuture<Void> either = CompletableFuture.supplyAsync(() -> sleepSecond(1))
                .runAfterEither(CompletableFuture.supplyAsync(() -> sleepSecond(2)), new Runnable() {
                    @Override
                    public void run() {
                        System.out.println("任意任务完成后执行方法");
                    }
                });
        either.get();
        System.out.println(String.format(print, (System.currentTimeMillis() - start) / 1000));

        ​​​​​​​        

 

### 关于 CompletableFuture使用方法 #### 1. 基本概念 `CompletableFuture` 是 Java 中用于异步编程的一个强大工具类。相比传统的 `Future`,它不仅支持获取执行结果的功能,还扩展了许多特性,例如异常处理、手动设置结果、链式操作以及结果组合等[^1]。 --- #### 2. 示例代码展示 以下是几个典型的 `CompletableFuture` 使用场景及其对应的代码示例: ##### (1)基本异步任务与结果处理 下面的代码演示了如何创建一个异步任务,并对其结果进行进一步处理: ```java import java.util.concurrent.CompletableFuture; public class BasicExample { public static void main(String[] args) throws Exception { // 定义异步任务 CompletableFuture<Integer> future = CompletableFuture.supplyAsync(() -> { System.out.println("Executing async task..."); return 42; }); // 对结果进行转换 CompletableFuture<String> result = future.thenApply(number -> "The answer is: " + number); // 获取最终结果 String finalResult = result.get(); System.out.println(finalResult); } } ``` 此代码片段展示了如何通过 `supplyAsync()` 方法启动一个异步任务,并利用 `thenApply()` 进行后续的结果处理[^2]。 --- ##### (2)并行运行多个任务 (`allOf`) 当需要同时运行多个异步任务时,可以使用 `allOf()` 方法。该方法会在所有指定的任务完成后才继续向下执行: ```java import java.util.concurrent.CompletableFuture; import java.util.Date; public class AllOfExample { public static void main(String[] args) throws Exception { // 定义两个异步任务 CompletableFuture<Void> task1 = CompletableFuture.runAsync(() -> { try { Thread.sleep(2000); System.out.println("Task 1 completed"); } catch (InterruptedException e) { e.printStackTrace(); } }); CompletableFuture<Void> task2 = CompletableFuture.runAsync(() -> { try { Thread.sleep(3000); System.out.println("Task 2 completed"); } catch (InterruptedException e) { e.printStackTrace(); } }); // 并行运行多个任务 CompletableFuture<Void> allTasks = CompletableFuture.allOf(task1, task2); allTasks.join(); System.out.println("All tasks finished at: " + new Date()); } } ``` 在此例子中,`allOf()` 确保只有在 `task1` 和 `task2` 都完成的情况下才会打印最后的消息[^3]。 --- ##### (3)任意一个任务完成即返回 (`anyOf`) 如果只需要其中一个任务的结果而不需要等待全部完成,则可采用 `anyOf()` 方法: ```java import java.util.concurrent.CompletableFuture; import java.util.concurrent.ExecutionException; public class AnyOfExample { public static void main(String[] args) throws ExecutionException, InterruptedException { // 定义两个异步任务 CompletableFuture<String> task1 = CompletableFuture.supplyAsync(() -> { try { Thread.sleep(1000); return "Result from Task 1"; } catch (InterruptedException e) { throw new RuntimeException(e); } }); CompletableFuture<String> task2 = CompletableFuture.supplyAsync(() -> { try { Thread.sleep(2000); return "Result from Task 2"; } catch (InterruptedException e) { throw new RuntimeException(e); } }); // 只要有一个任务完成就立即返回其结果 CompletableFuture<Object> anyTask = CompletableFuture.anyOf(task1, task2); System.out.println(anyTask.get()); // 主线程稍作延时以便观察效果 Thread.sleep(3000); } } ``` 这里展示了 `anyOf()` 如何快速响应最先完成的任务[^3]。 --- ##### (4)带超时机制的任务完成检测 为了防止某些长时间未完成的任务阻塞整个流程,可以通过 `get(long timeout, TimeUnit unit)` 设置超时时间: ```java import java.util.concurrent.CompletableFuture; import java.util.concurrent.TimeUnit; public class TimeoutExample { public static void main(String[] args) { CompletableFuture<Void> longRunningTask = CompletableFuture.runAsync(() -> { try { Thread.sleep(5000); // 模拟耗时任务 } catch (InterruptedException e) { e.printStackTrace(); } }); try { // 超过3秒则抛出TimeoutException longRunningTask.get(3, TimeUnit.SECONDS); System.out.println("Task completed within the time limit."); } catch (Exception e) { System.err.println("Task timed out or encountered an error: " + e.getMessage()); } } } ``` 这段代码说明了如何优雅地处理可能存在的长期挂起问题[^3]。 --- ### 总结 以上介绍了 `CompletableFuture` 的几种常见用法,包括但不限于基础异步任务管理、多任务并发控制(`allOf`)、最快完成者优先策略(`anyOf`)以及带有超时保护的操作模式。这些功能极大地增强了 Java 在异步编程领域的能力。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值