首页 > 软件编程 > java > Java CompletableFuture

Java多线程工具CompletableFuture的使用教程

2022-08-19 14:26:45 作者：Real_man

CompletableFuture实现了CompletionStage接口和Future接口，前者是对后者的一个扩展，增加了异步回调、流式处理、多个Future组合处理的能力。本文就来详细讲讲CompletableFuture的使用方式，需要的可以参考一下

前言

Future的问题

写多线程程序的时候，可以使用Future从一个异步线程中拿到结果，但是如果使用过程中会发现一些问题：

如果想要对Future的结果做进一步的操作，需要阻塞当前线程
多个Future不能被链式的执行，每个Future的结果都是独立的，期望对一个Future的结果做另外一件异步的事情；
没有异常处理策略，如果Future执行失败了，需要手动捕捉

CompletableFuture应运而生

为了解决Future问题，JDK在1.8的时候给我们提供了一个好用的工具类CompletableFuture；

它实现了Future和CompletionStage接口，针对Future的不足之处给出了相应的处理方式。

在异步线程执行结束后可以自动回调我们新的处理逻辑，无需阻塞
可以对多个异步任务进行编排，组合或者排序
异常处理

CompletableFuture的核心思想是将每个异步任务都可以看做一个步骤(CompletionStage)，然后其他的异步任务可以根据这个步骤做一些想做的事情。

CompletionStage定义了许多步骤处理的方法，功能非常强大，这里就只列一下日常中常用到的一些方法供大家参考。

使用方式

基本使用-提交异步任务

简单的使用方式

异步执行，无需结果：

// 可以执行Executors异步执行，如果不指定，默认使用ForkJoinPool
CompletableFuture.runAsync(() -> System.out.println("Hello CompletableFuture!"));

异步执行，同时返回结果：

// 同样可以指定线程池
CompletableFuture<String> stringCompletableFuture = CompletableFuture.supplyAsync(() -> "Hello CompletableFuture!");
System.out.println(stringCompletableFuture.get());

处理上个异步任务结果

thenRun: 不需要上一步的结果，直接直接新的操作
thenAccept：获取上一步异步处理的内容，进行新的操作
thenApply: 获取上一步的内容，然后产生新的内容

所有加上Async后缀的，代表新的处理操作仍然是异步的。Async的操作都可以指定Executors进行处理

// Demo
       CompletableFuture
                .supplyAsync(() -> "Hello CompletableFuture!")
                // 针对上一步的结果做处理，产生新的结果
                .thenApplyAsync(s -> s.toUpperCase())
                // 针对上一步的结果做处理，不返回结果
                .thenAcceptAsync(s -> System.out.println(s))
                // 不需要上一步返回的结果，直接进行操作
                .thenRunAsync(() -> System.out.println("end"));
        ;

对两个结果进行选用-acceptEither

当我们有两个回调在处理的时候，任何完成都可以使用，两者结果没有关系，那么使用acceptEither。

两个异步线程谁先执行完成，用谁的结果，其余类型的方法也是如此。

// 返回abc
CompletableFuture
                .supplyAsync(() -> {
                    SleepUtils.sleep(100);
                    return "Hello CompletableFuture!";
                })
                .acceptEither(CompletableFuture.supplyAsync(() -> "abc"), new Consumer<String>() {
                    @Override
                    public void accept(String s) {
                        System.out.println(s);
                    }
                });
// 返回Hello CompletableFuture!       
CompletableFuture
                .supplyAsync(() -> "Hello CompletableFuture!")
                .acceptEither(CompletableFuture.supplyAsync(() -> {
                    SleepUtils.sleep(100);
                    return "abc";
                }), new Consumer<String>() {
                    @Override
                    public void accept(String s) {
                        System.out.println(s);
                    }
                });

对两个结果进行合并-thenCombine, thenAcceptBoth

thenCombine

当我们有两个CompletionStage时，需要对两个的结果进行整合处理，然后计算得出一个新的结果。

thenCompose是对上一个CompletionStage的结果进行处理，返回结果，并且返回类型必须是CompletionStage。
thenCombine是得到第一个CompletionStage的结果，然后拿到当前的CompletionStage，两者的结果进行处理。

        CompletableFuture<Integer> heightAsync = CompletableFuture.supplyAsync(() -> 172);

        CompletableFuture<Double> weightAsync = CompletableFuture.supplyAsync(() -> 65)
                .thenCombine(heightAsync, new BiFunction<Integer, Integer, Double>() {
                    @Override
                    public Double apply(Integer wight, Integer height) {
                        return wight * 10000.0 / (height * height);
                    }
                })
                ;

thenAcceptBoth

需要两个异步CompletableFuture的结果，两者都完成的时候，才进入thenAcceptBoth回调。

// thenAcceptBoth案例：
        CompletableFuture
                .supplyAsync(() -> "Hello CompletableFuture!")
                .thenAcceptBoth(CompletableFuture.supplyAsync(() -> "abc"), new BiConsumer<String, String>() {
                		// 参数一为我们刚开始运行时的CompletableStage，新传入的作为第二个参数
                    @Override
                    public void accept(String s, String s2) {
                        System.out.println("param1=" + s + ", param2=" + s2);
                    }
                });
// 结果：param1=Hello CompletableFuture!, param2=abc

异常处理

当我们使用CompleteFuture进行链式调用的时候，多个异步回调中，如果有一个执行出现问题，那么接下来的回调都会停止，所以需要一种异常处理策略。

exceptionally

exceptionally是当出现错误时，给我们机会进行恢复，自定义返回内容。

        CompletableFuture.supplyAsync(() -> {
            throw new RuntimeException("发生错误");
        }).exceptionally(throwable -> {
            log.error("调用错误 {}", throwable.getMessage(), throwable);
            return "异常处理内容";
        });

handle

exceptionally是只有发生异常时才会执行，而handle则是不管是否发生错误都会执行。

CompletableFuture.supplyAsync(() -> {
    return "abc";
})
.handle((r,err) -> {
    log.error("调用错误 {}", err.getMessage(), err);
    // 对结果做额外的处理
    return r;
})
;

案例

大量用户发送短信|消息

需求为对某个表中特定条件的用户进行短信通知，但是短信用户有成百上千万，如果使用单线程读取效率会很慢。这个时候可以考虑使用多线程的方式进行读取；

1、将读取任务拆分为多个不同的子任务，指定读取的偏移量和个数

  // 假设有500万条记录
        long recordCount = 500 * 10000;
        int subTaskRecordCount = 10000;
        // 对记录进行分片
        List<Map> subTaskList = new LinkedList<>();
        for (int i = 0; i < recordCount / 500; i++) {
            // 如果子任务结构复杂，建议使用对象
            HashMap<String, Integer> subTask = new HashMap<>();
            subTask.put("index", i);
            subTask.put("offset", i * subTaskRecordCount);
            subTask.put("count", subTaskRecordCount);
            subTaskList.add(subTask);
        }

2、使用多线程进行批量读取

  // 进行subTask批量处理，拆分为不同的任务
        subTaskList.stream()
                .map(subTask -> CompletableFuture.runAsync(()->{
                    // 读取数据，然后处理
                    // dataTunel.read(subTask);
                },excuturs))   // 使用应用的通用任务线程池
                .map(c -> ((CompletableFuture<?>) c).join());

3、进行业务逻辑处理，或者直接在读取完进行业务逻辑处理也是可以；

并发获取商品不同信息

在系统拆分比较细的时候，价格，优惠券，库存，商品详情等信息分散在不同的系统中，有时候需要同时获取商品的所有信息，有时候可能只需要获取商品的部分信息。

当然问题点在于要调用多个不同的系统，需要将RT降低下来，那么需要进行并发调用；

     List<Task> taskList = new ArrayList<>();
        List<Object> result = taskList.stream()
                .map(task -> CompletableFuture.supplyAsync(()->{
//                    handlerMap.get(task).query();
                    return "";
                }, executorService))
                .map(c -> c.join())
                .collect(Collectors.toList());

问题

thenRun和thenRunAsync有什么区别

如果不使用传入的线程池，大家用默认的线程池ForkJoinPool
thenRun用的默认和上一个任务使用相同的线程池
thenRunAsync在执行新的任务的时候可以接受传入一个新的线程池，使用新的线程池执行任务；

handle和exceptional有什么区别