Java 8 - CompletableFuture

Future 是在Java 5引入的,CompletableFuture 是在Java 8引入的,提供了更加强大的功能。两者都是用来实现异步的,避免阻塞主线程.

Future

Future 提供了get 方法来返回异步任务的执行结果,当调用get方法会阻塞直至任务结束返回结果。

public class TestFuture {

    public static void main(String[] args) {
        ExecutorService exec = Executors.newSingleThreadExecutor();
        Future<Integer> f = exec.submit(new MyCallable());

        System.out.println(f.isDone()); // false

        try {
            System.out.println(f.get()); // 1,等待直到Callable完成
            System.out.println(f.isDone()); // true
        } catch (InterruptedException | ExecutionException e) {
            e.printStackTrace();
        } finally {
            exec.shutdown();
        }
    }
}

class MyCallable implements Callable<Integer> {

    @Override
    public Integer call() throws Exception {
        Thread.sleep(1000);
        return 1;
    }

}

CompletableFuture

CompletableFuture 实现了FutureCompletionStage 接口,实现异步任务的链式处理,支持多个任务的并发执行、顺序执行,对任务的控制更加精细。

runAsync()

异步执行一个 Runnable 实例,异步任务没有返回值,该方法返回CompletableFuture实例。

CompletableFuture future = CompletableFuture.runAsync(() -> {
    try {
        System.out.println("Running asynchronous task in parallel");
        TimeUnit.SECONDS.sleep(1);
    } catch (InterruptedException ex) {
        throw new IllegalStateException(ex);
    }
});

supplyAsync()

异步执行一个Supplier,异步任务具有返回值,该方法返回CompletableFuture实例。

CompletableFuture future = CompletableFuture.supplyAsync(() -> {
    try {
        TimeUnit.SECONDS.sleep(1);
    } catch (InterruptedException e) {
        throw new IllegalStateException(e);
    }
    return "This is the result of the asynchronous computation";
});

thenApply()

执行一个 Function,这个函数的执行还是在CompletableFuture.supplyAsync 开启的线程中执行,Function有返回值所以可以链式的连接多个thenApply方法。

CompletableFuture<String> cf = CompletableFuture.supplyAsync(() -> "Feng");
CompletableFuture<String> cf2 = cf.thenApply(name -> "Hello " + name).thenApply(greeting -> greeting + ", Welcome to SH!");
System.out.println(cf.get()); // Feng
System.out.println(cf2.get()); // Hello Feng, Welcome to SH!

thenAccept()

执行一个 Consumer,此时执行异步任务的线程没有返回值。通常该方法应该在操作链的最后。

CompletableFuture<String> cf = CompletableFuture.supplyAsync(() -> "Feng");
CompletableFuture<String> cf2 = cf.thenApply(name -> "Hello " + name).thenApply(greeting -> greeting + ", Welcome to SH!");
cf2.thenAccept(v-> System.out.println(v)); // Hello Feng, Welcome to SH!

thenRun()

执行一个Runnable,和thenAccept一样,此时执行异步任务的线程没有返回值,但不同的是此时也不接收任何参数的传入

CompletableFuture<String> cf = CompletableFuture.supplyAsync(() -> "Feng");
cf.thenRun(()-> System.out.println("then run.."));

thenCompose()

thenCompose方法接受一个返回CompletableFuture的Function做为参数,和thenApply不同的是:
thenApply接受是一个同步方法,而thenCompose接受的是异步方法。

public class CF2 {

    private static CompletableFuture<String> sendMailAsync(String input) {
        return CompletableFuture.supplyAsync(() -> {
            try {
                TimeUnit.SECONDS.sleep(1);
            } catch (InterruptedException e) {
                e.printStackTrace();
            }
            return input + " | " + "2. Send mail to Administrator.";
        });
    }

    public static void main(String[] args) throws ExecutionException, InterruptedException {
        CompletableFuture<String> cf = CompletableFuture.supplyAsync(() -> "1. Write mail.");
        CompletableFuture<String> cf2 = cf.thenCompose(CF2::sendMailAsync);
        System.out.println(cf2.get()); // 1. Write mail. | 2. Send mail to Administrator.
    }

}

thenCombine()

thenCombine接受一个 BiFunction,来处理两个CompletableFuture的结果。

public class CF3 {

    public static void main(String[] args) throws ExecutionException, InterruptedException {
        CompletableFuture<String> cf1 = CompletableFuture.supplyAsync(() -> "1. A");
        CompletableFuture<String> cf2 = CompletableFuture.supplyAsync(() -> "2. B");

        CompletableFuture<String> cf3 = cf1.thenCombine(cf2, (a, b) -> a + " - " + b);
        System.out.println(cf3.get());
    }
}

thenAcceptBoth()

thenAcceptBoth 接受一个 BiConsumer,来处理两个CompletableFuture的结果。

public class CF4 {
    public static void main(String[] args) {
        CompletableFuture<String> cf1 = CompletableFuture.supplyAsync(() -> "1. A");
        CompletableFuture<String> cf2 = CompletableFuture.supplyAsync(() -> "2. B");
        cf1.thenAcceptBoth(cf2, (a, b) -> System.out.println(a + b));
    }
}
方法 描述
<U, R> CompletionStage<R> thenCombine(CompletionStage<U> other, BiFunction<T, U, R> action) Combines the result of this and other in one, using a BiFunction
<U> CompletionStage<Void> thenAcceptBoth(CompletionStage<U> other, BiConsumer<T, U> action) Consumes the result of this and other, using a BiConsumer
<U> CompletionStage<Void> runAfterBoth(CompletionStage<U> other, BiConsumer<T, U> action) Triggers the execution of a Runnable on the completion of this and other

CompletableFuture.allOf()

返回新的CompletableFuture实例,当形参中指定的CompletableFuture都完成了,该方法返回的新CompletableFuture也就完成了,如果要等待形参中指定的CompletableFuture都完成可以使用CompletableFuture.allOf(cf1, cf2, cf3).join()

CompletableFuture cf1 = CompletableFuture.supplyAsync(() -> 1);
CompletableFuture cf2 = CompletableFuture.supplyAsync(() -> 2);
CompletableFuture cf3 = CompletableFuture.supplyAsync(() -> 3);

CompletableFuture.allOf(cf1, cf2, cf3).join(); // All CompletableFuture success
System.out.println(cf1.get()); // 1
System.out.println(cf2.get()); // 2
System.out.println(cf3.get()); // 3

异常处理

参考如下代码,当cf1执行出现异常,所有下游的CompletableFuture都将出错,可以通过以下两个方法验证:

  1. isCompletedExceptionally() 会返回true
  2. get() 方法会抛出ExecutionException异常,异常内容是cf1中出现的异常.
public class CF6 {

    public static void main(String[] args) {
        CompletableFuture.supplyAsync(() -> 4 / 1).thenAccept(v -> System.out.println(v)); // 4
        System.out.println("1 -------");

        // 如果异常不处理,所有下游的CompletableFuture将都会出错
        CompletableFuture<Integer> cf1 = CompletableFuture.supplyAsync(() -> 4 / 0);
        CompletableFuture<Integer> cf2 = cf1.thenApply(v -> v++);
        cf2.thenAccept(v -> System.out.println(v)); // nothing
        System.out.println(cf2.isCompletedExceptionally()); // true
        try {
            System.out.println(cf2.get());
        } catch (InterruptedException | ExecutionException e) {
            System.out.println("error"); // error
            
        }

        System.out.println("2 -------");
        // 通过exceptionally处理异常,提供
        CompletableFuture.supplyAsync(() -> 4 / 0).exceptionally(ex -> -1).thenAccept(v -> System.out.println(v)); // -1
    }
}

执行结果:

4
1 -------
true
error
2 -------
-1

异常可以通过exceptionally(Function<Throwable, T> function)方法来处理,如果出现异常,异常会被传入该方法,如果没有异常,直接返回上游的结果。

异常还可以通过handle(BiFunction<T, Throwable, R> bifunction)来处理,如果上游处理出现异常,T值将为null,异常为上游异常。如果上游正常执行,T将是上游的返回值,异常将是null.

CompletableFuture.supplyAsync(() -> 4 / 0)
                .handle((v, ex) -> v != null ? v : -1)
                .thenAccept(v -> System.out.println(v)); // -1

第三种是通过whenComplete(BiConsumer<T, Throwable> biconsumer)来处理异常,同handle, 如果上游处理出现异常,T值将为null,异常为上游异常。如果上游正常执行,T将是上游的返回值,异常将是null。不同的是如果出现异常,whenComplete后续将没有返回值,如果没有异常将向下返回上游的返回值。

CompletableFuture.supplyAsync(() -> 4 / 1)
                .whenComplete((v, ex) -> {
                    if (ex == null) {
                        System.out.println(v); // 4
                    } else {
                        System.out.println(ex.getMessage());
                    }
                }).thenAccept(v -> System.out.println(v)); // 4, 只有当whenComplete之前没有异常才会取到上游的返回值

CompletableFuture.supplyAsync(() -> 4 / 0)
        .whenComplete((v, ex) -> {
            if (ex == null) {
                System.out.println(v);
            } else {
                System.out.println(ex.getMessage()); // java.lang.ArithmeticException: / by zero
            }
        }).thenAccept(v -> System.out.println(v)); // 无

参考:

https://stackoverflow.com/questions/35329845/difference-between-completablefuture-future-and-rxjavas-observable
https://blog.knoldus.com/2018/01/20/future-vs-completablefuture-1/
https://blog.knoldus.com/2018/03/30/future-vs-completablefuture-in-java-2/
http://www.deadcoderising.com/java8-writing-asynchronous-code-with-completablefuture/
https://community.oracle.com/docs/DOC-995305

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,686评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,668评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,160评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,736评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,847评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,043评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,129评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,872评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,318评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,645评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,777评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,861评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,589评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,687评论 2 351

推荐阅读更多精彩内容