如何为 CompletableFuture 编写带断言的 JUnit 单元测试

阿晨吖_6137

阿晨吖_6137

2026-05-25

548人浏览

原创

本文介绍如何对返回 CompletableFuture 的异步服务方法编写合规、可验证的单元测试,重点解决 SonarQube 提示“缺少断言”的问题,并推荐使用 Awaitility 简化异步断言逻辑。

本文介绍如何对返回 `completablefuture` 的异步服务方法编写合规、可验证的单元测试,重点解决 sonarqube 提示“缺少断言”的问题,并推荐使用 awaitility 简化异步断言逻辑。

在 Spring Boot 项目中,使用 @Async 返回 CompletableFuture 是常见模式,但其异步特性给单元测试带来挑战:若仅调用方法而不等待结果并校验,测试将无法覆盖业务逻辑正确性,SonarQube 等质量门禁也会报出 “Add at least one assertion” 警告。

核心原则是遵循经典测试三段式:Given(准备输入)→ When(触发异步调用)→ Then(等待完成并断言结果)。由于 CompletableFuture 不会自动阻塞主线程,直接调用 .get() 可能导致无限等待(若未完成),因此需配合超时机制安全获取结果。

推荐使用 Awaitility —— 专为异步测试设计的轻量库,支持声明式等待条件,语义清晰且线程安全。

✅ 步骤一:添加依赖(Maven)

<dependency><groupid>org.awaitility</groupid><artifactid>awaitility</artifactid><version>4.2.0</version><scope>test</scope></dependency>

✅ 步骤二:编写健壮测试(含超时保护)

@Test
@DisplayName("Async process (1)")
void insertarSolicitudTest() throws BusinessException {
    // Given: 准备请求对象与 Mock 行为
    DocumentRequest request = documentRequest();
    // 假设已配置好 @Mock 注入的 repository 行为(如 when(repo.save(...)).thenReturn(...))

    // When: 触发异步方法
    CompletableFuture<boolean> future = asynEvaluaEstadoSiniestro.getEvaluacionEstadoSiniestro(request);

    // Then: 使用 Awaitility 等待完成(最多 5 秒),再断言结果
    Awaitility.await()
        .atMost(5, TimeUnit.SECONDS)
        .until(future::isDone);

    try {
        Boolean result = future.get(); // 非阻塞前提下安全获取(因 isDone 已为 true)
        Assertions.assertTrue(result, "期望异步评估返回 true");
    } catch (ExecutionException | InterruptedException e) {
        throw new RuntimeException("异步执行异常", e);
    }
}</boolean>

? 注意事项:

  • 切勿仅调用 future.isDone() 而不 get() 或 join() —— 这不是有效断言,SonarQube 会忽略;
  • future.get() 必须配合超时(如 get(5, SECONDS))或前置 isDone 检查,否则测试可能挂起;
  • Awaitility 的 until(future::isDone) 是推荐方式,比手动 Thread.sleep() 更可靠、更易读;
  • 若需验证 false 结果,使用 Assertions.assertFalse(result) 即可,逻辑保持一致。

✅ 替代方案(无第三方依赖)

若暂不能引入 Awaitility,可改用 CompletableFuture.join() + 显式超时:

Boolean result = future.orTimeout(5, TimeUnit.SECONDS).join();
Assertions.assertTrue(result);

但需注意:orTimeout 是 Java 9+ 特性,且抛出 CompletionException,需捕获处理。

综上,为 CompletableFuture 添加断言的关键在于 显式等待完成 + 安全获取结果 + 校验布尔值。采用 Awaitility 不仅满足静态检查要求,更能提升测试可维护性与可读性,是 Spring 异步测试的最佳实践之一。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

11077

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

8202

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7092

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1184

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

968

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1436

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2929

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20191

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1275

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.9万人学习