如何使用CompletableFuture

CompletableFuture介绍

CompletableFuture 是Java 8中的一个很重要的类,它是一个实现了 Future 接口的异步处理类,可以帮助我们更加方便地执行异步任务和处理异步任务的结果。 CompletableFuture 的底层实现是基于 Fork/Join 框架和 ConcurrentLinkedQueue ,在Java 8中, CompletableFuture 是在 java.util.concurrent 包下。

CompletableFuture底层实现

CompletableFuture 底层依赖了 Fork/Join 框架和 ConcurrentLinkedQueueFork/Join 框架是Java 7加入的一个框架,它的基本思想是将一个大任务拆成多个小任务并行执行,最后将结果合并起来。而 ConcurrentLinkedQueue 是Java 5中添加的一个线程安全的队列,它支持高并发下的并发读写。
CompletableFuture 底层的异步处理也是基于这两个框架的。异步任务的执行,是将任务拆分成多个小任务,然后并行执行,最后合并结果。同时,异步任务的结果可以是不同类型的对象,如 voidvalueexception 等。

CompletableFuture API

CompletableFuture 类中提供了很多API,常见的有以下几个:

创建CompletableFuture

我们可以通过以下两种方式创建CompletableFuture

CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> "Hello World");
CompletableFuture<String> future2 = CompletableFuture.completedFuture("Hello World");

如果需要无返回值的CompletableFuture,可以通过以下方式:

CompletableFuture<Void> future = CompletableFuture.runAsync(() -> {
    // 做一些不需要返回值的操作
});

在这个示例中,我们创建了一个 CompletableFuture 对象,它使用 runAsync() 方法执行了一个不需要返回值的操作。注意,这个操作是在新的线程中执行的,因此不会阻塞主线程。

可以通过调用 future.join() 来等待这个异步任务的完成。如果不需要等待任务的完成,可以直接返回 future 对象。

通过 supplyAsync 方式创建的CompletableFuture,会执行一个异步任务,并返回结果。而 completedFuture 方式创建的CompletableFuture,则直接返回一个已经完成的CompletableFuture对象。

异步任务之间的关系

CompletableFuture 中有很多方法可以用来描述异步任务之间的关系,如:

  • thenApply
  • thenAccept
  • thenRun
  • thenCompose
  • thenCombine
  • whenComplete

这些方法的使用方式相似,都是通过链式调用的方式,如下示例:

CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> "Hello World");
CompletableFuture<String> future2 = future.thenApply(str -> str + "Java");
CompletableFuture<Void> future3 = future.thenAccept(str -> System.out.println(str));
CompletableFuture<Void> future4 = future.thenRun(() -> System.out.println("Hello Java"));
CompletableFuture<String> future5 = future.thenCompose(str -> CompletableFuture.completedFuture(str + "Java"));
CompletableFuture<String> future6 = future.thenCombine(future5, (str1, str2) -> str1 + str2);
CompletableFuture<Void> future7 = future.whenComplete((str, ex) -> {
    if (ex != null) {
        System.out.println("Error: " + ex.getMessage());
    } else {
        System.out.println(str);
    }
});
  • thenApply 方法会在 future 任务完成后,将其结果作为参数传递给 thenApply 中的函数,返回另一个 CompletableFuture
  • thenAccept 方法会在 future 任务完成后,将其结果作为参数传递给 thenAccept 中的函数,不返回任何结果。
  • thenRun 方法会在 future 任务完成后,执行 thenRun 中的代码,不接受任何参数,也不返回任何结果。
  • thenCompose 方法会在 future 任务完成后,将其结果作为参数传递给 thenCompose 中的 CompletableFuture ,返回另一个 CompletableFuture
  • thenCombine 方法会在 futurefuture5 任务都完成后,将两个任务的结果作为参数传递给 thenCombine 中的函数,返回另一个 CompletableFuture
  • whenComplete 方法会在 future 任务完成后,执行 whenComplete 中的代码,无论成功或失败都会执行。

异常处理

CompletableFuture 中有很多方法可以用来处理异步任务中出现的异常,如:

  • exceptionally
  • handle

这些方法的使用方式相似,都是通过链式调用的方式,如下示例:

CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> {
    if (System.currentTimeMillis() % 2 == 0) {
        throw new RuntimeException();
    }
    return "Hello World";
});
 CompletableFuture<String> future2 = future.exceptionally(ex -> "Error")
                                           .thenApply(str -> str + " Java");
 CompletableFuture<String> future3 = future.handle((str, ex) -> {
    if (ex != null) {
        System.out.println("Error: " + ex.getMessage());
        return "Error";
    } else {
        return str;
    }
});
  • exceptionally 方法会在 future 任务出现异常的时候执行,并返回一个带有默认值的 CompletableFuture
  • handle 方法会在 future 任务完成后,无论成功或失败都会执行,并可以处理异常信息。

CompletableFuture用法示例

创建CompletableFuture

CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> "Hello World");

通过 supplyAsync 创建一个异步执行任务,返回值为 Hello World

异步任务之间的关系

  • thenApply 示例
CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> "Hello World");
CompletableFuture<String> future2 = future.thenApply(str -> str + " Java");
System.out.println(future2.get());

输出结果为 Hello World Java

  • thenAccept 示例
CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> "Hello World");
CompletableFuture<Void> future2 = future.thenAccept(str -> System.out.println(str + " Java"));
future2.get();

输出结果为 Hello World Java

  • thenRun 示例
CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> "Hello World");
CompletableFuture<Void> future2 = future.thenRun(() -> System.out.println("Hello Java"));
future2.get();

输出结果为 Hello Java

  • thenCompose 示例
CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> "Hello World");
CompletableFuture<String> future2 = future.thenCompose(str -> CompletableFuture.completedFuture(str + " Java"));
System.out.println(future2.get());

输出结果为 Hello World Java

  • thenCombine 示例
CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> "Hello");
CompletableFuture<String> future2 = CompletableFuture.supplyAsync(() -> " World");
CompletableFuture<String> future3 = future.thenCombine(future2, (str1, str2) -> str1 + str2);
System.out.println(future3.get());

输出结果为 Hello World

  • whenComplete 示例
CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> "Hello World");
CompletableFuture<Void> future2 = future.whenComplete((str, ex) -> {
    if (ex != null) {
        System.out.println("Error: " + ex.getMessage());
    } else {
        System.out.println(str);
    }
});
future2.get();

输出结果为 Hello World

异常处理示例

  • exceptionally 示例
CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> {
    if (System.currentTimeMillis() % 2 == 0) {
        throw new RuntimeException();
    }
    return "Hello World";
});
 CompletableFuture<String> future2 = future.exceptionally(ex -> "Error").thenApply(str -> str + " Java");
System.out.println(future2.get());

输出结果为 Error Java

  • handle 示例
CompletableFuture<String> future = CompletableFuture.supplyAsync(() -> {
    if (System.currentTimeMillis() % 2 == 0) {
        throw new RuntimeException();
    }
    return "Hello World";
});
 CompletableFuture<String> future2 = future.handle((str, ex) -> {
    if (ex != null) {
        System.out.println("Error: " + ex.getMessage());
        return "Error";
    } else {
        return str;
    }
});
System.out.println(future2.get());

输出结果为 ErrorHello World

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

推荐阅读更多精彩内容