深入理解 CompletableFuture 异常完成与回调机制

本文深入探讨了 completablefuture 在链式调用中处理异常完成的机制，重点阐述了 `whencomplete` 回调方法与 `completeexceptionally` 调用的正确关联。通过分析常见错误，揭示了 `completablefuture` 方法返回新实例的特性，并指导开发者如何正确引用并完成初始 future，确保回调逻辑按预期执行，从而避免回调不触发的问题。

CompletableFuture 链式调用中的完成机制解析

Java 中的 CompletableFuture 提供了一种强大且灵活的方式来编写异步、非阻塞的代码。它支持链式调用，允许我们定义一系列的计算步骤，并在前一个步骤完成后执行后续操作。whenComplete 方法是其中一个常用的回调方法，用于在 CompletableFuture 完成（无论是正常完成还是异常完成）时执行一个动作。然而，在实际使用中，如果不理解 CompletableFuture 的链式调用如何创建新的 Future 实例，可能会导致回调不触发的困惑。

初始问题：回调未被触发

考虑以下代码片段，它尝试在 CompletableFuture 异常完成时打印一些信息：

import java.util.concurrent.*;

public class TestCompletableFuture {
    public static void main(String[] args) throws Exception {
        CompletableFuture<Void> future = new CompletableFuture<Void>()
            .whenComplete((res, exc) -> {
                System.out.println("inside handle.");
                if (exc != null) {
                    System.out.println("exception.");
                }
                System.out.println("completed.");
            }
        );

        future.completeExceptionally(new Exception("exception"));
        System.out.println("finished.");
    }
}

执行上述代码，我们会发现控制台只输出了 finished.，而 whenComplete 中定义的任何打印语句都没有执行。这似乎与我们的直觉相悖，因为我们期望 completeExceptionally() 会触发 whenComplete() 中注册的回调。

问题根源：CompletableFuture 实例的引用

这个问题的核心在于对 CompletableFuture 链式调用返回值的误解。像 whenComplete、thenApply、thenCompose 等方法，它们并不会修改当前的 CompletableFuture 实例，而是会返回一个新的 CompletableFuture 实例。这个新的实例代表了链中后续阶段的完成状态。

在原始代码中：

1. new CompletableFuture<Void>() 创建了一个初始的 CompletableFuture 实例。
2. .whenComplete(...) 被调用在这个初始实例上。然而，这个方法会返回一个全新的 CompletableFuture 实例，这个新实例才承载了 whenComplete 中定义的回调逻辑。
3. CompletableFuture<Void> future = ... 这行代码最终将新的 CompletableFuture 实例赋值给了 future 变量。
4. 紧接着，future.completeExceptionally(...) 被调用，它尝试完成的是这个新的 CompletableFuture 实例。

问题的关键在于，我们期望 whenComplete 监听的是被 completeExceptionally 完成的 Future。但在原始代码中，whenComplete 实际上是注册在第一个（匿名）CompletableFuture 实例上，而 completeExceptionally 却被调用在 whenComplete 返回的第二个 CompletableFuture 实例上。第一个实例从未被完成，因此其上注册的 whenComplete 回调也永远不会被触发。

正确的完成机制

为了确保 whenComplete 回调能够被触发，我们必须确保 completeExceptionally（或 complete）方法作用于注册了 whenComplete 回调的那个 CompletableFuture 实例。正确的做法是获取原始 CompletableFuture 的引用，并对其进行完成操作。

钉钉 AI 助理

钉钉AI助理汇集了钉钉AI产品能力，帮助企业迈入智能新时代。

21

查看详情

以下是修正后的代码示例：

import java.util.concurrent.*;

public class TestCompletableFuture {
    public static void main(String[] args) throws Exception {
        // 1. 获取原始 CompletableFuture 的引用
        CompletableFuture<Void> initialFuture = new CompletableFuture<>();

        // 2. 在原始 Future 上配置 whenComplete 回调，并获取返回的新 Future 实例
        CompletableFuture<Void> chainedFuture = initialFuture
                .whenComplete((res, exc) -> {
                            System.out.println("inside handle.");
                            if (exc != null) {
                                System.out.println("exception.");
                            }
                            System.out.println("completed.");
                        }
                );

        // 3. 对原始 Future 调用 completeExceptionally 来触发其完成
        initialFuture.completeExceptionally(new Exception("exception"));
        System.out.println("finished.");

        // 检查两个 Future 的完成状态
        System.out.println("initialFuture isDone: " + initialFuture.isDone());
        System.out.println("chainedFuture isDone: " + chainedFuture.isDone());

        System.out.println("initialFuture isCompletedExceptionally: " + initialFuture.isCompletedExceptionally());
        System.out.println("chainedFuture isCompletedExceptionally: " + chainedFuture.isCompletedExceptionally());
    }
}

运行修正后的代码，输出将变为：

inside handle.
exception.
completed.
finished.
initialFuture isDone: true
chainedFuture isDone: true
initialFuture isCompletedExceptionally: true
chainedFuture isCompletedExceptionally: true

现在，whenComplete 回调被正确地触发了。这是因为我们将 initialFuture 显式地完成了，而 chainedFuture 是 initialFuture 的一个下游阶段。当 initialFuture 完成时，它的完成状态（包括异常）会传递给 chainedFuture，从而触发 chainedFuture 上注册的回调。

同时，通过 isDone() 和 isCompletedExceptionally() 方法的输出，我们可以清楚地看到，当 initialFuture 异常完成时，chainedFuture 也随之异常完成。这表明 CompletableFuture 的链式结构会传播其完成状态。

注意事项与最佳实践

1. 理解返回值： 始终记住，CompletableFuture 的大多数链式方法（如 whenComplete, thenApply, thenAccept, thenCompose 等）都会返回一个新的 CompletableFuture 实例。这个新实例代表了链中下一个阶段的结果。
2. 正确引用： 在设计 CompletableFuture 链时，明确哪个 CompletableFuture 实例是“源头”或“触发点”，并确保对其调用 complete() 或 completeExceptionally()。
3. 调试技巧： 当遇到 CompletableFuture 回调不触发的问题时，检查你是否正在完成正确的 CompletableFuture 实例。使用 isDone(), isCompletedExceptionally(), isCancelled() 等方法可以帮助你理解各个 CompletableFuture 实例的当前状态。
4. 异常传播： CompletableFuture 的异常传播机制非常强大。一个阶段的异常完成通常会导致其所有下游阶段也以异常方式完成，除非下游阶段明确处理了这些异常（例如通过 exceptionally 方法）。

通过深入理解 CompletableFuture 的链式调用机制和实例引用规则，开发者可以更有效地利用其异步编程能力，构建健壮且高效的并发应用程序。

以上就是深入理解 CompletableFuture 异常完成与回调机制的详细内容，更多请关注php中文网其它相关文章！